blob: 6ff72540afe65ad295337383e1a1e42c37108862 [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"
30#include "clang/Analysis/Support/BumpVector.h"
Artem Dergachev40684812018-02-27 20:03:35 +000031#include "clang/Analysis/ConstructionContext.h"
Jordan Rose5374c072013-08-19 16:27:28 +000032#include "clang/Basic/Builtins.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000033#include "clang/Basic/ExceptionSpecificationType.h"
34#include "clang/Basic/LLVM.h"
35#include "clang/Basic/LangOptions.h"
36#include "clang/Basic/SourceLocation.h"
37#include "clang/Basic/Specifiers.h"
38#include "llvm/ADT/APInt.h"
39#include "llvm/ADT/APSInt.h"
40#include "llvm/ADT/ArrayRef.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000041#include "llvm/ADT/DenseMap.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000042#include "llvm/ADT/Optional.h"
43#include "llvm/ADT/STLExtras.h"
44#include "llvm/ADT/SetVector.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000045#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000046#include "llvm/ADT/SmallVector.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000047#include "llvm/Support/Allocator.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000048#include "llvm/Support/Casting.h"
49#include "llvm/Support/Compiler.h"
50#include "llvm/Support/DOTGraphTraits.h"
51#include "llvm/Support/ErrorHandling.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000052#include "llvm/Support/Format.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000053#include "llvm/Support/GraphWriter.h"
54#include "llvm/Support/SaveAndRestore.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000055#include "llvm/Support/raw_ostream.h"
56#include <cassert>
57#include <memory>
58#include <string>
59#include <tuple>
60#include <utility>
61#include <vector>
Ted Kremeneke5ccf9a2008-01-11 00:40:29 +000062
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +000063using namespace clang;
64
Ted Kremenek5ef32db2011-08-12 23:37:29 +000065static SourceLocation GetEndLoc(Decl *D) {
66 if (VarDecl *VD = dyn_cast<VarDecl>(D))
67 if (Expr *Ex = VD->getInit())
Ted Kremenek8889bb32008-08-06 23:20:50 +000068 return Ex->getSourceRange().getEnd();
Mike Stump31feda52009-07-17 01:31:16 +000069 return D->getLocation();
Ted Kremenek8889bb32008-08-06 23:20:50 +000070}
Ted Kremenekdc03bd02010-08-02 23:46:59 +000071
George Burgess IVced56e62015-10-01 18:47:52 +000072/// Helper for tryNormalizeBinaryOperator. Attempts to extract an IntegerLiteral
73/// or EnumConstantDecl from the given Expr. If it fails, returns nullptr.
Eugene Zelenko38c70522017-12-07 21:55:09 +000074static const Expr *tryTransformToIntOrEnumConstant(const Expr *E) {
George Burgess IVced56e62015-10-01 18:47:52 +000075 E = E->IgnoreParens();
76 if (isa<IntegerLiteral>(E))
77 return E;
78 if (auto *DR = dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
79 return isa<EnumConstantDecl>(DR->getDecl()) ? DR : nullptr;
80 return nullptr;
81}
82
83/// Tries to interpret a binary operator into `Decl Op Expr` form, if Expr is
84/// an integer literal or an enum constant.
85///
86/// If this fails, at least one of the returned DeclRefExpr or Expr will be
87/// null.
88static std::tuple<const DeclRefExpr *, BinaryOperatorKind, const Expr *>
89tryNormalizeBinaryOperator(const BinaryOperator *B) {
90 BinaryOperatorKind Op = B->getOpcode();
91
92 const Expr *MaybeDecl = B->getLHS();
93 const Expr *Constant = tryTransformToIntOrEnumConstant(B->getRHS());
94 // Expr looked like `0 == Foo` instead of `Foo == 0`
95 if (Constant == nullptr) {
96 // Flip the operator
97 if (Op == BO_GT)
98 Op = BO_LT;
99 else if (Op == BO_GE)
100 Op = BO_LE;
101 else if (Op == BO_LT)
102 Op = BO_GT;
103 else if (Op == BO_LE)
104 Op = BO_GE;
105
106 MaybeDecl = B->getRHS();
107 Constant = tryTransformToIntOrEnumConstant(B->getLHS());
108 }
109
110 auto *D = dyn_cast<DeclRefExpr>(MaybeDecl->IgnoreParenImpCasts());
111 return std::make_tuple(D, Op, Constant);
112}
113
114/// For an expression `x == Foo && x == Bar`, this determines whether the
115/// `Foo` and `Bar` are either of the same enumeration type, or both integer
116/// literals.
117///
118/// It's an error to pass this arguments that are not either IntegerLiterals
119/// or DeclRefExprs (that have decls of type EnumConstantDecl)
120static bool areExprTypesCompatible(const Expr *E1, const Expr *E2) {
121 // User intent isn't clear if they're mixing int literals with enum
122 // constants.
123 if (isa<IntegerLiteral>(E1) != isa<IntegerLiteral>(E2))
124 return false;
125
126 // Integer literal comparisons, regardless of literal type, are acceptable.
127 if (isa<IntegerLiteral>(E1))
128 return true;
129
130 // IntegerLiterals are handled above and only EnumConstantDecls are expected
131 // beyond this point
132 assert(isa<DeclRefExpr>(E1) && isa<DeclRefExpr>(E2));
133 auto *Decl1 = cast<DeclRefExpr>(E1)->getDecl();
134 auto *Decl2 = cast<DeclRefExpr>(E2)->getDecl();
135
136 assert(isa<EnumConstantDecl>(Decl1) && isa<EnumConstantDecl>(Decl2));
137 const DeclContext *DC1 = Decl1->getDeclContext();
138 const DeclContext *DC2 = Decl2->getDeclContext();
139
140 assert(isa<EnumDecl>(DC1) && isa<EnumDecl>(DC2));
141 return DC1 == DC2;
142}
143
Eugene Zelenko38c70522017-12-07 21:55:09 +0000144namespace {
145
Ted Kremenek7c58d352011-03-10 01:14:11 +0000146class CFGBuilder;
Fangrui Song6907ce22018-07-30 19:24:48 +0000147
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000148/// The CFG builder uses a recursive algorithm to build the CFG. When
149/// we process an expression, sometimes we know that we must add the
150/// subexpressions as block-level expressions. For example:
151///
152/// exp1 || exp2
153///
154/// When processing the '||' expression, we know that exp1 and exp2
155/// need to be added as block-level expressions, even though they
156/// might not normally need to be. AddStmtChoice records this
157/// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then
158/// the builder has an option not to add a subexpression as a
159/// block-level expression.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000160class AddStmtChoice {
161public:
Ted Kremenek8219b822010-12-16 07:46:53 +0000162 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 };
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000163
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000164 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000165
Ted Kremenek7c58d352011-03-10 01:14:11 +0000166 bool alwaysAdd(CFGBuilder &builder,
167 const Stmt *stmt) const;
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000168
169 /// Return a copy of this object, except with the 'always-add' bit
170 /// set as specified.
171 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const {
Ted Kremenek7c58d352011-03-10 01:14:11 +0000172 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000173 }
174
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000175private:
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000176 Kind kind;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000177};
Mike Stump31feda52009-07-17 01:31:16 +0000178
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000179/// LocalScope - Node in tree of local scopes created for C++ implicit
180/// destructor calls generation. It contains list of automatic variables
181/// declared in the scope and link to position in previous scope this scope
182/// began in.
183///
184/// The process of creating local scopes is as follows:
185/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
186/// - Before processing statements in scope (e.g. CompoundStmt) create
187/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
188/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000189/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000190/// at this VarDecl,
191/// - For every normal (without jump) end of scope add to CFGBlock destructors
192/// for objects in the current scope,
193/// - For every jump add to CFGBlock destructors for objects
194/// between CFGBuilder::ScopePos and local scope position saved for jump
195/// target. Thanks to C++ restrictions on goto jumps we can be sure that
196/// jump target position will be on the path to root from CFGBuilder::ScopePos
197/// (adding any variable that doesn't need constructor to be called to
198/// LocalScope can break this assumption),
199///
200class LocalScope {
201public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000202 friend class const_iterator;
203
204 using AutomaticVarsTy = BumpVector<VarDecl *>;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000205
206 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000207 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000208 class const_iterator {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000209 const LocalScope* Scope = nullptr;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000210
211 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
212 /// Invalid iterator (with null Scope) has VarIter equal to 0.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000213 unsigned VarIter = 0;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000214
215 public:
216 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
217 /// Incrementing invalid iterator is allowed and will result in invalid
218 /// iterator.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000219 const_iterator() = default;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000220
221 /// Create valid iterator. In case when S.Prev is an invalid iterator and
222 /// I is equal to 0, this will create invalid iterator.
223 const_iterator(const LocalScope& S, unsigned I)
224 : Scope(&S), VarIter(I) {
225 // Iterator to "end" of scope is not allowed. Handle it by going up
226 // in scopes tree possibly up to invalid iterator in the root.
227 if (VarIter == 0 && Scope)
228 *this = Scope->Prev;
229 }
230
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000231 VarDecl *const* operator->() const {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000232 assert(Scope && "Dereferencing invalid iterator is not allowed");
233 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000234 return &Scope->Vars[VarIter - 1];
235 }
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000236
237 const VarDecl *getFirstVarInScope() const {
238 assert(Scope && "Dereferencing invalid iterator is not allowed");
239 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
240 return Scope->Vars[0];
241 }
242
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000243 VarDecl *operator*() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000244 return *this->operator->();
245 }
246
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000247 const_iterator &operator++() {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000248 if (!Scope)
249 return *this;
250
Eugene Zelenko38c70522017-12-07 21:55:09 +0000251 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000252 --VarIter;
253 if (VarIter == 0)
254 *this = Scope->Prev;
255 return *this;
256 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000257 const_iterator operator++(int) {
258 const_iterator P = *this;
259 ++*this;
260 return P;
261 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000262
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000263 bool operator==(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000264 return Scope == rhs.Scope && VarIter == rhs.VarIter;
265 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000266 bool operator!=(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000267 return !(*this == rhs);
268 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000269
Aaron Ballman67347662015-02-15 22:00:28 +0000270 explicit operator bool() const {
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000271 return *this != const_iterator();
272 }
273
274 int distance(const_iterator L);
Matthias Gehre351c2182017-07-12 07:04:19 +0000275 const_iterator shared_parent(const_iterator L);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000276 bool pointsToFirstDeclaredVar() { return VarIter == 1; }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000277 };
278
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000279private:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000280 BumpVectorContext ctx;
Fangrui Song6907ce22018-07-30 19:24:48 +0000281
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000282 /// Automatic variables in order of declaration.
283 AutomaticVarsTy Vars;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000284
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000285 /// Iterator to variable in previous scope that was declared just before
286 /// begin of this scope.
287 const_iterator Prev;
288
289public:
290 /// Constructs empty scope linked to previous scope in specified place.
David Blaikiec1334cc2015-08-13 22:12:21 +0000291 LocalScope(BumpVectorContext ctx, const_iterator P)
292 : ctx(std::move(ctx)), Vars(this->ctx, 4), Prev(P) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000293
294 /// Begin of scope in direction of CFG building (backwards).
295 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000296
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000297 void addVar(VarDecl *VD) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000298 Vars.push_back(VD, ctx);
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000299 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000300};
301
Eugene Zelenko38c70522017-12-07 21:55:09 +0000302} // namespace
303
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000304/// distance - Calculates distance from this to L. L must be reachable from this
305/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
306/// number of scopes between this and L.
307int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
308 int D = 0;
309 const_iterator F = *this;
310 while (F.Scope != L.Scope) {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000311 assert(F != const_iterator() &&
312 "L iterator is not reachable from F iterator.");
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000313 D += F.VarIter;
314 F = F.Scope->Prev;
315 }
316 D += F.VarIter - L.VarIter;
317 return D;
318}
319
Matthias Gehre351c2182017-07-12 07:04:19 +0000320/// Calculates the closest parent of this iterator
321/// that is in a scope reachable through the parents of L.
322/// I.e. when using 'goto' from this to L, the lifetime of all variables
323/// between this and shared_parent(L) end.
324LocalScope::const_iterator
325LocalScope::const_iterator::shared_parent(LocalScope::const_iterator L) {
326 llvm::SmallPtrSet<const LocalScope *, 4> ScopesOfL;
327 while (true) {
328 ScopesOfL.insert(L.Scope);
329 if (L == const_iterator())
330 break;
331 L = L.Scope->Prev;
332 }
333
334 const_iterator F = *this;
335 while (true) {
336 if (ScopesOfL.count(F.Scope))
337 return F;
338 assert(F != const_iterator() &&
339 "L iterator is not reachable from F iterator.");
340 F = F.Scope->Prev;
341 }
342}
343
Eugene Zelenko38c70522017-12-07 21:55:09 +0000344namespace {
345
Jonathan Roelofs99bdd982015-05-19 18:51:56 +0000346/// Structure for specifying position in CFG during its build process. It
347/// consists of CFGBlock that specifies position in CFG and
348/// LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000349struct BlockScopePosPair {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000350 CFGBlock *block = nullptr;
351 LocalScope::const_iterator scopePosition;
352
353 BlockScopePosPair() = default;
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000354 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos)
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000355 : block(b), scopePosition(scopePos) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000356};
357
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000358/// TryResult - a class representing a variant over the values
359/// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool,
360/// and is used by the CFGBuilder to decide if a branch condition
361/// can be decided up front during CFG construction.
362class TryResult {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000363 int X = -1;
364
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000365public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000366 TryResult() = default;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000367 TryResult(bool b) : X(b ? 1 : 0) {}
Fangrui Song6907ce22018-07-30 19:24:48 +0000368
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000369 bool isTrue() const { return X == 1; }
370 bool isFalse() const { return X == 0; }
371 bool isKnown() const { return X >= 0; }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000372
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000373 void negate() {
374 assert(isKnown());
375 X ^= 0x1;
376 }
377};
378
Eugene Zelenko38c70522017-12-07 21:55:09 +0000379} // namespace
380
381static TryResult bothKnownTrue(TryResult R1, TryResult R2) {
Manuel Klimekdeb02622014-08-08 07:37:13 +0000382 if (!R1.isKnown() || !R2.isKnown())
383 return TryResult();
384 return TryResult(R1.isTrue() && R2.isTrue());
385}
386
Eugene Zelenko38c70522017-12-07 21:55:09 +0000387namespace {
388
Ted Kremenek8ae67872013-02-05 22:00:19 +0000389class reverse_children {
390 llvm::SmallVector<Stmt *, 12> childrenBuf;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000391 ArrayRef<Stmt *> children;
392
Ted Kremenek8ae67872013-02-05 22:00:19 +0000393public:
394 reverse_children(Stmt *S);
395
Eugene Zelenko38c70522017-12-07 21:55:09 +0000396 using iterator = ArrayRef<Stmt *>::reverse_iterator;
397
Ted Kremenek8ae67872013-02-05 22:00:19 +0000398 iterator begin() const { return children.rbegin(); }
399 iterator end() const { return children.rend(); }
400};
401
Eugene Zelenko38c70522017-12-07 21:55:09 +0000402} // namespace
Ted Kremenek8ae67872013-02-05 22:00:19 +0000403
404reverse_children::reverse_children(Stmt *S) {
405 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
406 children = CE->getRawSubExprs();
407 return;
408 }
409 switch (S->getStmtClass()) {
Ted Kremenek7d86b9c2013-02-05 22:03:14 +0000410 // Note: Fill in this switch with more cases we want to optimize.
Ted Kremenek8ae67872013-02-05 22:00:19 +0000411 case Stmt::InitListExprClass: {
412 InitListExpr *IE = cast<InitListExpr>(S);
413 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()),
414 IE->getNumInits());
415 return;
416 }
417 default:
418 break;
419 }
420
421 // Default case for all other statements.
Benjamin Kramer642f1732015-07-02 21:03:14 +0000422 for (Stmt *SubStmt : S->children())
423 childrenBuf.push_back(SubStmt);
Ted Kremenek8ae67872013-02-05 22:00:19 +0000424
425 // This needs to be done *after* childrenBuf has been populated.
426 children = childrenBuf;
427}
428
Eugene Zelenko38c70522017-12-07 21:55:09 +0000429namespace {
430
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000431/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000432/// The builder is stateful: an instance of the builder should be used to only
433/// construct a single CFG.
434///
435/// Example usage:
436///
437/// CFGBuilder builder;
Jonathan Roelofsab046c52015-07-27 16:05:36 +0000438/// std::unique_ptr<CFG> cfg = builder.buildCFG(decl, stmt1);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000439///
Mike Stump31feda52009-07-17 01:31:16 +0000440/// CFG construction is done via a recursive walk of an AST. We actually parse
441/// the AST in reverse order so that the successor of a basic block is
442/// constructed prior to its predecessor. This allows us to nicely capture
443/// implicit fall-throughs without extra basic blocks.
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000444class CFGBuilder {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000445 using JumpTarget = BlockScopePosPair;
446 using JumpSource = BlockScopePosPair;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000447
Mike Stump0d76d072009-07-20 23:24:15 +0000448 ASTContext *Context;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000449 std::unique_ptr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000450
Eugene Zelenko38c70522017-12-07 21:55:09 +0000451 // Current block.
452 CFGBlock *Block = nullptr;
453
454 // Block after the current block.
455 CFGBlock *Succ = nullptr;
456
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000457 JumpTarget ContinueJumpTarget;
458 JumpTarget BreakJumpTarget;
Nico Weber699670e2017-08-23 15:33:16 +0000459 JumpTarget SEHLeaveJumpTarget;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000460 CFGBlock *SwitchTerminatedBlock = nullptr;
461 CFGBlock *DefaultCaseBlock = nullptr;
Nico Weber699670e2017-08-23 15:33:16 +0000462
463 // This can point either to a try or a __try block. The frontend forbids
464 // mixing both kinds in one function, so having one for both is enough.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000465 CFGBlock *TryTerminatedBlock = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000466
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000467 // Current position in local scope.
468 LocalScope::const_iterator ScopePos;
469
470 // LabelMap records the mapping from Label expressions to their jump targets.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000471 using LabelMapTy = llvm::DenseMap<LabelDecl *, JumpTarget>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000472 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000473
474 // A list of blocks that end with a "goto" that must be backpatched to their
475 // resolved targets upon completion of CFG construction.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000476 using BackpatchBlocksTy = std::vector<JumpSource>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000477 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000478
Ted Kremenekeda180e22007-08-28 19:26:49 +0000479 // A list of labels whose address has been taken (for indirect gotos).
Eugene Zelenko38c70522017-12-07 21:55:09 +0000480 using LabelSetTy = llvm::SmallSetVector<LabelDecl *, 8>;
Ted Kremenekeda180e22007-08-28 19:26:49 +0000481 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000482
Artem Dergachev41ffb302018-02-08 22:58:15 +0000483 // Information about the currently visited C++ object construction site.
484 // This is set in the construction trigger and read when the constructor
Artem Dergachev1527dec2018-03-12 23:12:40 +0000485 // or a function that returns an object by value is being visited.
486 llvm::DenseMap<Expr *, const ConstructionContextLayer *>
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000487 ConstructionContextMap;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000488
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000489 using DeclsWithEndedScopeSetTy = llvm::SmallSetVector<VarDecl *, 16>;
490 DeclsWithEndedScopeSetTy DeclsWithEndedScope;
491
Eugene Zelenko38c70522017-12-07 21:55:09 +0000492 bool badCFG = false;
Ted Kremenekf9d82902011-03-10 01:14:05 +0000493 const CFG::BuildOptions &BuildOpts;
Fangrui Song6907ce22018-07-30 19:24:48 +0000494
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000495 // State to track for building switch statements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000496 bool switchExclusivelyCovered = false;
497 Expr::EvalResult *switchCond = nullptr;
Fangrui Song6907ce22018-07-30 19:24:48 +0000498
Eugene Zelenko38c70522017-12-07 21:55:09 +0000499 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry = nullptr;
500 const Stmt *lastLookup = nullptr;
Zhongxing Xud38fb842010-09-16 03:28:18 +0000501
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000502 // Caches boolean evaluations of expressions to avoid multiple re-evaluations
503 // during construction of branches for chained logical operators.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000504 using CachedBoolEvalsTy = llvm::DenseMap<Expr *, TryResult>;
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000505 CachedBoolEvalsTy CachedBoolEvals;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000506
Mike Stump31feda52009-07-17 01:31:16 +0000507public:
Ted Kremenekf9d82902011-03-10 01:14:05 +0000508 explicit CFGBuilder(ASTContext *astContext,
Nico Weber699670e2017-08-23 15:33:16 +0000509 const CFG::BuildOptions &buildOpts)
510 : Context(astContext), cfg(new CFG()), // crew a new CFG
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000511 ConstructionContextMap(), BuildOpts(buildOpts) {}
512
Mike Stump31feda52009-07-17 01:31:16 +0000513
Ted Kremenek9aae5132007-08-23 21:42:29 +0000514 // buildCFG - Used by external clients to construct the CFG.
David Blaikiee90195c2014-08-29 18:53:26 +0000515 std::unique_ptr<CFG> buildCFG(const Decl *D, Stmt *Statement);
Mike Stump31feda52009-07-17 01:31:16 +0000516
Ted Kremeneka099c592011-03-10 03:50:34 +0000517 bool alwaysAdd(const Stmt *stmt);
Fangrui Song6907ce22018-07-30 19:24:48 +0000518
Ted Kremenek93668002009-07-17 22:18:43 +0000519private:
520 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000521 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
522 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000523 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000524 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000525 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000526 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000527 CFGBlock *VisitCompoundStmt(CompoundStmt *C);
John McCallc07a0c72011-02-17 10:25:35 +0000528 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C,
529 AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000530 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek6f400242012-07-14 05:04:01 +0000531 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
532 AddStmtChoice asc);
533 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
534 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc);
Jordan Rosec9176072014-01-13 17:59:19 +0000535 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc);
Jordan Rosed2f40792013-09-03 17:00:57 +0000536 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000537 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S);
538 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
539 AddStmtChoice asc);
540 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
541 AddStmtChoice asc);
542 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
543 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000544 CFGBlock *VisitDeclStmt(DeclStmt *DS);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000545 CFGBlock *VisitDeclSubExpr(DeclStmt *DS);
Ted Kremenek21822592009-07-17 18:20:32 +0000546 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
547 CFGBlock *VisitDoStmt(DoStmt *D);
Ted Kremenek6f400242012-07-14 05:04:01 +0000548 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000549 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000550 CFGBlock *VisitGotoStmt(GotoStmt *G);
Ted Kremenek93668002009-07-17 22:18:43 +0000551 CFGBlock *VisitIfStmt(IfStmt *I);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +0000552 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *E, AddStmtChoice asc);
Bill Wendling8003edc2018-11-09 00:41:36 +0000553 CFGBlock *VisitConstantExpr(ConstantExpr *E, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000554 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I);
555 CFGBlock *VisitLabelStmt(LabelStmt *L);
Devin Coughlinb6029b72015-11-25 22:35:37 +0000556 CFGBlock *VisitBlockExpr(BlockExpr *E, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000557 CFGBlock *VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc);
Ted Kremeneka16436f2012-07-14 05:04:06 +0000558 CFGBlock *VisitLogicalOperator(BinaryOperator *B);
Ted Kremenekb50e7162012-07-14 05:04:10 +0000559 std::pair<CFGBlock *, CFGBlock *> VisitLogicalOperator(BinaryOperator *B,
560 Stmt *Term,
561 CFGBlock *TrueBlock,
562 CFGBlock *FalseBlock);
Artem Dergachevf43ac4c2018-02-24 02:00:30 +0000563 CFGBlock *VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
564 AddStmtChoice asc);
Ted Kremenek5868ec62010-04-11 17:02:10 +0000565 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000566 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S);
567 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S);
568 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S);
569 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000570 CFGBlock *VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000571 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S);
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000572 CFGBlock *VisitObjCMessageExpr(ObjCMessageExpr *E, AddStmtChoice asc);
John McCallfe96e0b2011-11-06 09:01:30 +0000573 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E);
Brian Gesiaka87ecf62018-11-03 22:35:17 +0000574 CFGBlock *VisitReturnStmt(Stmt *S);
Nico Weber699670e2017-08-23 15:33:16 +0000575 CFGBlock *VisitSEHExceptStmt(SEHExceptStmt *S);
576 CFGBlock *VisitSEHFinallyStmt(SEHFinallyStmt *S);
577 CFGBlock *VisitSEHLeaveStmt(SEHLeaveStmt *S);
578 CFGBlock *VisitSEHTryStmt(SEHTryStmt *S);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000579 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000580 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000581 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
582 AddStmtChoice asc);
Zhanyong Wan6dace612010-11-22 08:45:56 +0000583 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000584 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000585
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000586 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd);
587 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000588 CFGBlock *VisitChildren(Stmt *S);
Ted Kremeneke2499842012-04-12 20:03:44 +0000589 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc);
Mike Stump48871a22009-07-17 01:04:31 +0000590
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000591 void maybeAddScopeBeginForVarDecl(CFGBlock *B, const VarDecl *VD,
592 const Stmt *S) {
593 if (ScopePos && (VD == ScopePos.getFirstVarInScope()))
594 appendScopeBegin(B, VD, S);
595 }
596
Manuel Klimekb5616c92014-08-07 10:42:17 +0000597 /// When creating the CFG for temporary destructors, we want to mirror the
598 /// branch structure of the corresponding constructor calls.
599 /// Thus, while visiting a statement for temporary destructors, we keep a
600 /// context to keep track of the following information:
601 /// - whether a subexpression is executed unconditionally
602 /// - if a subexpression is executed conditionally, the first
603 /// CXXBindTemporaryExpr we encounter in that subexpression (which
604 /// corresponds to the last temporary destructor we have to call for this
605 /// subexpression) and the CFG block at that point (which will become the
606 /// successor block when inserting the decision point).
607 ///
608 /// That way, we can build the branch structure for temporary destructors as
609 /// follows:
610 /// 1. If a subexpression is executed unconditionally, we add the temporary
611 /// destructor calls to the current block.
612 /// 2. If a subexpression is executed conditionally, when we encounter a
613 /// CXXBindTemporaryExpr:
614 /// a) If it is the first temporary destructor call in the subexpression,
615 /// we remember the CXXBindTemporaryExpr and the current block in the
616 /// TempDtorContext; we start a new block, and insert the temporary
617 /// destructor call.
618 /// b) Otherwise, add the temporary destructor call to the current block.
619 /// 3. When we finished visiting a conditionally executed subexpression,
620 /// and we found at least one temporary constructor during the visitation
621 /// (2.a has executed), we insert a decision block that uses the
622 /// CXXBindTemporaryExpr as terminator, and branches to the current block
623 /// if the CXXBindTemporaryExpr was marked executed, and otherwise
624 /// branches to the stored successor.
625 struct TempDtorContext {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000626 TempDtorContext() = default;
Manuel Klimekdeb02622014-08-08 07:37:13 +0000627 TempDtorContext(TryResult KnownExecuted)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000628 : IsConditional(true), KnownExecuted(KnownExecuted) {}
Manuel Klimekb5616c92014-08-07 10:42:17 +0000629
630 /// Returns whether we need to start a new branch for a temporary destructor
Eric Christopher2c4555a2015-06-19 01:52:53 +0000631 /// call. This is the case when the temporary destructor is
Manuel Klimekb5616c92014-08-07 10:42:17 +0000632 /// conditionally executed, and it is the first one we encounter while
633 /// visiting a subexpression - other temporary destructors at the same level
634 /// will be added to the same block and are executed under the same
635 /// condition.
636 bool needsTempDtorBranch() const {
637 return IsConditional && !TerminatorExpr;
638 }
639
640 /// Remember the successor S of a temporary destructor decision branch for
641 /// the corresponding CXXBindTemporaryExpr E.
642 void setDecisionPoint(CFGBlock *S, CXXBindTemporaryExpr *E) {
643 Succ = S;
644 TerminatorExpr = E;
645 }
646
Eugene Zelenko38c70522017-12-07 21:55:09 +0000647 const bool IsConditional = false;
648 const TryResult KnownExecuted = true;
649 CFGBlock *Succ = nullptr;
650 CXXBindTemporaryExpr *TerminatorExpr = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000651 };
652
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000653 // Visitors to walk an AST and generate destructors of temporaries in
654 // full expression.
Manuel Klimekb5616c92014-08-07 10:42:17 +0000655 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
656 TempDtorContext &Context);
657 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E, TempDtorContext &Context);
658 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E,
659 TempDtorContext &Context);
660 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(
661 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context);
662 CFGBlock *VisitConditionalOperatorForTemporaryDtors(
663 AbstractConditionalOperator *E, bool BindToTemporary,
664 TempDtorContext &Context);
665 void InsertTempDtorDecisionBlock(const TempDtorContext &Context,
666 CFGBlock *FalseSucc = nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000667
Ted Kremenek6065ef62008-04-28 18:00:46 +0000668 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000669 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000670 badCFG = true;
671 return Block;
672 }
Mike Stump31feda52009-07-17 01:31:16 +0000673
Artem Dergachev40684812018-02-27 20:03:35 +0000674 // Remember to apply the construction context based on the current \p Layer
675 // when constructing the CFG element for \p CE.
676 void consumeConstructionContext(const ConstructionContextLayer *Layer,
Artem Dergachev1527dec2018-03-12 23:12:40 +0000677 Expr *E);
Artem Dergachevc1b07bd2018-02-23 23:38:41 +0000678
Artem Dergachev40684812018-02-27 20:03:35 +0000679 // Scan \p Child statement to find constructors in it, while keeping in mind
680 // that its parent statement is providing a partial construction context
681 // described by \p Layer. If a constructor is found, it would be assigned
682 // the context based on the layer. If an additional construction context layer
683 // is found, the function recurses into that.
684 void findConstructionContexts(const ConstructionContextLayer *Layer,
Artem Dergachev783a4572018-02-23 22:20:39 +0000685 Stmt *Child);
Artem Dergachev40684812018-02-27 20:03:35 +0000686
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000687 // Scan all arguments of a call expression for a construction context.
688 // These sorts of call expressions don't have a common superclass,
689 // hence strict duck-typing.
690 template <typename CallLikeExpr,
691 typename = typename std::enable_if<
692 std::is_same<CallLikeExpr, CallExpr>::value ||
693 std::is_same<CallLikeExpr, CXXConstructExpr>::value ||
694 std::is_same<CallLikeExpr, ObjCMessageExpr>::value>>
695 void findConstructionContextsForArguments(CallLikeExpr *E) {
Artem Dergacheva657a322018-07-31 20:45:53 +0000696 for (unsigned i = 0, e = E->getNumArgs(); i != e; ++i) {
697 Expr *Arg = E->getArg(i);
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000698 if (Arg->getType()->getAsCXXRecordDecl() && !Arg->isGLValue())
699 findConstructionContexts(
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +0000700 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
701 ConstructionContextItem(E, i)),
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000702 Arg);
Artem Dergacheva657a322018-07-31 20:45:53 +0000703 }
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000704 }
705
Artem Dergachev41ffb302018-02-08 22:58:15 +0000706 // Unset the construction context after consuming it. This is done immediately
Artem Dergachev1527dec2018-03-12 23:12:40 +0000707 // after adding the CFGConstructor or CFGCXXRecordTypedCall element, so
708 // there's no need to do this manually in every Visit... function.
709 void cleanupConstructionContext(Expr *E);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000710
Ted Kremenek93668002009-07-17 22:18:43 +0000711 void autoCreateBlock() { if (!Block) Block = createBlock(); }
712 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000713 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000714
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000715 CFGBlock *addStmt(Stmt *S) {
716 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000717 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000718
Alexis Hunt1d792652011-01-08 20:30:50 +0000719 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000720 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000721 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000722 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000723 void addLifetimeEnds(LocalScope::const_iterator B,
724 LocalScope::const_iterator E, Stmt *S);
725 void addAutomaticObjHandling(LocalScope::const_iterator B,
726 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000727 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000728 void addScopesEnd(LocalScope::const_iterator B, LocalScope::const_iterator E,
729 Stmt *S);
730
731 void getDeclsWithEndedScope(LocalScope::const_iterator B,
732 LocalScope::const_iterator E, Stmt *S);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000733
Marcin Swiderski5e415732010-09-30 23:05:00 +0000734 // Local scopes creation.
735 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
736
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000737 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000738 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
739 LocalScope* Scope = nullptr);
740 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000741
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000742 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000743
Artem Dergacheve1f30622018-07-31 19:46:14 +0000744 const ConstructionContext *retrieveAndCleanupConstructionContext(Expr *E) {
745 if (!BuildOpts.AddRichCXXConstructors)
746 return nullptr;
747
748 const ConstructionContextLayer *Layer = ConstructionContextMap.lookup(E);
749 if (!Layer)
750 return nullptr;
751
752 cleanupConstructionContext(E);
753 return ConstructionContext::createFromLayers(cfg->getBumpVectorContext(),
754 Layer);
755 }
756
Marcin Swiderski5e415732010-09-30 23:05:00 +0000757 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000758
Ted Kremenek37881932011-04-04 23:29:12 +0000759 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000760 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000761 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000762
Jordy Rose17347372011-06-10 08:49:37 +0000763 // All block-level expressions should have already been IgnoreParens()ed.
764 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000765 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000766 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000767
Artem Dergachev41ffb302018-02-08 22:58:15 +0000768 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
Artem Dergacheve1f30622018-07-31 19:46:14 +0000769 if (const ConstructionContext *CC =
770 retrieveAndCleanupConstructionContext(CE)) {
771 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
772 return;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000773 }
774
775 // No valid construction context found. Fall back to statement.
776 B->appendStmt(CE, cfg->getBumpVectorContext());
777 }
778
Artem Dergachev1527dec2018-03-12 23:12:40 +0000779 void appendCall(CFGBlock *B, CallExpr *CE) {
Richard Trieuf4a0e9a2018-03-15 00:09:26 +0000780 if (alwaysAdd(CE) && cachedEntry)
781 cachedEntry->second = B;
782
Artem Dergacheve1f30622018-07-31 19:46:14 +0000783 if (const ConstructionContext *CC =
784 retrieveAndCleanupConstructionContext(CE)) {
785 B->appendCXXRecordTypedCall(CE, CC, cfg->getBumpVectorContext());
786 return;
Artem Dergachev1527dec2018-03-12 23:12:40 +0000787 }
788
789 // No valid construction context found. Fall back to statement.
790 B->appendStmt(CE, cfg->getBumpVectorContext());
791 }
792
Alexis Hunt1d792652011-01-08 20:30:50 +0000793 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000794 B->appendInitializer(I, cfg->getBumpVectorContext());
795 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000796
Jordan Rosec9176072014-01-13 17:59:19 +0000797 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
798 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
799 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000800
Marcin Swiderski20b88732010-10-05 05:37:00 +0000801 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
802 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
803 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000804
Marcin Swiderski20b88732010-10-05 05:37:00 +0000805 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
806 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
807 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000808
Artem Dergacheve1f30622018-07-31 19:46:14 +0000809 void appendObjCMessage(CFGBlock *B, ObjCMessageExpr *ME) {
810 if (alwaysAdd(ME) && cachedEntry)
811 cachedEntry->second = B;
812
813 if (const ConstructionContext *CC =
814 retrieveAndCleanupConstructionContext(ME)) {
815 B->appendCXXRecordTypedCall(ME, CC, cfg->getBumpVectorContext());
816 return;
817 }
818
819 B->appendStmt(const_cast<ObjCMessageExpr *>(ME),
820 cfg->getBumpVectorContext());
821 }
822
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000823 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
824 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
825 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000826
Chandler Carruthad747252011-09-13 06:09:01 +0000827 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
828 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
829 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000830
Matthias Gehre351c2182017-07-12 07:04:19 +0000831 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
832 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
833 }
834
Peter Szecsi999a25f2017-08-19 11:19:16 +0000835 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
836 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
837 }
838
Jordan Rosed2f40792013-09-03 17:00:57 +0000839 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
840 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
841 }
842
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000843 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000844 LocalScope::const_iterator B, LocalScope::const_iterator E);
845
Matthias Gehre351c2182017-07-12 07:04:19 +0000846 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
847 LocalScope::const_iterator B,
848 LocalScope::const_iterator E);
849
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000850 const VarDecl *
851 prependAutomaticObjScopeEndWithTerminator(CFGBlock *Blk,
852 LocalScope::const_iterator B,
853 LocalScope::const_iterator E);
854
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000855 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
856 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
857 cfg->getBumpVectorContext());
858 }
859
860 /// Add a reachable successor to a block, with the alternate variant that is
861 /// unreachable.
862 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
863 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
864 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000865 }
Mike Stump11289f42009-09-09 15:08:12 +0000866
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000867 void appendScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
868 if (BuildOpts.AddScopes)
869 B->appendScopeBegin(VD, S, cfg->getBumpVectorContext());
870 }
871
872 void prependScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
873 if (BuildOpts.AddScopes)
874 B->prependScopeBegin(VD, S, cfg->getBumpVectorContext());
875 }
876
877 void appendScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
878 if (BuildOpts.AddScopes)
879 B->appendScopeEnd(VD, S, cfg->getBumpVectorContext());
880 }
881
882 void prependScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
883 if (BuildOpts.AddScopes)
884 B->prependScopeEnd(VD, S, cfg->getBumpVectorContext());
885 }
886
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000887 /// Find a relational comparison with an expression evaluating to a
Richard Trieuf935b562014-04-05 05:17:01 +0000888 /// boolean and a constant other than 0 and 1.
889 /// e.g. if ((x < y) == 10)
890 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
891 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
892 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
893
894 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
895 const Expr *BoolExpr = RHSExpr;
896 bool IntFirst = true;
897 if (!IntLiteral) {
898 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
899 BoolExpr = LHSExpr;
900 IntFirst = false;
901 }
902
903 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
904 return TryResult();
905
906 llvm::APInt IntValue = IntLiteral->getValue();
907 if ((IntValue == 1) || (IntValue == 0))
908 return TryResult();
909
910 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
911 !IntValue.isNegative();
912
913 BinaryOperatorKind Bok = B->getOpcode();
914 if (Bok == BO_GT || Bok == BO_GE) {
915 // Always true for 10 > bool and bool > -1
916 // Always false for -1 > bool and bool > 10
917 return TryResult(IntFirst == IntLarger);
918 } else {
919 // Always true for -1 < bool and bool < 10
920 // Always false for 10 < bool and bool < -1
921 return TryResult(IntFirst != IntLarger);
922 }
923 }
924
Jordan Rose7afd71e2014-05-20 17:31:11 +0000925 /// Find an incorrect equality comparison. Either with an expression
926 /// evaluating to a boolean and a constant other than 0 and 1.
927 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
928 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000929 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
930 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
931 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
932
933 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
934 const Expr *BoolExpr = RHSExpr;
935
936 if (!IntLiteral) {
937 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
938 BoolExpr = LHSExpr;
939 }
940
Jordan Rose7afd71e2014-05-20 17:31:11 +0000941 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000942 return TryResult();
943
Jordan Rose7afd71e2014-05-20 17:31:11 +0000944 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
945 if (BitOp && (BitOp->getOpcode() == BO_And ||
946 BitOp->getOpcode() == BO_Or)) {
947 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
948 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
949
950 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
951
952 if (!IntLiteral2)
953 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
954
955 if (!IntLiteral2)
956 return TryResult();
957
958 llvm::APInt L1 = IntLiteral->getValue();
959 llvm::APInt L2 = IntLiteral2->getValue();
960 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
961 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
962 if (BuildOpts.Observer)
963 BuildOpts.Observer->compareBitwiseEquality(B,
964 B->getOpcode() != BO_EQ);
965 TryResult(B->getOpcode() != BO_EQ);
966 }
967 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
968 llvm::APInt IntValue = IntLiteral->getValue();
969 if ((IntValue == 1) || (IntValue == 0)) {
970 return TryResult();
971 }
972 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000973 }
974
Jordan Rose7afd71e2014-05-20 17:31:11 +0000975 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000976 }
977
978 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
979 const llvm::APSInt &Value1,
980 const llvm::APSInt &Value2) {
981 assert(Value1.isSigned() == Value2.isSigned());
982 switch (Relation) {
983 default:
984 return TryResult();
985 case BO_EQ:
986 return TryResult(Value1 == Value2);
987 case BO_NE:
988 return TryResult(Value1 != Value2);
989 case BO_LT:
990 return TryResult(Value1 < Value2);
991 case BO_LE:
992 return TryResult(Value1 <= Value2);
993 case BO_GT:
994 return TryResult(Value1 > Value2);
995 case BO_GE:
996 return TryResult(Value1 >= Value2);
997 }
998 }
999
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001000 /// Find a pair of comparison expressions with or without parentheses
Richard Trieuf935b562014-04-05 05:17:01 +00001001 /// with a shared variable and constants and a logical operator between them
1002 /// that always evaluates to either true or false.
1003 /// e.g. if (x != 3 || x != 4)
1004 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
1005 assert(B->isLogicalOp());
1006 const BinaryOperator *LHS =
1007 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
1008 const BinaryOperator *RHS =
1009 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
1010 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001011 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001012
1013 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001014 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001015
George Burgess IVced56e62015-10-01 18:47:52 +00001016 const DeclRefExpr *Decl1;
1017 const Expr *Expr1;
1018 BinaryOperatorKind BO1;
1019 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001020
George Burgess IVced56e62015-10-01 18:47:52 +00001021 if (!Decl1 || !Expr1)
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 *Decl2;
1025 const Expr *Expr2;
1026 BinaryOperatorKind BO2;
1027 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001028
George Burgess IVced56e62015-10-01 18:47:52 +00001029 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001030 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001031
1032 // Check that it is the same variable on both sides.
1033 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001034 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001035
George Burgess IVced56e62015-10-01 18:47:52 +00001036 // Make sure the user's intent is clear (e.g. they're comparing against two
1037 // int literals, or two things from the same enum)
1038 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001039 return {};
George Burgess IVced56e62015-10-01 18:47:52 +00001040
Fangrui Song407659a2018-11-30 23:41:18 +00001041 Expr::EvalResult L1Result, L2Result;
1042 if (!Expr1->EvaluateAsInt(L1Result, *Context) ||
1043 !Expr2->EvaluateAsInt(L2Result, *Context))
Fangrui Songf5d33352018-11-30 21:26:09 +00001044 return {};
Hans Wennborg48ee4ad2018-11-28 14:04:12 +00001045
Fangrui Song407659a2018-11-30 23:41:18 +00001046 llvm::APSInt L1 = L1Result.Val.getInt();
1047 llvm::APSInt L2 = L2Result.Val.getInt();
1048
Richard Trieuf935b562014-04-05 05:17:01 +00001049 // Can't compare signed with unsigned or with different bit width.
1050 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001051 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001052
1053 // Values that will be used to determine if result of logical
1054 // operator is always true/false
1055 const llvm::APSInt Values[] = {
1056 // Value less than both Value1 and Value2
1057 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
1058 // L1
1059 L1,
1060 // Value between Value1 and Value2
1061 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
1062 L1.isUnsigned()),
1063 // L2
1064 L2,
1065 // Value greater than both Value1 and Value2
1066 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
1067 };
1068
1069 // Check whether expression is always true/false by evaluating the following
1070 // * variable x is less than the smallest literal.
1071 // * variable x is equal to the smallest literal.
1072 // * Variable x is between smallest and largest literal.
1073 // * Variable x is equal to the largest literal.
1074 // * Variable x is greater than largest literal.
1075 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001076 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +00001077 TryResult Res1, Res2;
1078 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
1079 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
1080
1081 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001082 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001083
1084 if (B->getOpcode() == BO_LAnd) {
1085 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
1086 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
1087 } else {
1088 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
1089 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
1090 }
1091 }
1092
1093 if (AlwaysTrue || AlwaysFalse) {
1094 if (BuildOpts.Observer)
1095 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
1096 return TryResult(AlwaysTrue);
1097 }
Eugene Zelenko38c70522017-12-07 21:55:09 +00001098 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001099 }
1100
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001101 /// Try and evaluate an expression to an integer constant.
1102 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
1103 if (!BuildOpts.PruneTriviallyFalseEdges)
1104 return false;
Fangrui Song6907ce22018-07-30 19:24:48 +00001105 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001106 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001107 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001108 }
Mike Stump11289f42009-09-09 15:08:12 +00001109
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001110 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001111 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001112 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001113 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001114 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001115 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001116
1117 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1118 if (Bop->isLogicalOp()) {
1119 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001120 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1121 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001122 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001123
1124 // Retrieve result at first, or the map might be updated.
1125 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1126 CachedBoolEvals[S] = Result; // update or insert
1127 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001128 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001129 else {
1130 switch (Bop->getOpcode()) {
1131 default: break;
1132 // For 'x & 0' and 'x * 0', we can determine that
1133 // the value is always false.
1134 case BO_Mul:
1135 case BO_And: {
1136 // If either operand is zero, we know the value
1137 // must be false.
Fangrui Song407659a2018-11-30 23:41:18 +00001138 Expr::EvalResult LHSResult;
1139 if (Bop->getLHS()->EvaluateAsInt(LHSResult, *Context)) {
1140 llvm::APSInt IntVal = LHSResult.Val.getInt();
David Blaikie7a3cbb22015-03-09 02:02:07 +00001141 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001142 return TryResult(false);
1143 }
1144 }
Fangrui Song407659a2018-11-30 23:41:18 +00001145 Expr::EvalResult RHSResult;
1146 if (Bop->getRHS()->EvaluateAsInt(RHSResult, *Context)) {
1147 llvm::APSInt IntVal = RHSResult.Val.getInt();
David Blaikie7a3cbb22015-03-09 02:02:07 +00001148 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001149 return TryResult(false);
1150 }
1151 }
1152 }
1153 break;
1154 }
1155 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001156 }
1157
1158 return evaluateAsBooleanConditionNoCache(S);
1159 }
1160
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001161 /// Evaluate as boolean \param E without using the cache.
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001162 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1163 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1164 if (Bop->isLogicalOp()) {
1165 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1166 if (LHS.isKnown()) {
1167 // We were able to evaluate the LHS, see if we can get away with not
1168 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1169 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1170 return LHS.isTrue();
1171
1172 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1173 if (RHS.isKnown()) {
1174 if (Bop->getOpcode() == BO_LOr)
1175 return LHS.isTrue() || RHS.isTrue();
1176 else
1177 return LHS.isTrue() && RHS.isTrue();
1178 }
1179 } else {
1180 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1181 if (RHS.isKnown()) {
1182 // We can't evaluate the LHS; however, sometimes the result
1183 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1184 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1185 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001186 } else {
1187 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1188 if (BopRes.isKnown())
1189 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001190 }
1191 }
1192
Eugene Zelenko38c70522017-12-07 21:55:09 +00001193 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001194 } else if (Bop->isEqualityOp()) {
1195 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1196 if (BopRes.isKnown())
1197 return BopRes.isTrue();
1198 } else if (Bop->isRelationalOp()) {
1199 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1200 if (BopRes.isKnown())
1201 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001202 }
1203 }
1204
1205 bool Result;
1206 if (E->EvaluateAsBooleanCondition(Result, *Context))
1207 return Result;
1208
Eugene Zelenko38c70522017-12-07 21:55:09 +00001209 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001210 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001211
1212 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001213};
Mike Stump31feda52009-07-17 01:31:16 +00001214
Eugene Zelenko38c70522017-12-07 21:55:09 +00001215} // namespace
1216
Ted Kremeneka099c592011-03-10 03:50:34 +00001217inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1218 const Stmt *stmt) const {
1219 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1220}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001221
Ted Kremeneka099c592011-03-10 03:50:34 +00001222bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001223 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
Fangrui Song6907ce22018-07-30 19:24:48 +00001224
Ted Kremeneka099c592011-03-10 03:50:34 +00001225 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001226 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001227
Fangrui Song6907ce22018-07-30 19:24:48 +00001228 if (lastLookup == stmt) {
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001229 if (cachedEntry) {
1230 assert(cachedEntry->first == stmt);
1231 return true;
1232 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001233 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001234 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001235
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001236 lastLookup = stmt;
1237
1238 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001239 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1240
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001241 if (!fb) {
1242 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001243 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001244 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001245 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001246
1247 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001248 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001249 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001250 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001251 }
1252
Ted Kremeneka099c592011-03-10 03:50:34 +00001253 cachedEntry = &*itr;
1254 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001255}
Fangrui Song6907ce22018-07-30 19:24:48 +00001256
Douglas Gregor4619e432008-12-05 23:32:09 +00001257// FIXME: Add support for dependent-sized array types in C++?
1258// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001259static const VariableArrayType *FindVA(const Type *t) {
1260 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1261 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001262 if (vat->getSizeExpr())
1263 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001264
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001265 t = vt->getElementType().getTypePtr();
1266 }
Mike Stump31feda52009-07-17 01:31:16 +00001267
Craig Topper25542942014-05-20 04:30:07 +00001268 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001269}
Mike Stump31feda52009-07-17 01:31:16 +00001270
Artem Dergachev40684812018-02-27 20:03:35 +00001271void CFGBuilder::consumeConstructionContext(
Artem Dergachev1527dec2018-03-12 23:12:40 +00001272 const ConstructionContextLayer *Layer, Expr *E) {
Artem Dergacheve1f30622018-07-31 19:46:14 +00001273 assert((isa<CXXConstructExpr>(E) || isa<CallExpr>(E) ||
1274 isa<ObjCMessageExpr>(E)) && "Expression cannot construct an object!");
Artem Dergachev40684812018-02-27 20:03:35 +00001275 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachev1527dec2018-03-12 23:12:40 +00001276 ConstructionContextMap.lookup(E)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001277 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001278 // We might have visited this child when we were finding construction
1279 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001280 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001281 "Already within a different construction context!");
1282 } else {
Artem Dergachev1527dec2018-03-12 23:12:40 +00001283 ConstructionContextMap[E] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001284 }
1285}
1286
Artem Dergachev783a4572018-02-23 22:20:39 +00001287void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001288 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001289 if (!BuildOpts.AddRichCXXConstructors)
1290 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001291
Artem Dergachev41ffb302018-02-08 22:58:15 +00001292 if (!Child)
1293 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001294
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001295 auto withExtraLayer = [this, Layer](const ConstructionContextItem &Item) {
1296 return ConstructionContextLayer::create(cfg->getBumpVectorContext(), Item,
1297 Layer);
Artem Dergachevff267df2018-06-28 00:04:54 +00001298 };
1299
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001300 switch(Child->getStmtClass()) {
1301 case Stmt::CXXConstructExprClass:
1302 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachevff267df2018-06-28 00:04:54 +00001303 // Support pre-C++17 copy elision AST.
1304 auto *CE = cast<CXXConstructExpr>(Child);
1305 if (BuildOpts.MarkElidedCXXConstructors && CE->isElidable()) {
Artem Dergachevff267df2018-06-28 00:04:54 +00001306 findConstructionContexts(withExtraLayer(CE), CE->getArg(0));
1307 }
1308
1309 consumeConstructionContext(Layer, CE);
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001310 break;
1311 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00001312 // FIXME: This, like the main visit, doesn't support CUDAKernelCallExpr.
1313 // FIXME: An isa<> would look much better but this whole switch is a
1314 // workaround for an internal compiler error in MSVC 2015 (see r326021).
1315 case Stmt::CallExprClass:
1316 case Stmt::CXXMemberCallExprClass:
1317 case Stmt::CXXOperatorCallExprClass:
Artem Dergacheve1f30622018-07-31 19:46:14 +00001318 case Stmt::UserDefinedLiteralClass:
1319 case Stmt::ObjCMessageExprClass: {
1320 auto *E = cast<Expr>(Child);
1321 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(E))
1322 consumeConstructionContext(Layer, E);
Artem Dergachev1527dec2018-03-12 23:12:40 +00001323 break;
1324 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001325 case Stmt::ExprWithCleanupsClass: {
1326 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001327 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001328 break;
1329 }
1330 case Stmt::CXXFunctionalCastExprClass: {
1331 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001332 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001333 break;
1334 }
1335 case Stmt::ImplicitCastExprClass: {
1336 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev317291e2018-03-22 21:37:39 +00001337 // Should we support other implicit cast kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001338 switch (Cast->getCastKind()) {
1339 case CK_NoOp:
1340 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001341 findConstructionContexts(Layer, Cast->getSubExpr());
Reid Kleckner4dc0b1a2018-11-01 19:54:45 +00001342 break;
Artem Dergachev13f96642018-03-09 01:39:59 +00001343 default:
1344 break;
1345 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001346 break;
1347 }
1348 case Stmt::CXXBindTemporaryExprClass: {
1349 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachevff267df2018-06-28 00:04:54 +00001350 findConstructionContexts(withExtraLayer(BTE), BTE->getSubExpr());
1351 break;
1352 }
1353 case Stmt::MaterializeTemporaryExprClass: {
1354 // Normally we don't want to search in MaterializeTemporaryExpr because
1355 // it indicates the beginning of a temporary object construction context,
1356 // so it shouldn't be found in the middle. However, if it is the beginning
1357 // of an elidable copy or move construction context, we need to include it.
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001358 if (Layer->getItem().getKind() ==
1359 ConstructionContextItem::ElidableConstructorKind) {
1360 auto *MTE = cast<MaterializeTemporaryExpr>(Child);
1361 findConstructionContexts(withExtraLayer(MTE), MTE->GetTemporaryExpr());
Artem Dergachevff267df2018-06-28 00:04:54 +00001362 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001363 break;
1364 }
1365 case Stmt::ConditionalOperatorClass: {
1366 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001367 if (Layer->getItem().getKind() !=
1368 ConstructionContextItem::MaterializationKind) {
Artem Dergachev9d3a7d82018-03-30 19:21:18 +00001369 // If the object returned by the conditional operator is not going to be a
1370 // temporary object that needs to be immediately materialized, then
1371 // it must be C++17 with its mandatory copy elision. Do not yet promise
1372 // to support this case.
1373 assert(!CO->getType()->getAsCXXRecordDecl() || CO->isGLValue() ||
1374 Context->getLangOpts().CPlusPlus17);
1375 break;
1376 }
Artem Dergachev40684812018-02-27 20:03:35 +00001377 findConstructionContexts(Layer, CO->getLHS());
1378 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001379 break;
1380 }
Artem Dergachevaa403152019-03-21 00:15:07 +00001381 case Stmt::InitListExprClass: {
1382 auto *ILE = cast<InitListExpr>(Child);
1383 if (ILE->isTransparent()) {
1384 findConstructionContexts(Layer, ILE->getInit(0));
1385 break;
1386 }
1387 // TODO: Handle other cases. For now, fail to find construction contexts.
1388 break;
1389 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001390 default:
1391 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001392 }
1393}
1394
Artem Dergachev1527dec2018-03-12 23:12:40 +00001395void CFGBuilder::cleanupConstructionContext(Expr *E) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001396 assert(BuildOpts.AddRichCXXConstructors &&
1397 "We should not be managing construction contexts!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001398 assert(ConstructionContextMap.count(E) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001399 "Cannot exit construction context without the context!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001400 ConstructionContextMap.erase(E);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001401}
1402
1403
Mike Stump31feda52009-07-17 01:31:16 +00001404/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1405/// arbitrary statement. Examples include a single expression or a function
1406/// body (compound statement). The ownership of the returned CFG is
1407/// transferred to the caller. If CFG construction fails, this method returns
1408/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001409std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001410 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001411 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001412 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001413
Mike Stump31feda52009-07-17 01:31:16 +00001414 // Create an empty block that will serve as the exit block for the CFG. Since
1415 // this is the first block added to the CFG, it will be implicitly registered
1416 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001417 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001418 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001419 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001420
Matthias Gehre351c2182017-07-12 07:04:19 +00001421 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1422 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1423
Marcin Swiderski20b88732010-10-05 05:37:00 +00001424 if (BuildOpts.AddImplicitDtors)
1425 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1426 addImplicitDtorsForDestructor(DD);
1427
Ted Kremenek9aae5132007-08-23 21:42:29 +00001428 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001429 CFGBlock *B = addStmt(Statement);
1430
1431 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001432 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001433
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001434 // For C++ constructor add initializers to CFG.
1435 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001436 for (auto *I : llvm::reverse(CD->inits())) {
1437 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001438 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001439 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001440 }
1441 }
1442
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001443 if (B)
1444 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001445
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001446 // Backpatch the gotos whose label -> block mappings we didn't know when we
1447 // encountered them.
1448 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1449 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001450
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001451 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001452 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001453 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001454
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001455 // If there is no target for the goto, then we are looking at an
1456 // incomplete AST. Handle this by not registering a successor.
1457 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001458
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001459 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001460 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1461 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001462 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1463 JT.scopePosition);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001464 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1465 B, I->scopePosition, JT.scopePosition);
1466 appendScopeBegin(JT.block, VD, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001467 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001468 }
1469
1470 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001471 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001472 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1473 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001474 // Lookup the target block.
1475 LabelMapTy::iterator LI = LabelMap.find(*I);
1476
1477 // If there is no target block that contains label, then we are looking
1478 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001479 if (LI == LabelMap.end()) continue;
Fangrui Song6907ce22018-07-30 19:24:48 +00001480
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001481 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001482 }
Mike Stump31feda52009-07-17 01:31:16 +00001483
Mike Stump31feda52009-07-17 01:31:16 +00001484 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001485 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001486
Artem Dergachev783a4572018-02-23 22:20:39 +00001487 if (BuildOpts.AddRichCXXConstructors)
1488 assert(ConstructionContextMap.empty() &&
1489 "Not all construction contexts were cleaned up!");
1490
David Blaikiee90195c2014-08-29 18:53:26 +00001491 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001492}
Mike Stump31feda52009-07-17 01:31:16 +00001493
Ted Kremenek9aae5132007-08-23 21:42:29 +00001494/// createBlock - Used to lazily create blocks that are connected
1495/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001496CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1497 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001498 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001499 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001500 return B;
1501}
Mike Stump31feda52009-07-17 01:31:16 +00001502
Chandler Carrutha70991b2011-09-13 09:13:49 +00001503/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1504/// CFG. It is *not* connected to the current (global) successor, and instead
1505/// directly tied to the exit block in order to be reachable.
1506CFGBlock *CFGBuilder::createNoReturnBlock() {
1507 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001508 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001509 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001510 return B;
1511}
1512
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001513/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001514CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001515 if (!BuildOpts.AddInitializers)
1516 return Block;
1517
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001518 bool HasTemporaries = false;
1519
1520 // Destructors of temporaries in initialization expression should be called
1521 // after initialization finishes.
1522 Expr *Init = I->getInit();
1523 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001524 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001525
Jordan Rose6d671cc2012-09-05 22:55:23 +00001526 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001527 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001528 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001529 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1530 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001531 }
1532 }
1533
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001534 autoCreateBlock();
1535 appendInitializer(Block, I);
1536
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001537 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001538 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001539 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001540 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001541
Ted Kremenek8219b822010-12-16 07:46:53 +00001542 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001543 // For expression with temporaries go directly to subexpression to omit
1544 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001545 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1546 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001547 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1548 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1549 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1550 // may cause the same Expr to appear more than once in the CFG. Doing it
1551 // here is safe because there's only one initializer per field.
1552 autoCreateBlock();
1553 appendStmt(Block, Default);
1554 if (Stmt *Child = Default->getExpr())
1555 if (CFGBlock *R = Visit(Child))
1556 Block = R;
1557 return Block;
1558 }
1559 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001560 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001561 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001562
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001563 return Block;
1564}
1565
Fangrui Song6907ce22018-07-30 19:24:48 +00001566/// Retrieve the type of the temporary object whose lifetime was
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001567/// extended by a local reference with the given initializer.
Artem Dergacheva25809f2018-06-04 18:56:25 +00001568static QualType getReferenceInitTemporaryType(const Expr *Init,
Richard Smithb8c0f552016-12-09 18:49:13 +00001569 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001570 while (true) {
1571 // Skip parentheses.
1572 Init = Init->IgnoreParens();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001573
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001574 // Skip through cleanups.
1575 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1576 Init = EWC->getSubExpr();
1577 continue;
1578 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001579
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001580 // Skip through the temporary-materialization expression.
1581 if (const MaterializeTemporaryExpr *MTE
1582 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1583 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001584 if (FoundMTE)
1585 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001586 continue;
1587 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001588
1589 // Skip sub-object accesses into rvalues.
1590 SmallVector<const Expr *, 2> CommaLHSs;
1591 SmallVector<SubobjectAdjustment, 2> Adjustments;
1592 const Expr *SkippedInit =
1593 Init->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments);
1594 if (SkippedInit != Init) {
1595 Init = SkippedInit;
1596 continue;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001597 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001598
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001599 break;
1600 }
1601
1602 return Init->getType();
1603}
Matthias Gehre351c2182017-07-12 07:04:19 +00001604
Peter Szecsi999a25f2017-08-19 11:19:16 +00001605// TODO: Support adding LoopExit element to the CFG in case where the loop is
1606// ended by ReturnStmt, GotoStmt or ThrowExpr.
1607void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1608 if(!BuildOpts.AddLoopExit)
1609 return;
1610 autoCreateBlock();
1611 appendLoopExit(Block, LoopStmt);
1612}
1613
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001614void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1615 LocalScope::const_iterator E, Stmt *S) {
1616 if (!BuildOpts.AddScopes)
1617 return;
1618
1619 if (B == E)
1620 return;
1621
1622 // To go from B to E, one first goes up the scopes from B to P
1623 // then sideways in one scope from P to P' and then down
1624 // the scopes from P' to E.
1625 // The lifetime of all objects between B and P end.
1626 LocalScope::const_iterator P = B.shared_parent(E);
1627 int Dist = B.distance(P);
1628 if (Dist <= 0)
1629 return;
1630
1631 for (LocalScope::const_iterator I = B; I != P; ++I)
1632 if (I.pointsToFirstDeclaredVar())
1633 DeclsWithEndedScope.insert(*I);
1634}
1635
Matthias Gehre351c2182017-07-12 07:04:19 +00001636void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1637 LocalScope::const_iterator E,
1638 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001639 getDeclsWithEndedScope(B, E, S);
1640 if (BuildOpts.AddScopes)
1641 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001642 if (BuildOpts.AddImplicitDtors)
1643 addAutomaticObjDtors(B, E, S);
1644 if (BuildOpts.AddLifetime)
1645 addLifetimeEnds(B, E, S);
1646}
1647
1648/// Add to current block automatic objects that leave the scope.
1649void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1650 LocalScope::const_iterator E, Stmt *S) {
1651 if (!BuildOpts.AddLifetime)
1652 return;
1653
1654 if (B == E)
1655 return;
1656
1657 // To go from B to E, one first goes up the scopes from B to P
1658 // then sideways in one scope from P to P' and then down
1659 // the scopes from P' to E.
1660 // The lifetime of all objects between B and P end.
1661 LocalScope::const_iterator P = B.shared_parent(E);
1662 int dist = B.distance(P);
1663 if (dist <= 0)
1664 return;
1665
1666 // We need to perform the scope leaving in reverse order
1667 SmallVector<VarDecl *, 10> DeclsTrivial;
1668 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1669 DeclsTrivial.reserve(dist);
1670 DeclsNonTrivial.reserve(dist);
1671
1672 for (LocalScope::const_iterator I = B; I != P; ++I)
1673 if (hasTrivialDestructor(*I))
1674 DeclsTrivial.push_back(*I);
1675 else
1676 DeclsNonTrivial.push_back(*I);
1677
1678 autoCreateBlock();
1679 // object with trivial destructor end their lifetime last (when storage
1680 // duration ends)
1681 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1682 E = DeclsTrivial.rend();
1683 I != E; ++I)
1684 appendLifetimeEnds(Block, *I, S);
1685
1686 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1687 I = DeclsNonTrivial.rbegin(),
1688 E = DeclsNonTrivial.rend();
1689 I != E; ++I)
1690 appendLifetimeEnds(Block, *I, S);
1691}
1692
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001693/// Add to current block markers for ending scopes.
1694void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1695 LocalScope::const_iterator E, Stmt *S) {
1696 // If implicit destructors are enabled, we'll add scope ends in
1697 // addAutomaticObjDtors.
1698 if (BuildOpts.AddImplicitDtors)
1699 return;
1700
1701 autoCreateBlock();
1702
1703 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1704 I != E; ++I)
1705 appendScopeEnd(Block, *I, S);
1706
1707 return;
1708}
1709
Marcin Swiderski5e415732010-09-30 23:05:00 +00001710/// addAutomaticObjDtors - Add to current block automatic objects destructors
1711/// for objects in range of local scope positions. Use S as trigger statement
1712/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001713void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001714 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001715 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001716 return;
1717
Marcin Swiderski5e415732010-09-30 23:05:00 +00001718 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001719 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001720
Chandler Carruthad747252011-09-13 06:09:01 +00001721 // We need to append the destructors in reverse order, but any one of them
1722 // may be a no-return destructor which changes the CFG. As a result, buffer
1723 // this sequence up and replay them in reverse order when appending onto the
1724 // CFGBlock(s).
1725 SmallVector<VarDecl*, 10> Decls;
1726 Decls.reserve(B.distance(E));
1727 for (LocalScope::const_iterator I = B; I != E; ++I)
1728 Decls.push_back(*I);
1729
1730 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1731 E = Decls.rend();
1732 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001733 if (hasTrivialDestructor(*I)) {
1734 // If AddScopes is enabled and *I is a first variable in a scope, add a
1735 // ScopeEnd marker in a Block.
1736 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1737 autoCreateBlock();
1738 appendScopeEnd(Block, *I, S);
1739 }
1740 continue;
1741 }
Chandler Carruthad747252011-09-13 06:09:01 +00001742 // If this destructor is marked as a no-return destructor, we need to
1743 // create a new block for the destructor which does not have as a successor
1744 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001745 QualType Ty = (*I)->getType();
1746 if (Ty->isReferenceType()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00001747 Ty = getReferenceInitTemporaryType((*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001748 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001749 Ty = Context->getBaseElementType(Ty);
1750
Richard Trieu95a192a2015-05-28 00:14:02 +00001751 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001752 Block = createNoReturnBlock();
1753 else
Chandler Carruthad747252011-09-13 06:09:01 +00001754 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001755
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001756 // Add ScopeEnd just after automatic obj destructor.
1757 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1758 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001759 appendAutomaticObjDtor(Block, *I, S);
1760 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001761}
1762
Marcin Swiderski20b88732010-10-05 05:37:00 +00001763/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1764/// base and member objects in destructor.
1765void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001766 assert(BuildOpts.AddImplicitDtors &&
1767 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001768 const CXXRecordDecl *RD = DD->getParent();
1769
1770 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001771 for (const auto &VI : RD->vbases()) {
1772 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001773 if (!CD->hasTrivialDestructor()) {
1774 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001775 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001776 }
1777 }
1778
1779 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001780 for (const auto &BI : RD->bases()) {
1781 if (!BI.isVirtual()) {
1782 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001783 if (!CD->hasTrivialDestructor()) {
1784 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001785 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001786 }
1787 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001788 }
1789
1790 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001791 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001792 // Check for constant size array. Set type to array element type.
1793 QualType QT = FI->getType();
1794 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1795 if (AT->getSize() == 0)
1796 continue;
1797 QT = AT->getElementType();
1798 }
1799
1800 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001801 if (!CD->hasTrivialDestructor()) {
1802 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001803 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001804 }
1805 }
1806}
1807
Marcin Swiderski5e415732010-09-30 23:05:00 +00001808/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1809/// way return valid LocalScope object.
1810LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001811 if (Scope)
1812 return Scope;
1813 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1814 return new (alloc.Allocate<LocalScope>())
1815 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001816}
1817
1818/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Fangrui Song6907ce22018-07-30 19:24:48 +00001819/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001820void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001821 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1822 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001823 return;
1824
Craig Topper25542942014-05-20 04:30:07 +00001825 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001826
1827 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001828 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001829 for (auto *BI : CS->body()) {
1830 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001831 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001832 Scope = addLocalScopeForDeclStmt(DS, Scope);
1833 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001834 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001835 }
1836
1837 // For any other statement scope will be implicit and as such will be
1838 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001839 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001840 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001841}
1842
1843/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1844/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001845LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001846 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001847 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1848 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001849 return Scope;
1850
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001851 for (auto *DI : DS->decls())
1852 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001853 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001854 return Scope;
1855}
1856
Matthias Gehre351c2182017-07-12 07:04:19 +00001857bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1858 // Check for const references bound to temporary. Set type to pointee.
1859 QualType QT = VD->getType();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001860 if (QT->isReferenceType()) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001861 // Attempt to determine whether this declaration lifetime-extends a
1862 // temporary.
1863 //
1864 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1865 // temporaries, and a single declaration can extend multiple temporaries.
1866 // We should look at the storage duration on each nested
1867 // MaterializeTemporaryExpr instead.
1868
1869 const Expr *Init = VD->getInit();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001870 if (!Init) {
1871 // Probably an exception catch-by-reference variable.
1872 // FIXME: It doesn't really mean that the object has a trivial destructor.
1873 // Also are there other cases?
Matthias Gehre351c2182017-07-12 07:04:19 +00001874 return true;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001875 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001876
Artem Dergacheva25809f2018-06-04 18:56:25 +00001877 // Lifetime-extending a temporary?
Matthias Gehre351c2182017-07-12 07:04:19 +00001878 bool FoundMTE = false;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001879 QT = getReferenceInitTemporaryType(Init, &FoundMTE);
Matthias Gehre351c2182017-07-12 07:04:19 +00001880 if (!FoundMTE)
1881 return true;
1882 }
1883
1884 // Check for constant size array. Set type to array element type.
1885 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1886 if (AT->getSize() == 0)
1887 return true;
1888 QT = AT->getElementType();
1889 }
1890
1891 // Check if type is a C++ class with non-trivial destructor.
1892 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1893 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1894 return true;
1895}
1896
Marcin Swiderski5e415732010-09-30 23:05:00 +00001897/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1898/// create add scope for automatic objects and temporary objects bound to
1899/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001900LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001901 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001902 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1903 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001904 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1905 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001906 return Scope;
1907
1908 // Check if variable is local.
1909 switch (VD->getStorageClass()) {
1910 case SC_None:
1911 case SC_Auto:
1912 case SC_Register:
1913 break;
1914 default: return Scope;
1915 }
1916
Matthias Gehre351c2182017-07-12 07:04:19 +00001917 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001918 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001919 // Add the variable to scope
1920 Scope = createOrReuseLocalScope(Scope);
1921 Scope->addVar(VD);
1922 ScopePos = Scope->begin();
1923 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001924 return Scope;
1925 }
1926
1927 assert(BuildOpts.AddLifetime);
1928 // Add the variable to scope
1929 Scope = createOrReuseLocalScope(Scope);
1930 Scope->addVar(VD);
1931 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001932 return Scope;
1933}
1934
1935/// addLocalScopeAndDtors - For given statement add local scope for it and
1936/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001937void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001938 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001939 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001940 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001941}
1942
Marcin Swiderski321a7072010-09-30 22:54:37 +00001943/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1944/// variables with automatic storage duration to CFGBlock's elements vector.
1945/// Elements will be prepended to physical beginning of the vector which
1946/// happens to be logical end. Use blocks terminator as statement that specifies
1947/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001948/// FIXME: This mechanism for adding automatic destructors doesn't handle
1949/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001950void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001951 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001952 if (!BuildOpts.AddImplicitDtors)
1953 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001954 BumpVectorContext &C = cfg->getBumpVectorContext();
1955 CFGBlock::iterator InsertPos
1956 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1957 for (LocalScope::const_iterator I = B; I != E; ++I)
1958 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1959 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001960}
1961
Matthias Gehre351c2182017-07-12 07:04:19 +00001962/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1963/// variables with automatic storage duration to CFGBlock's elements vector.
1964/// Elements will be prepended to physical beginning of the vector which
1965/// happens to be logical end. Use blocks terminator as statement that specifies
1966/// where lifetime ends.
1967void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1968 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1969 if (!BuildOpts.AddLifetime)
1970 return;
1971 BumpVectorContext &C = cfg->getBumpVectorContext();
1972 CFGBlock::iterator InsertPos =
1973 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1974 for (LocalScope::const_iterator I = B; I != E; ++I)
1975 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1976}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001977
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001978/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
1979/// variables with automatic storage duration to CFGBlock's elements vector.
1980/// Elements will be prepended to physical beginning of the vector which
1981/// happens to be logical end. Use blocks terminator as statement that specifies
1982/// where scope ends.
1983const VarDecl *
1984CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
1985 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1986 if (!BuildOpts.AddScopes)
1987 return nullptr;
1988 BumpVectorContext &C = cfg->getBumpVectorContext();
1989 CFGBlock::iterator InsertPos =
1990 Blk->beginScopeEndInsert(Blk->end(), 1, C);
1991 LocalScope::const_iterator PlaceToInsert = B;
1992 for (LocalScope::const_iterator I = B; I != E; ++I)
1993 PlaceToInsert = I;
1994 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminator());
1995 return *PlaceToInsert;
1996}
1997
Ted Kremenek93668002009-07-17 22:18:43 +00001998/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001999/// blocks for ternary operators, &&, and ||. We also process "," and
2000/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002001CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00002002 if (!S) {
2003 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00002004 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00002005 }
Jordy Rose17347372011-06-10 08:49:37 +00002006
2007 if (Expr *E = dyn_cast<Expr>(S))
2008 S = E->IgnoreParens();
2009
Ted Kremenek93668002009-07-17 22:18:43 +00002010 switch (S->getStmtClass()) {
2011 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002012 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002013
2014 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002015 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002016
John McCallc07a0c72011-02-17 10:25:35 +00002017 case Stmt::BinaryConditionalOperatorClass:
2018 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
2019
Ted Kremenek93668002009-07-17 22:18:43 +00002020 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002021 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002022
Ted Kremenek93668002009-07-17 22:18:43 +00002023 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00002024 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002025
Ted Kremenek93668002009-07-17 22:18:43 +00002026 case Stmt::BreakStmtClass:
2027 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002028
Ted Kremenek93668002009-07-17 22:18:43 +00002029 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00002030 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00002031 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00002032 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002033 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002034
Ted Kremenek93668002009-07-17 22:18:43 +00002035 case Stmt::CaseStmtClass:
2036 return VisitCaseStmt(cast<CaseStmt>(S));
2037
2038 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002039 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002040
Ted Kremenek93668002009-07-17 22:18:43 +00002041 case Stmt::CompoundStmtClass:
2042 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002043
Ted Kremenek93668002009-07-17 22:18:43 +00002044 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002045 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002046
Ted Kremenek93668002009-07-17 22:18:43 +00002047 case Stmt::ContinueStmtClass:
2048 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002049
Ted Kremenekb27378c2010-01-19 20:40:33 +00002050 case Stmt::CXXCatchStmtClass:
2051 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
2052
John McCall5d413782010-12-06 08:20:24 +00002053 case Stmt::ExprWithCleanupsClass:
2054 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00002055
Jordan Rosee5d53932012-08-23 18:10:53 +00002056 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00002057 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00002058 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
2059 // called function's declaration, not by the caller. If we simply add
2060 // this expression to the CFG, we could end up with the same Expr
2061 // appearing multiple times.
2062 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00002063 //
2064 // It's likewise possible for multiple CXXDefaultInitExprs for the same
2065 // expression to be used in the same function (through aggregate
2066 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00002067 return VisitStmt(S, asc);
2068
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002069 case Stmt::CXXBindTemporaryExprClass:
2070 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
2071
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002072 case Stmt::CXXConstructExprClass:
2073 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
2074
Jordan Rosec9176072014-01-13 17:59:19 +00002075 case Stmt::CXXNewExprClass:
2076 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2077
Jordan Rosed2f40792013-09-03 17:00:57 +00002078 case Stmt::CXXDeleteExprClass:
2079 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2080
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002081 case Stmt::CXXFunctionalCastExprClass:
2082 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2083
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002084 case Stmt::CXXTemporaryObjectExprClass:
2085 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2086
Ted Kremenekb27378c2010-01-19 20:40:33 +00002087 case Stmt::CXXThrowExprClass:
2088 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002089
Ted Kremenekb27378c2010-01-19 20:40:33 +00002090 case Stmt::CXXTryStmtClass:
2091 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002092
Richard Smith02e85f32011-04-14 22:09:26 +00002093 case Stmt::CXXForRangeStmtClass:
2094 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2095
Ted Kremenek93668002009-07-17 22:18:43 +00002096 case Stmt::DeclStmtClass:
2097 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002098
Ted Kremenek93668002009-07-17 22:18:43 +00002099 case Stmt::DefaultStmtClass:
2100 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002101
Ted Kremenek93668002009-07-17 22:18:43 +00002102 case Stmt::DoStmtClass:
2103 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002104
Ted Kremenek93668002009-07-17 22:18:43 +00002105 case Stmt::ForStmtClass:
2106 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002107
Ted Kremenek93668002009-07-17 22:18:43 +00002108 case Stmt::GotoStmtClass:
2109 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002110
Ted Kremenek93668002009-07-17 22:18:43 +00002111 case Stmt::IfStmtClass:
2112 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002113
Ted Kremenek8219b822010-12-16 07:46:53 +00002114 case Stmt::ImplicitCastExprClass:
2115 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002116
Bill Wendling8003edc2018-11-09 00:41:36 +00002117 case Stmt::ConstantExprClass:
2118 return VisitConstantExpr(cast<ConstantExpr>(S), asc);
2119
Ted Kremenek93668002009-07-17 22:18:43 +00002120 case Stmt::IndirectGotoStmtClass:
2121 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002122
Ted Kremenek93668002009-07-17 22:18:43 +00002123 case Stmt::LabelStmtClass:
2124 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002125
Ted Kremenekda76a942012-04-12 20:34:52 +00002126 case Stmt::LambdaExprClass:
2127 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2128
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002129 case Stmt::MaterializeTemporaryExprClass:
2130 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2131 asc);
2132
Ted Kremenek5868ec62010-04-11 17:02:10 +00002133 case Stmt::MemberExprClass:
2134 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2135
Ted Kremenek04268232011-11-05 00:10:15 +00002136 case Stmt::NullStmtClass:
2137 return Block;
2138
Ted Kremenek93668002009-07-17 22:18:43 +00002139 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002140 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2141
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002142 case Stmt::ObjCAutoreleasePoolStmtClass:
2143 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2144
Ted Kremenek93668002009-07-17 22:18:43 +00002145 case Stmt::ObjCAtSynchronizedStmtClass:
2146 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002147
Ted Kremenek93668002009-07-17 22:18:43 +00002148 case Stmt::ObjCAtThrowStmtClass:
2149 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002150
Ted Kremenek93668002009-07-17 22:18:43 +00002151 case Stmt::ObjCAtTryStmtClass:
2152 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002153
Ted Kremenek93668002009-07-17 22:18:43 +00002154 case Stmt::ObjCForCollectionStmtClass:
2155 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002156
Artem Dergachevbd880fe2018-07-31 19:39:37 +00002157 case Stmt::ObjCMessageExprClass:
2158 return VisitObjCMessageExpr(cast<ObjCMessageExpr>(S), asc);
2159
Ted Kremenek04268232011-11-05 00:10:15 +00002160 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002161 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002162
John McCallfe96e0b2011-11-06 09:01:30 +00002163 case Stmt::PseudoObjectExprClass:
2164 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2165
Ted Kremenek93668002009-07-17 22:18:43 +00002166 case Stmt::ReturnStmtClass:
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002167 case Stmt::CoreturnStmtClass:
2168 return VisitReturnStmt(S);
Mike Stump11289f42009-09-09 15:08:12 +00002169
Nico Weber699670e2017-08-23 15:33:16 +00002170 case Stmt::SEHExceptStmtClass:
2171 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2172
2173 case Stmt::SEHFinallyStmtClass:
2174 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2175
2176 case Stmt::SEHLeaveStmtClass:
2177 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2178
2179 case Stmt::SEHTryStmtClass:
2180 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2181
Peter Collingbournee190dee2011-03-11 19:24:49 +00002182 case Stmt::UnaryExprOrTypeTraitExprClass:
2183 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2184 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002185
Ted Kremenek93668002009-07-17 22:18:43 +00002186 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002187 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002188
Ted Kremenek93668002009-07-17 22:18:43 +00002189 case Stmt::SwitchStmtClass:
2190 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002191
Zhanyong Wan6dace612010-11-22 08:45:56 +00002192 case Stmt::UnaryOperatorClass:
2193 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2194
Ted Kremenek93668002009-07-17 22:18:43 +00002195 case Stmt::WhileStmtClass:
2196 return VisitWhileStmt(cast<WhileStmt>(S));
2197 }
2198}
Mike Stump11289f42009-09-09 15:08:12 +00002199
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002200CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002201 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002202 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002203 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002204 }
Mike Stump11289f42009-09-09 15:08:12 +00002205
Ted Kremenek93668002009-07-17 22:18:43 +00002206 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002207}
Mike Stump31feda52009-07-17 01:31:16 +00002208
Ted Kremenek93668002009-07-17 22:18:43 +00002209/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002210CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2211 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002212
Ted Kremenek8ae67872013-02-05 22:00:19 +00002213 // Visit the children in their reverse order so that they appear in
2214 // left-to-right (natural) order in the CFG.
2215 reverse_children RChildren(S);
2216 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2217 I != E; ++I) {
2218 if (Stmt *Child = *I)
2219 if (CFGBlock *R = Visit(Child))
2220 B = R;
2221 }
2222 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002223}
Mike Stump11289f42009-09-09 15:08:12 +00002224
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002225CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2226 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002227 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002228
Ted Kremenek7c58d352011-03-10 01:14:11 +00002229 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002230 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002231 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002232 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002233
Ted Kremenek9aae5132007-08-23 21:42:29 +00002234 return Block;
2235}
Mike Stump11289f42009-09-09 15:08:12 +00002236
Zhanyong Wan6dace612010-11-22 08:45:56 +00002237CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002238 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002239 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002240 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002241 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002242 }
2243
Ted Kremenek8219b822010-12-16 07:46:53 +00002244 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002245}
2246
Ted Kremeneka16436f2012-07-14 05:04:06 +00002247CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2248 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2249 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002250
Ted Kremeneka16436f2012-07-14 05:04:06 +00002251 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002252 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002253
Craig Topper25542942014-05-20 04:30:07 +00002254 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2255 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002256}
2257
2258std::pair<CFGBlock*, CFGBlock*>
2259CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2260 Stmt *Term,
2261 CFGBlock *TrueBlock,
2262 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002263 // Introspect the RHS. If it is a nested logical operation, we recursively
2264 // build the CFG using this function. Otherwise, resort to default
2265 // CFG construction behavior.
2266 Expr *RHS = B->getRHS()->IgnoreParens();
2267 CFGBlock *RHSBlock, *ExitBlock;
2268
2269 do {
2270 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2271 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002272 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002273 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2274 break;
2275 }
2276
2277 // The RHS is not a nested logical operation. Don't push the terminator
2278 // down further, but instead visit RHS and construct the respective
2279 // pieces of the CFG, and link up the RHSBlock with the terminator
2280 // we have been provided.
2281 ExitBlock = RHSBlock = createBlock(false);
2282
Richard Trieu6a6af522017-01-04 00:46:30 +00002283 // Even though KnownVal is only used in the else branch of the next
2284 // conditional, tryEvaluateBool performs additional checking on the
2285 // Expr, so it should be called unconditionally.
2286 TryResult KnownVal = tryEvaluateBool(RHS);
2287 if (!KnownVal.isKnown())
2288 KnownVal = tryEvaluateBool(B);
2289
Ted Kremenekb50e7162012-07-14 05:04:10 +00002290 if (!Term) {
2291 assert(TrueBlock == FalseBlock);
2292 addSuccessor(RHSBlock, TrueBlock);
2293 }
2294 else {
2295 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002296 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2297 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002298 }
2299
2300 Block = RHSBlock;
2301 RHSBlock = addStmt(RHS);
2302 }
2303 while (false);
2304
2305 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002306 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002307
2308 // Generate the blocks for evaluating the LHS.
2309 Expr *LHS = B->getLHS()->IgnoreParens();
2310
2311 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2312 if (B_LHS->isLogicalOp()) {
2313 if (B->getOpcode() == BO_LOr)
2314 FalseBlock = RHSBlock;
2315 else
2316 TrueBlock = RHSBlock;
2317
2318 // For the LHS, treat 'B' as the terminator that we want to sink
2319 // into the nested branch. The RHS always gets the top-most
2320 // terminator.
2321 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2322 }
2323
2324 // Create the block evaluating the LHS.
2325 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002326 CFGBlock *LHSBlock = createBlock(false);
2327 LHSBlock->setTerminator(B);
2328
Ted Kremeneka16436f2012-07-14 05:04:06 +00002329 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002330 CFGBlock *EntryLHSBlock = addStmt(LHS);
2331
2332 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002333 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002334
2335 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002336 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002337
2338 // Now link the LHSBlock with RHSBlock.
2339 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002340 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2341 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002342 } else {
2343 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002344 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2345 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002346 }
2347
Ted Kremenekb50e7162012-07-14 05:04:10 +00002348 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002349}
2350
2351CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2352 AddStmtChoice asc) {
2353 // && or ||
2354 if (B->isLogicalOp())
2355 return VisitLogicalOperator(B);
2356
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002357 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002358 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002359 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002360 addStmt(B->getRHS());
2361 return addStmt(B->getLHS());
2362 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002363
2364 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002365 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002366 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002367 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002368 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002369 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002370 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002371 }
Mike Stump11289f42009-09-09 15:08:12 +00002372
Ted Kremenek7c58d352011-03-10 01:14:11 +00002373 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002374 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002375 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002376 }
2377
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002378 CFGBlock *RBlock = Visit(B->getRHS());
2379 CFGBlock *LBlock = Visit(B->getLHS());
2380 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2381 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2382 // return RBlock. Otherwise we'll incorrectly return NULL.
2383 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002384}
2385
Ted Kremeneke2499842012-04-12 20:03:44 +00002386CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002387 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002388 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002389 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002390 }
2391 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002392}
2393
Ted Kremenek93668002009-07-17 22:18:43 +00002394CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2395 // "break" is a control-flow statement. Thus we stop processing the current
2396 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002397 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002398 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002399
Ted Kremenek93668002009-07-17 22:18:43 +00002400 // Now create a new block that ends with the break statement.
2401 Block = createBlock(false);
2402 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002403
Ted Kremenek93668002009-07-17 22:18:43 +00002404 // If there is no target for the break, then we are looking at an incomplete
2405 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002406 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002407 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002408 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002409 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002410 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002411
Ted Kremenek9aae5132007-08-23 21:42:29 +00002412 return Block;
2413}
Mike Stump11289f42009-09-09 15:08:12 +00002414
Sebastian Redl31ad7542011-03-13 17:09:40 +00002415static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002416 QualType Ty = E->getType();
2417 if (Ty->isFunctionPointerType())
2418 Ty = Ty->getAs<PointerType>()->getPointeeType();
2419 else if (Ty->isBlockPointerType())
2420 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002421
Mike Stump04c68512010-01-21 15:20:48 +00002422 const FunctionType *FT = Ty->getAs<FunctionType>();
2423 if (FT) {
2424 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002425 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00002426 Proto->isNothrow())
Mike Stump04c68512010-01-21 15:20:48 +00002427 return false;
2428 }
2429 return true;
2430}
2431
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002432CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002433 // Compute the callee type.
2434 QualType calleeType = C->getCallee()->getType();
2435 if (calleeType == Context->BoundMemberTy) {
2436 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2437
2438 // We should only get a null bound type if processing a dependent
2439 // CFG. Recover by assuming nothing.
2440 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002441 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002442
John McCallc67067f2011-05-11 07:19:11 +00002443 // If this is a call to a no-return function, this stops the block here.
2444 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2445
Mike Stump04c68512010-01-21 15:20:48 +00002446 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002447
2448 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002449 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002450 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002451 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002452 }
2453
Jordan Rose5374c072013-08-19 16:27:28 +00002454 // If this is a call to a builtin function, it might not actually evaluate
2455 // its arguments. Don't add them to the CFG if this is the case.
2456 bool OmitArguments = false;
2457
Mike Stump92244b02010-01-19 22:00:14 +00002458 if (FunctionDecl *FD = C->getDirectCallee()) {
Artem Dergachev594b5412018-08-29 21:50:52 +00002459 // TODO: Support construction contexts for variadic function arguments.
2460 // These are a bit problematic and not very useful because passing
2461 // C++ objects as C-style variadic arguments doesn't work in general
2462 // (see [expr.call]).
2463 if (!FD->isVariadic())
2464 findConstructionContextsForArguments(C);
2465
Nico Weber758fbac2018-02-13 21:31:47 +00002466 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002467 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002468 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002469 AddEHEdge = false;
Erik Pilkington9c3b5882019-01-30 20:34:53 +00002470 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size ||
2471 FD->getBuiltinID() == Builtin::BI__builtin_dynamic_object_size)
Jordan Rose5374c072013-08-19 16:27:28 +00002472 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002473 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002474
Sebastian Redl31ad7542011-03-13 17:09:40 +00002475 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002476 AddEHEdge = false;
2477
Jordan Rose5374c072013-08-19 16:27:28 +00002478 if (OmitArguments) {
2479 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2480 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2481 autoCreateBlock();
2482 appendStmt(Block, C);
2483 return Visit(C->getCallee());
2484 }
2485
2486 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002487 autoCreateBlock();
2488 appendCall(Block, C);
2489
2490 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002491 }
Mike Stump11289f42009-09-09 15:08:12 +00002492
Mike Stump92244b02010-01-19 22:00:14 +00002493 if (Block) {
2494 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002495 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002496 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002497 }
Mike Stump11289f42009-09-09 15:08:12 +00002498
Chandler Carrutha70991b2011-09-13 09:13:49 +00002499 if (NoReturn)
2500 Block = createNoReturnBlock();
2501 else
2502 Block = createBlock();
2503
Artem Dergachev1527dec2018-03-12 23:12:40 +00002504 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002505
Mike Stump04c68512010-01-21 15:20:48 +00002506 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002507 // Add exceptional edges.
2508 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002509 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002510 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002511 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002512 }
Mike Stump11289f42009-09-09 15:08:12 +00002513
Mike Stump8c5d7992009-07-25 21:26:53 +00002514 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002515}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002516
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002517CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2518 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002519 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002520 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002521 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002522 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002523
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002524 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002525 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002526 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002527 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002528 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002529 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002530
Ted Kremenek21822592009-07-17 18:20:32 +00002531 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002532 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002533 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002534 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002535 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002536
Ted Kremenek21822592009-07-17 18:20:32 +00002537 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002538 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002539 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002540 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2541 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002542 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002543 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002544}
Mike Stump11289f42009-09-09 15:08:12 +00002545
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002546CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002547 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002548 addLocalScopeForStmt(C);
2549
Matthias Gehre09a134e2015-11-14 00:36:50 +00002550 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002551 // If the body ends with a ReturnStmt, the dtors will be added in
2552 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002553 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002554 }
2555
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002556 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002557
2558 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2559 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002560 // If we hit a segment of code just containing ';' (NullStmts), we can
2561 // get a null block back. In such cases, just use the LastBlock
2562 if (CFGBlock *newBlock = addStmt(*I))
2563 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002564
Ted Kremenekce499c22009-08-27 23:16:26 +00002565 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002566 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002567 }
Mike Stump92244b02010-01-19 22:00:14 +00002568
Ted Kremenek93668002009-07-17 22:18:43 +00002569 return LastBlock;
2570}
Mike Stump11289f42009-09-09 15:08:12 +00002571
John McCallc07a0c72011-02-17 10:25:35 +00002572CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002573 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002574 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002575 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002576
Ted Kremenek51d40b02009-07-17 18:15:54 +00002577 // Create the confluence block that will "merge" the results of the ternary
2578 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002579 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002580 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002581 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002582 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002583
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002584 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002585
Ted Kremenek51d40b02009-07-17 18:15:54 +00002586 // Create a block for the LHS expression if there is an LHS expression. A
2587 // GCC extension allows LHS to be NULL, causing the condition to be the
2588 // value that is returned instead.
2589 // e.g: x ?: y is shorthand for: x ? x : y;
2590 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002591 Block = nullptr;
2592 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002593 const Expr *trueExpr = C->getTrueExpr();
2594 if (trueExpr != opaqueValue) {
2595 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002596 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002597 return nullptr;
2598 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002599 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002600 else
2601 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002602
Ted Kremenek51d40b02009-07-17 18:15:54 +00002603 // Create the block for the RHS expression.
2604 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002605 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002606 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002607 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002608
Richard Smithf676e452012-07-24 21:02:14 +00002609 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2610 if (BinaryOperator *Cond =
2611 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2612 if (Cond->isLogicalOp())
2613 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2614
Ted Kremenek51d40b02009-07-17 18:15:54 +00002615 // Create the block that will contain the condition.
2616 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002617
Mike Stump773582d2009-07-23 23:25:26 +00002618 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002619 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002620 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2621 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002622 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002623 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002624
Ted Kremenekd8138012011-02-24 03:09:15 +00002625 if (opaqueValue) {
2626 // Run the condition expression if it's not trivially expressed in
2627 // terms of the opaque value (or if there is no opaque value).
2628 if (condExpr != opaqueValue)
2629 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002630
Ted Kremenekd8138012011-02-24 03:09:15 +00002631 // Before that, run the common subexpression if there was one.
2632 // At least one of this or the above will be run.
2633 return addStmt(BCO->getCommon());
2634 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002635
Ted Kremenekd8138012011-02-24 03:09:15 +00002636 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002637}
2638
Ted Kremenek93668002009-07-17 22:18:43 +00002639CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002640 // Check if the Decl is for an __label__. If so, elide it from the
2641 // CFG entirely.
2642 if (isa<LabelDecl>(*DS->decl_begin()))
2643 return Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00002644
Ted Kremenek3a601142011-05-24 20:41:31 +00002645 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002646 if (DS->isSingleDecl())
2647 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002648
Craig Topper25542942014-05-20 04:30:07 +00002649 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002650
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002651 // Build an individual DeclStmt for each decl.
2652 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2653 E = DS->decl_rend();
2654 I != E; ++I) {
Mike Stump11289f42009-09-09 15:08:12 +00002655
Ted Kremenek93668002009-07-17 22:18:43 +00002656 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2657 // automatically freed with the CFG.
2658 DeclGroupRef DG(*I);
2659 Decl *D = *I;
George Karpenkovc1ac8082018-10-02 21:19:01 +00002660 DeclStmt *DSNew = new (Context) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002661 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002662
Ted Kremenek93668002009-07-17 22:18:43 +00002663 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002664 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002665 }
Mike Stump11289f42009-09-09 15:08:12 +00002666
2667 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002668}
Mike Stump11289f42009-09-09 15:08:12 +00002669
Ted Kremenek93668002009-07-17 22:18:43 +00002670/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002671/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002672CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002673 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002674 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002675
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002676 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002677 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2678 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002679 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002680 }
Mike Stump11289f42009-09-09 15:08:12 +00002681
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002682 bool HasTemporaries = false;
2683
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002684 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002685 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002686
2687 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2688 // For static variables, we need to create a branch to track
2689 // whether or not they are initialized.
2690 if (Block) {
2691 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002692 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002693 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002694 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002695 }
2696 blockAfterStaticInit = Succ;
2697 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002698
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002699 // Destructors of temporaries in initialization expression should be called
2700 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002701 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002702 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002703 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002704
Jordan Rose6d671cc2012-09-05 22:55:23 +00002705 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002706 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002707 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002708 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2709 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002710 }
2711 }
2712
2713 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002714 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002715
Artem Dergachev783a4572018-02-23 22:20:39 +00002716 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002717 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002718 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002719
Ted Kremenek213d0532012-03-22 05:57:43 +00002720 // Keep track of the last non-null block, as 'Block' can be nulled out
2721 // if the initializer expression is something like a 'while' in a
2722 // statement-expression.
2723 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002724
Ted Kremenek93668002009-07-17 22:18:43 +00002725 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002726 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002727 // For expression with temporaries go directly to subexpression to omit
2728 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002729 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2730 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2731 LastBlock = newBlock;
2732 }
2733 else {
2734 if (CFGBlock *newBlock = Visit(Init))
2735 LastBlock = newBlock;
2736 }
Ted Kremenek93668002009-07-17 22:18:43 +00002737 }
Mike Stump11289f42009-09-09 15:08:12 +00002738
Ted Kremenek93668002009-07-17 22:18:43 +00002739 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002740 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002741 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002742 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2743 LastBlock = newBlock;
2744 }
Mike Stump11289f42009-09-09 15:08:12 +00002745
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002746 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2747
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002748 // Remove variable from local scope.
2749 if (ScopePos && VD == *ScopePos)
2750 ++ScopePos;
2751
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002752 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002753 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002754 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002755 Block = createBlock(false);
2756 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002757 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002758 addSuccessor(Block, B);
2759 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002760 }
2761
2762 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002763}
2764
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002765CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002766 // We may see an if statement in the middle of a basic block, or it may be the
2767 // first statement we are processing. In either case, we create a new basic
2768 // block. First, we create the blocks for the then...else statements, and
2769 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002770 // middle of a block, we stop processing that block. That block is then the
2771 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002772
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002773 // Save local scope position because in case of condition variable ScopePos
2774 // won't be restored when traversing AST.
2775 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2776
Richard Smitha547eb22016-07-14 00:11:03 +00002777 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002778 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002779 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002780
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002781 // Create local scope for possible condition variable.
2782 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002783 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002784 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002785
Matthias Gehre351c2182017-07-12 07:04:19 +00002786 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002787
Chris Lattner57540c52011-04-15 05:22:18 +00002788 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002789 // block.
2790 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002791 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002792 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002793 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002794 }
Mike Stump31feda52009-07-17 01:31:16 +00002795
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002796 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002797 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002798
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002799 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002800 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002801
Ted Kremenek9aae5132007-08-23 21:42:29 +00002802 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002803 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002804 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002805
2806 // If branch is not a compound statement create implicit scope
2807 // and add destructors.
2808 if (!isa<CompoundStmt>(Else))
2809 addLocalScopeAndDtors(Else);
2810
Ted Kremenek93668002009-07-17 22:18:43 +00002811 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002812
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002813 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2814 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002815 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002816 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002817 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002818 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002819 }
Mike Stump31feda52009-07-17 01:31:16 +00002820
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002821 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002822 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002823 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002824 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002825 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002826 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002827 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002828
2829 // If branch is not a compound statement create implicit scope
2830 // and add destructors.
2831 if (!isa<CompoundStmt>(Then))
2832 addLocalScopeAndDtors(Then);
2833
Ted Kremenek93668002009-07-17 22:18:43 +00002834 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002835
Ted Kremenek1b379512009-04-01 03:52:47 +00002836 if (!ThenBlock) {
2837 // We can reach here if the "then" body has all NullStmts.
2838 // Create an empty block so we can distinguish between true and false
2839 // branches in path-sensitive analyses.
2840 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002841 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002842 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002843 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002844 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002845 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002846 }
2847
Ted Kremenekb50e7162012-07-14 05:04:10 +00002848 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2849 // having these handle the actual control-flow jump. Note that
2850 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2851 // we resort to the old control-flow behavior. This special handling
2852 // removes infeasible paths from the control-flow graph by having the
2853 // control-flow transfer of '&&' or '||' go directly into the then/else
2854 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002855 BinaryOperator *Cond =
2856 I->getConditionVariable()
2857 ? nullptr
2858 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2859 CFGBlock *LastBlock;
2860 if (Cond && Cond->isLogicalOp())
2861 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2862 else {
2863 // Now create a new block containing the if statement.
2864 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002865
Richard Smith509bbd12017-01-13 22:16:41 +00002866 // Set the terminator of the new block to the If statement.
2867 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002868
Richard Smith509bbd12017-01-13 22:16:41 +00002869 // See if this is a known constant.
2870 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002871
Richard Smith509bbd12017-01-13 22:16:41 +00002872 // Add the successors. If we know that specific branches are
2873 // unreachable, inform addSuccessor() of that knowledge.
2874 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2875 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002876
Richard Smith509bbd12017-01-13 22:16:41 +00002877 // Add the condition as the last statement in the new block. This may
2878 // create new blocks as the condition may contain control-flow. Any newly
2879 // created blocks will be pointed to be "Block".
2880 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002881
Richard Smith509bbd12017-01-13 22:16:41 +00002882 // If the IfStmt contains a condition variable, add it and its
2883 // initializer to the CFG.
2884 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2885 autoCreateBlock();
2886 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2887 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002888 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002889
Richard Smitha547eb22016-07-14 00:11:03 +00002890 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2891 if (Stmt *Init = I->getInit()) {
2892 autoCreateBlock();
2893 LastBlock = addStmt(Init);
2894 }
2895
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002896 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002897}
Mike Stump31feda52009-07-17 01:31:16 +00002898
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002899CFGBlock *CFGBuilder::VisitReturnStmt(Stmt *S) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002900 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002901 //
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002902 // NOTE: If a "return" or "co_return" appears in the middle of a block, this
2903 // means that the code afterwards is DEAD (unreachable). We still keep
2904 // a basic block for that code; a simple "mark-and-sweep" from the entry
2905 // block will be able to report such dead blocks.
2906 assert(isa<ReturnStmt>(S) || isa<CoreturnStmt>(S));
Ted Kremenek9aae5132007-08-23 21:42:29 +00002907
2908 // Create the new block.
2909 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002910
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002911 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), S);
Pavel Labath921e7652013-09-06 08:12:48 +00002912
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002913 if (auto *R = dyn_cast<ReturnStmt>(S))
2914 findConstructionContexts(
2915 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
2916 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002917
Pavel Labath921e7652013-09-06 08:12:48 +00002918 // If the one of the destructors does not return, we already have the Exit
2919 // block as a successor.
2920 if (!Block->hasNoReturnElement())
2921 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002922
2923 // Add the return statement to the block. This may create new blocks if R
2924 // contains control-flow (short-circuit operations).
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002925 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002926}
2927
Nico Weber699670e2017-08-23 15:33:16 +00002928CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2929 // SEHExceptStmt are treated like labels, so they are the first statement in a
2930 // block.
2931
2932 // Save local scope position because in case of exception variable ScopePos
2933 // won't be restored when traversing AST.
2934 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2935
2936 addStmt(ES->getBlock());
2937 CFGBlock *SEHExceptBlock = Block;
2938 if (!SEHExceptBlock)
2939 SEHExceptBlock = createBlock();
2940
2941 appendStmt(SEHExceptBlock, ES);
2942
2943 // Also add the SEHExceptBlock as a label, like with regular labels.
2944 SEHExceptBlock->setLabel(ES);
2945
2946 // Bail out if the CFG is bad.
2947 if (badCFG)
2948 return nullptr;
2949
2950 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2951 Block = nullptr;
2952
2953 return SEHExceptBlock;
2954}
2955
2956CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2957 return VisitCompoundStmt(FS->getBlock());
2958}
2959
2960CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2961 // "__leave" is a control-flow statement. Thus we stop processing the current
2962 // block.
2963 if (badCFG)
2964 return nullptr;
2965
2966 // Now create a new block that ends with the __leave statement.
2967 Block = createBlock(false);
2968 Block->setTerminator(LS);
2969
2970 // If there is no target for the __leave, then we are looking at an incomplete
2971 // AST. This means that the CFG cannot be constructed.
2972 if (SEHLeaveJumpTarget.block) {
2973 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2974 addSuccessor(Block, SEHLeaveJumpTarget.block);
2975 } else
2976 badCFG = true;
2977
2978 return Block;
2979}
2980
2981CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2982 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2983 // processing the current block.
2984 CFGBlock *SEHTrySuccessor = nullptr;
2985
2986 if (Block) {
2987 if (badCFG)
2988 return nullptr;
2989 SEHTrySuccessor = Block;
2990 } else SEHTrySuccessor = Succ;
2991
2992 // FIXME: Implement __finally support.
2993 if (Terminator->getFinallyHandler())
2994 return NYS();
2995
2996 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2997
2998 // Create a new block that will contain the __try statement.
2999 CFGBlock *NewTryTerminatedBlock = createBlock(false);
3000
3001 // Add the terminator in the __try block.
3002 NewTryTerminatedBlock->setTerminator(Terminator);
3003
3004 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
3005 // The code after the try is the implicit successor if there's an __except.
3006 Succ = SEHTrySuccessor;
3007 Block = nullptr;
3008 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
3009 if (!ExceptBlock)
3010 return nullptr;
3011 // Add this block to the list of successors for the block with the try
3012 // statement.
3013 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
3014 }
3015 if (PrevSEHTryTerminatedBlock)
3016 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
3017 else
3018 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
3019
3020 // The code after the try is the implicit successor.
3021 Succ = SEHTrySuccessor;
3022
3023 // Save the current "__try" context.
3024 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
3025 NewTryTerminatedBlock);
3026 cfg->addTryDispatchBlock(TryTerminatedBlock);
3027
3028 // Save the current value for the __leave target.
3029 // All __leaves should go to the code following the __try
3030 // (FIXME: or if the __try has a __finally, to the __finally.)
3031 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
3032 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
3033
3034 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
3035 Block = nullptr;
3036 return addStmt(Terminator->getTryBlock());
3037}
3038
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003039CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003040 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00003041 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003042 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003043
Ted Kremenek93668002009-07-17 22:18:43 +00003044 if (!LabelBlock) // This can happen when the body is empty, i.e.
3045 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00003046
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003047 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
3048 "label already in map");
3049 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003050
3051 // Labels partition blocks, so this is the end of the basic block we were
3052 // processing (L is the block's label). Because this is label (and we have
3053 // already processed the substatement) there is no extra control-flow to worry
3054 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00003055 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003056 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003057 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003058
3059 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00003060 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003061
Ted Kremenek9aae5132007-08-23 21:42:29 +00003062 // This block is now the implicit successor of other blocks.
3063 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003064
Ted Kremenek9aae5132007-08-23 21:42:29 +00003065 return LabelBlock;
3066}
3067
Devin Coughlinb6029b72015-11-25 22:35:37 +00003068CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
3069 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3070 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
3071 if (Expr *CopyExpr = CI.getCopyExpr()) {
3072 CFGBlock *Tmp = Visit(CopyExpr);
3073 if (Tmp)
3074 LastBlock = Tmp;
3075 }
3076 }
3077 return LastBlock;
3078}
3079
Ted Kremenekda76a942012-04-12 20:34:52 +00003080CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
3081 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3082 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
3083 et = E->capture_init_end(); it != et; ++it) {
3084 if (Expr *Init = *it) {
3085 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00003086 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00003087 LastBlock = Tmp;
3088 }
3089 }
3090 return LastBlock;
3091}
Fangrui Song6907ce22018-07-30 19:24:48 +00003092
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003093CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003094 // Goto is a control-flow statement. Thus we stop processing the current
3095 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003096
Ted Kremenek9aae5132007-08-23 21:42:29 +00003097 Block = createBlock(false);
3098 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003099
3100 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003101 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003102
Ted Kremenek9aae5132007-08-23 21:42:29 +00003103 if (I == LabelMap.end())
3104 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003105 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3106 else {
3107 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003108 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003109 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003110 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003111
Mike Stump31feda52009-07-17 01:31:16 +00003112 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003113}
3114
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003115CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003116 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003117
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003118 // Save local scope position because in case of condition variable ScopePos
3119 // won't be restored when traversing AST.
3120 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3121
3122 // Create local scope for init statement and possible condition variable.
3123 // Add destructor for init statement and condition variable.
3124 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003125 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003126 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003127 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3128
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003129 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003130 addLocalScopeForVarDecl(VD);
3131 LocalScope::const_iterator ContinueScopePos = ScopePos;
3132
Matthias Gehre351c2182017-07-12 07:04:19 +00003133 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003134
Peter Szecsi999a25f2017-08-19 11:19:16 +00003135 addLoopExit(F);
3136
Mike Stump014b3ea2009-07-21 01:12:51 +00003137 // "for" is a control-flow statement. Thus we stop processing the current
3138 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003139 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003140 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003141 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003142 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003143 } else
3144 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003145
Ted Kremenek304a9532010-05-21 20:30:15 +00003146 // Save the current value for the break targets.
3147 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003148 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003149 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003150
Craig Topper25542942014-05-20 04:30:07 +00003151 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003152
Ted Kremenek9aae5132007-08-23 21:42:29 +00003153 // Now create the loop body.
3154 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003155 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003156
Ted Kremenekb50e7162012-07-14 05:04:10 +00003157 // Save the current values for Block, Succ, continue and break targets.
3158 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3159 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003160
Ted Kremenekb50e7162012-07-14 05:04:10 +00003161 // Create an empty block to represent the transition block for looping back
3162 // to the head of the loop. If we have increment code, it will
3163 // go in this block as well.
3164 Block = Succ = TransitionBlock = createBlock(false);
3165 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003166
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003167 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003168 // Generate increment code in its own basic block. This is the target of
3169 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003170 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003171 }
Mike Stump31feda52009-07-17 01:31:16 +00003172
Ted Kremenek902393b2009-04-28 00:51:56 +00003173 // Finish up the increment (or empty) block if it hasn't been already.
3174 if (Block) {
3175 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003176 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003177 return nullptr;
3178 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003179 }
Mike Stump31feda52009-07-17 01:31:16 +00003180
Ted Kremenekb50e7162012-07-14 05:04:10 +00003181 // The starting block for the loop increment is the block that should
3182 // represent the 'loop target' for looping back to the start of the loop.
3183 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3184 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003185
Ted Kremenekb50e7162012-07-14 05:04:10 +00003186 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003187 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003188
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003189 // If body is not a compound statement create implicit scope
3190 // and add destructors.
3191 if (!isa<CompoundStmt>(F->getBody()))
3192 addLocalScopeAndDtors(F->getBody());
3193
Mike Stump31feda52009-07-17 01:31:16 +00003194 // Now populate the body block, and in the process create new blocks as we
3195 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003196 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003197
Ted Kremenekb50e7162012-07-14 05:04:10 +00003198 if (!BodyBlock) {
3199 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3200 // Use the continue jump target as the proxy for the body.
3201 BodyBlock = ContinueJumpTarget.block;
3202 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003203 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003204 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003205 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003206
Ted Kremenekb50e7162012-07-14 05:04:10 +00003207 // Because of short-circuit evaluation, the condition of the loop can span
3208 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3209 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003210 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003211
Ted Kremenekb50e7162012-07-14 05:04:10 +00003212 do {
3213 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003214 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003215
3216 // Specially handle logical operators, which have a slightly
3217 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003218 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003219 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003220 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003221 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003222 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3223 break;
3224 }
3225
3226 // The default case when not handling logical operators.
3227 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3228 ExitConditionBlock->setTerminator(F);
3229
3230 // See if this is a known constant.
3231 TryResult KnownVal(true);
3232
3233 if (C) {
3234 // Now add the actual condition to the condition block.
3235 // Because the condition itself may contain control-flow, new blocks may
3236 // be created. Thus we update "Succ" after adding the condition.
3237 Block = ExitConditionBlock;
3238 EntryConditionBlock = addStmt(C);
3239
3240 // If this block contains a condition variable, add both the condition
3241 // variable and initializer to the CFG.
3242 if (VarDecl *VD = F->getConditionVariable()) {
3243 if (Expr *Init = VD->getInit()) {
3244 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003245 const DeclStmt *DS = F->getConditionVariableDeclStmt();
3246 assert(DS->isSingleDecl());
3247 findConstructionContexts(
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00003248 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003249 Init);
3250 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003251 EntryConditionBlock = addStmt(Init);
3252 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003253 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003254 }
3255 }
3256
3257 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003258 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003259
3260 KnownVal = tryEvaluateBool(C);
3261 }
3262
3263 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003264 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003265 // Link up the condition block with the code that follows the loop. (the
3266 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003267 addSuccessor(ExitConditionBlock,
3268 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003269 } while (false);
3270
3271 // Link up the loop-back block to the entry condition block.
3272 addSuccessor(TransitionBlock, EntryConditionBlock);
Fangrui Song6907ce22018-07-30 19:24:48 +00003273
Ted Kremenekb50e7162012-07-14 05:04:10 +00003274 // The condition block is the implicit successor for any code above the loop.
3275 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003276
Ted Kremenek9aae5132007-08-23 21:42:29 +00003277 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003278 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003279 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003280 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3281 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003282 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003283 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003284 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003285
3286 // There is no loop initialization. We are thus basically a while loop.
3287 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003288 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003289 Succ = EntryConditionBlock;
3290 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003291}
3292
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003293CFGBlock *
3294CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3295 AddStmtChoice asc) {
3296 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003297 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003298 MTE->getTemporary());
3299
3300 return VisitStmt(MTE, asc);
3301}
3302
Ted Kremenek5868ec62010-04-11 17:02:10 +00003303CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003304 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003305 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003306 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003307 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003308 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003309}
3310
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003311CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003312 // Objective-C fast enumeration 'for' statements:
3313 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3314 //
3315 // for ( Type newVariable in collection_expression ) { statements }
3316 //
3317 // becomes:
3318 //
3319 // prologue:
3320 // 1. collection_expression
3321 // T. jump to loop_entry
3322 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003323 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003324 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3325 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3326 // TB:
3327 // statements
3328 // T. jump to loop_entry
3329 // FB:
3330 // what comes after
3331 //
3332 // and
3333 //
3334 // Type existingItem;
3335 // for ( existingItem in expression ) { statements }
3336 //
3337 // becomes:
3338 //
Mike Stump31feda52009-07-17 01:31:16 +00003339 // the same with newVariable replaced with existingItem; the binding works
3340 // the same except that for one ObjCForCollectionStmt::getElement() returns
3341 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003342
Craig Topper25542942014-05-20 04:30:07 +00003343 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003344
Ted Kremenek9d56e642008-11-11 17:10:00 +00003345 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003346 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003347 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003348 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003349 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003350 } else
3351 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003352
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003353 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003354 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003355
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003356 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003357 ExitConditionBlock->setTerminator(S);
3358
3359 // The last statement in the block should be the ObjCForCollectionStmt, which
3360 // performs the actual binding to 'element' and determines if there are any
3361 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003362 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003363 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003364
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003365 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003366 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003367 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003368 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3369 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003370 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003371 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003372 return nullptr;
3373 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003374 }
Mike Stump31feda52009-07-17 01:31:16 +00003375
3376 // The condition block is the implicit successor for the loop body as well as
3377 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003378 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003379
Ted Kremenek9d56e642008-11-11 17:10:00 +00003380 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003381 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003382 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003383 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003384 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003385 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003386
Anna Zaks56b49752013-06-22 00:23:20 +00003387 // Add an intermediate block between the BodyBlock and the
3388 // EntryConditionBlock to represent the "loop back" transition, for looping
3389 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003390 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003391 Succ = LoopBackBlock = createBlock();
3392 LoopBackBlock->setLoopTarget(S);
Fangrui Song6907ce22018-07-30 19:24:48 +00003393
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003394 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003395 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003396
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003397 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003398
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003399 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003400 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003401 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003402 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003403 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003404 }
Mike Stump31feda52009-07-17 01:31:16 +00003405
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003406 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003407 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003408 }
Mike Stump31feda52009-07-17 01:31:16 +00003409
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003410 // Link up the condition block with the code that follows the loop.
3411 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003412 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003413
Ted Kremenek9d56e642008-11-11 17:10:00 +00003414 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003415 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003416 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003417}
3418
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003419CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3420 // Inline the body.
3421 return addStmt(S->getSubStmt());
3422 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3423}
3424
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003425CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003426 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003427
Ted Kremenek49805452009-05-02 01:49:13 +00003428 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003429 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003430
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003431 // The sync body starts its own basic block. This makes it a little easier
3432 // for diagnostic clients.
3433 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003434 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003435 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003436
Craig Topper25542942014-05-20 04:30:07 +00003437 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003438 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003439 }
Mike Stump31feda52009-07-17 01:31:16 +00003440
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003441 // Add the @synchronized to the CFG.
3442 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003443 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003444
Ted Kremenek49805452009-05-02 01:49:13 +00003445 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003446 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003447}
Mike Stump31feda52009-07-17 01:31:16 +00003448
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003449CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003450 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003451 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003452}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003453
John McCallfe96e0b2011-11-06 09:01:30 +00003454CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3455 autoCreateBlock();
3456
3457 // Add the PseudoObject as the last thing.
3458 appendStmt(Block, E);
3459
Fangrui Song6907ce22018-07-30 19:24:48 +00003460 CFGBlock *lastBlock = Block;
John McCallfe96e0b2011-11-06 09:01:30 +00003461
3462 // Before that, evaluate all of the semantics in order. In
3463 // CFG-land, that means appending them in reverse order.
3464 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3465 Expr *Semantic = E->getSemanticExpr(--i);
3466
3467 // If the semantic is an opaque value, we're being asked to bind
3468 // it to its source expression.
3469 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3470 Semantic = OVE->getSourceExpr();
3471
3472 if (CFGBlock *B = Visit(Semantic))
3473 lastBlock = B;
3474 }
3475
3476 return lastBlock;
3477}
3478
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003479CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003480 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003481
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003482 // Save local scope position because in case of condition variable ScopePos
3483 // won't be restored when traversing AST.
3484 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3485
3486 // Create local scope for possible condition variable.
3487 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003488 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003489 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003490 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003491 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003492 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003493 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003494
Mike Stump014b3ea2009-07-21 01:12:51 +00003495 // "while" is a control-flow statement. Thus we stop processing the current
3496 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003497 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003498 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003499 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003500 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003501 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003502 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003503 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003504 }
Mike Stump31feda52009-07-17 01:31:16 +00003505
Craig Topper25542942014-05-20 04:30:07 +00003506 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003507
Ted Kremenek9aae5132007-08-23 21:42:29 +00003508 // Process the loop body.
3509 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003510 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003511
Ted Kremenekb50e7162012-07-14 05:04:10 +00003512 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003513 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3514 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003515 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003516
Mike Stump31feda52009-07-17 01:31:16 +00003517 // Create an empty block to represent the transition block for looping back
3518 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003519 Succ = TransitionBlock = createBlock(false);
3520 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003521 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003522
Ted Kremenek9aae5132007-08-23 21:42:29 +00003523 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003524 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003525
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003526 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003527 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003528
3529 // If body is not a compound statement create implicit scope
3530 // and add destructors.
3531 if (!isa<CompoundStmt>(W->getBody()))
3532 addLocalScopeAndDtors(W->getBody());
3533
Ted Kremenek9aae5132007-08-23 21:42:29 +00003534 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003535 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003536
Ted Kremeneke9610502007-08-30 18:39:40 +00003537 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003538 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003539 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003540 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003541 }
3542
3543 // Because of short-circuit evaluation, the condition of the loop can span
3544 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3545 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003546 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003547
3548 do {
3549 Expr *C = W->getCond();
3550
3551 // Specially handle logical operators, which have a slightly
3552 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003553 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003554 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003555 std::tie(EntryConditionBlock, ExitConditionBlock) =
3556 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003557 break;
3558 }
3559
3560 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003561 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003562 ExitConditionBlock->setTerminator(W);
3563
3564 // Now add the actual condition to the condition block.
3565 // Because the condition itself may contain control-flow, new blocks may
3566 // be created. Thus we update "Succ" after adding the condition.
3567 Block = ExitConditionBlock;
3568 Block = EntryConditionBlock = addStmt(C);
3569
3570 // If this block contains a condition variable, add both the condition
3571 // variable and initializer to the CFG.
3572 if (VarDecl *VD = W->getConditionVariable()) {
3573 if (Expr *Init = VD->getInit()) {
3574 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003575 const DeclStmt *DS = W->getConditionVariableDeclStmt();
3576 assert(DS->isSingleDecl());
3577 findConstructionContexts(
3578 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3579 const_cast<DeclStmt *>(DS)),
3580 Init);
3581 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003582 EntryConditionBlock = addStmt(Init);
3583 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003584 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003585 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003586 }
Mike Stump31feda52009-07-17 01:31:16 +00003587
Ted Kremenekb50e7162012-07-14 05:04:10 +00003588 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003589 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003590
3591 // See if this is a known constant.
3592 const TryResult& KnownVal = tryEvaluateBool(C);
3593
Ted Kremenek30754282009-07-24 04:47:11 +00003594 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003595 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003596 // Link up the condition block with the code that follows the loop. (the
3597 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003598 addSuccessor(ExitConditionBlock,
3599 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003600 } while(false);
3601
3602 // Link up the loop-back block to the entry condition block.
3603 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003604
3605 // There can be no more statements in the condition block since we loop back
3606 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003607 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003608
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003609 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003610 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003611 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003612}
Mike Stump11289f42009-09-09 15:08:12 +00003613
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003614CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003615 // FIXME: For now we pretend that @catch and the code it contains does not
3616 // exit.
3617 return Block;
3618}
Mike Stump31feda52009-07-17 01:31:16 +00003619
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003620CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003621 // FIXME: This isn't complete. We basically treat @throw like a return
3622 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003623
Ted Kremenek0868eea2009-09-24 18:45:41 +00003624 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003625 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003626 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003627
Ted Kremenek93041ba2008-12-09 20:20:09 +00003628 // Create the new block.
3629 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003630
Ted Kremenek93041ba2008-12-09 20:20:09 +00003631 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003632 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003633
3634 // Add the statement to the block. This may create new blocks if S contains
3635 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003636 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003637}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003638
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003639CFGBlock *CFGBuilder::VisitObjCMessageExpr(ObjCMessageExpr *ME,
3640 AddStmtChoice asc) {
3641 findConstructionContextsForArguments(ME);
3642
3643 autoCreateBlock();
Artem Dergacheve1f30622018-07-31 19:46:14 +00003644 appendObjCMessage(Block, ME);
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003645
3646 return VisitChildren(ME);
3647}
3648
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003649CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003650 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003651 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003652 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003653
3654 // Create the new block.
3655 Block = createBlock(false);
3656
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003657 if (TryTerminatedBlock)
3658 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003659 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003660 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003661 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003662 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003663
3664 // Add the statement to the block. This may create new blocks if S contains
3665 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003666 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003667}
3668
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003669CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003670 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003671
Peter Szecsi999a25f2017-08-19 11:19:16 +00003672 addLoopExit(D);
3673
Mike Stump8d50b6a2009-07-21 01:27:50 +00003674 // "do...while" is a control-flow statement. Thus we stop processing the
3675 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003676 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003677 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003678 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003679 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003680 } else
3681 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003682
3683 // Because of short-circuit evaluation, the condition of the loop can span
3684 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3685 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003686 CFGBlock *ExitConditionBlock = createBlock(false);
3687 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003688
Ted Kremenek81e14852007-08-27 19:46:09 +00003689 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003690 ExitConditionBlock->setTerminator(D);
3691
3692 // Now add the actual condition to the condition block. Because the condition
3693 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003694 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003695 Block = ExitConditionBlock;
3696 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003697 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003698 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003699 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003700 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003701 }
Mike Stump31feda52009-07-17 01:31:16 +00003702
Ted Kremeneka1523a32008-02-27 07:20:00 +00003703 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003704 Succ = EntryConditionBlock;
3705
Mike Stump773582d2009-07-23 23:25:26 +00003706 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003707 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003708
Ted Kremenek9aae5132007-08-23 21:42:29 +00003709 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003710 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003711 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003712 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003713
Ted Kremenek9aae5132007-08-23 21:42:29 +00003714 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003715 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3716 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3717 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003718
Ted Kremenek9aae5132007-08-23 21:42:29 +00003719 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003720 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003721
Ted Kremenek9aae5132007-08-23 21:42:29 +00003722 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003723 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003724
Ted Kremenek9aae5132007-08-23 21:42:29 +00003725 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003726 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003727
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003728 // If body is not a compound statement create implicit scope
3729 // and add destructors.
3730 if (!isa<CompoundStmt>(D->getBody()))
3731 addLocalScopeAndDtors(D->getBody());
3732
Ted Kremenek9aae5132007-08-23 21:42:29 +00003733 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003734 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003735
Ted Kremeneke9610502007-08-30 18:39:40 +00003736 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003737 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003738 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003739 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003740 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003741 }
Mike Stump31feda52009-07-17 01:31:16 +00003742
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003743 // Add an intermediate block between the BodyBlock and the
3744 // ExitConditionBlock to represent the "loop back" transition. Create an
3745 // empty block to represent the transition block for looping back to the
3746 // head of the loop.
3747 // FIXME: Can we do this more efficiently without adding another block?
3748 Block = nullptr;
3749 Succ = BodyBlock;
3750 CFGBlock *LoopBackBlock = createBlock();
3751 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003752
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003753 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003754 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003755 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003756 else
Craig Topper25542942014-05-20 04:30:07 +00003757 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003758 }
Mike Stump31feda52009-07-17 01:31:16 +00003759
Ted Kremenek30754282009-07-24 04:47:11 +00003760 // Link up the condition block with the code that follows the loop.
3761 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003762 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003763
3764 // There can be no more statements in the body block(s) since we loop back to
3765 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003766 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003767
Ted Kremenek9aae5132007-08-23 21:42:29 +00003768 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003769 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003770 return BodyBlock;
3771}
3772
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003773CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003774 // "continue" is a control-flow statement. Thus we stop processing the
3775 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003776 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003777 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003778
Ted Kremenek9aae5132007-08-23 21:42:29 +00003779 // Now create a new block that ends with the continue statement.
3780 Block = createBlock(false);
3781 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003782
Ted Kremenek9aae5132007-08-23 21:42:29 +00003783 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003784 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003785 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003786 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003787 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003788 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003789 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003790
Ted Kremenek9aae5132007-08-23 21:42:29 +00003791 return Block;
3792}
Mike Stump11289f42009-09-09 15:08:12 +00003793
Peter Collingbournee190dee2011-03-11 19:24:49 +00003794CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3795 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003796 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003797 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003798 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003799 }
Mike Stump11289f42009-09-09 15:08:12 +00003800
Ted Kremenek93668002009-07-17 22:18:43 +00003801 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003802 CFGBlock *lastBlock = Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00003803
Ted Kremenek93668002009-07-17 22:18:43 +00003804 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003805 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003806 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003807 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003808 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003809 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003810}
Mike Stump11289f42009-09-09 15:08:12 +00003811
Ted Kremenek93668002009-07-17 22:18:43 +00003812/// VisitStmtExpr - Utility method to handle (nested) statement
3813/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003814CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003815 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003816 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003817 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003818 }
Ted Kremenek93668002009-07-17 22:18:43 +00003819 return VisitCompoundStmt(SE->getSubStmt());
3820}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003821
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003822CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003823 // "switch" is a control-flow statement. Thus we stop processing the current
3824 // block.
Craig Topper25542942014-05-20 04:30:07 +00003825 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003826
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003827 // Save local scope position because in case of condition variable ScopePos
3828 // won't be restored when traversing AST.
3829 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3830
Richard Smitha547eb22016-07-14 00:11:03 +00003831 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003832 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003833 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003834
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003835 // Create local scope for possible condition variable.
3836 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003837 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003838 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003839
Matthias Gehre351c2182017-07-12 07:04:19 +00003840 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003841
Ted Kremenek9aae5132007-08-23 21:42:29 +00003842 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003843 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003844 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003845 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003846 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003847
3848 // Save the current "switch" context.
3849 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003850 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003851 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003852
Mike Stump31feda52009-07-17 01:31:16 +00003853 // Set the "default" case to be the block after the switch statement. If the
3854 // switch statement contains a "default:", this value will be overwritten with
3855 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003856 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003857
Ted Kremenek9aae5132007-08-23 21:42:29 +00003858 // Create a new block that will contain the switch statement.
3859 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003860
Ted Kremenek9aae5132007-08-23 21:42:29 +00003861 // Now process the switch body. The code after the switch is the implicit
3862 // successor.
3863 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003864 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003865
3866 // When visiting the body, the case statements should automatically get linked
3867 // up to the switch. We also don't keep a pointer to the body, since all
3868 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003869 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003870 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003871
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003872 // For pruning unreachable case statements, save the current state
3873 // for tracking the condition value.
3874 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3875 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003876
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003877 // Determine if the switch condition can be explicitly evaluated.
3878 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003879 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003880 bool b = tryEvaluate(Terminator->getCond(), result);
3881 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003882 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003883
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003884 // If body is not a compound statement create implicit scope
3885 // and add destructors.
3886 if (!isa<CompoundStmt>(Terminator->getBody()))
3887 addLocalScopeAndDtors(Terminator->getBody());
3888
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003889 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003890 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003891 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003892 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003893 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003894
Mike Stump31feda52009-07-17 01:31:16 +00003895 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003896 // following the switch body. Moreover, take into account if all the
3897 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003898 //
3899 // Note: We add a successor to a switch that is considered covered yet has no
3900 // case statements if the enumeration has no enumerators.
3901 bool SwitchAlwaysHasSuccessor = false;
3902 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3903 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3904 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003905 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3906 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003907
Ted Kremenek81e14852007-08-27 19:46:09 +00003908 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003909 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003910 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003911 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003912
Richard Smitha547eb22016-07-14 00:11:03 +00003913 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003914 // SwitchStmt and the condition variable initialization to the CFG.
3915 if (VarDecl *VD = Terminator->getConditionVariable()) {
3916 if (Expr *Init = VD->getInit()) {
3917 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003918 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003919 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003920 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003921 }
3922 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003923
Richard Smitha547eb22016-07-14 00:11:03 +00003924 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3925 if (Stmt *Init = Terminator->getInit()) {
3926 autoCreateBlock();
3927 LastBlock = addStmt(Init);
3928 }
3929
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003930 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003931}
Fangrui Song6907ce22018-07-30 19:24:48 +00003932
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003933static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003934 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003935 const CaseStmt *CS,
3936 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003937 if (!switchCond)
3938 return true;
3939
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003940 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003941
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003942 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003943 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003944 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003945 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003946 const llvm::APSInt &condInt = switchCond->Val.getInt();
Fangrui Song6907ce22018-07-30 19:24:48 +00003947
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003948 if (condInt == lhsInt) {
3949 addCase = true;
3950 switchExclusivelyCovered = true;
3951 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003952 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003953 if (const Expr *RHS = CS->getRHS()) {
3954 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003955 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003956 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003957 addCase = true;
3958 switchExclusivelyCovered = true;
3959 }
3960 }
3961 }
3962 }
3963 else
3964 addCase = true;
3965 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003966 return addCase;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003967}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003968
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003969CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003970 // CaseStmts are essentially labels, so they are the first statement in a
3971 // block.
Craig Topper25542942014-05-20 04:30:07 +00003972 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003973
Ted Kremenek60fa6572010-08-04 23:54:30 +00003974 if (Stmt *Sub = CS->getSubStmt()) {
3975 // For deeply nested chains of CaseStmts, instead of doing a recursion
3976 // (which can blow out the stack), manually unroll and create blocks
3977 // along the way.
3978 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003979 CFGBlock *currentBlock = createBlock(false);
3980 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003981
Ted Kremenek60fa6572010-08-04 23:54:30 +00003982 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003983 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003984 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003985 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003986
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003987 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003988 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003989 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003990 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003991
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003992 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003993 CS = cast<CaseStmt>(Sub);
3994 Sub = CS->getSubStmt();
3995 }
3996
3997 addStmt(Sub);
3998 }
Mike Stump11289f42009-09-09 15:08:12 +00003999
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004000 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004001 if (!CaseBlock)
4002 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004003
4004 // Cases statements partition blocks, so this is the top of the basic block we
4005 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00004006 CaseBlock->setLabel(CS);
4007
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004008 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004009 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004010
4011 // Add this block to the list of successors for the block with the switch
4012 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00004013 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004014 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00004015 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004016 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00004017
Ted Kremenek9aae5132007-08-23 21:42:29 +00004018 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004019 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004020
Ted Kremenek60fa6572010-08-04 23:54:30 +00004021 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004022 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004023 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004024 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00004025 // This block is now the implicit successor of other blocks.
4026 Succ = CaseBlock;
4027 }
Mike Stump31feda52009-07-17 01:31:16 +00004028
Ted Kremenek60fa6572010-08-04 23:54:30 +00004029 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00004030}
Mike Stump31feda52009-07-17 01:31:16 +00004031
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004032CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00004033 if (Terminator->getSubStmt())
4034 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00004035
Ted Kremenek654c78f2008-02-13 22:05:39 +00004036 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004037
4038 if (!DefaultCaseBlock)
4039 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004040
4041 // Default statements partition blocks, so this is the top of the basic block
4042 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004043 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00004044
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004045 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004046 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00004047
Mike Stump31feda52009-07-17 01:31:16 +00004048 // Unlike case statements, we don't add the default block to the successors
4049 // for the switch statement immediately. This is done when we finish
4050 // processing the switch statement. This allows for the default case
4051 // (including a fall-through to the code after the switch statement) to always
4052 // be the last successor of a switch-terminated block.
4053
Ted Kremenek654c78f2008-02-13 22:05:39 +00004054 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004055 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004056
Ted Kremenek654c78f2008-02-13 22:05:39 +00004057 // This block is now the implicit successor of other blocks.
4058 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00004059
4060 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00004061}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004062
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004063CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
4064 // "try"/"catch" is a control-flow statement. Thus we stop processing the
4065 // current block.
Craig Topper25542942014-05-20 04:30:07 +00004066 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004067
4068 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004069 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004070 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004071 TrySuccessor = Block;
4072 } else TrySuccessor = Succ;
4073
Mike Stump0bdba6c2010-01-20 01:15:34 +00004074 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004075
4076 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00004077 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004078 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00004079 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004080
Mike Stump0bdba6c2010-01-20 01:15:34 +00004081 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004082 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
4083 // The code after the try is the implicit successor.
4084 Succ = TrySuccessor;
4085 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00004086 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00004087 HasCatchAll = true;
4088 }
Craig Topper25542942014-05-20 04:30:07 +00004089 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004090 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00004091 if (!CatchBlock)
4092 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004093 // Add this block to the list of successors for the block with the try
4094 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004095 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004096 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00004097 if (!HasCatchAll) {
4098 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004099 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00004100 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004101 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00004102 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004103
4104 // The code after the try is the implicit successor.
4105 Succ = TrySuccessor;
4106
Mike Stump845384a2010-01-20 01:30:58 +00004107 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00004108 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
4109 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00004110
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004111 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004112 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004113 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004114}
4115
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004116CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004117 // CXXCatchStmt are treated like labels, so they are the first statement in a
4118 // block.
4119
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004120 // Save local scope position because in case of exception variable ScopePos
4121 // won't be restored when traversing AST.
4122 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4123
4124 // Create local scope for possible exception variable.
4125 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004126 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004127 LocalScope::const_iterator BeginScopePos = ScopePos;
4128 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004129 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004130 }
4131
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004132 if (CS->getHandlerBlock())
4133 addStmt(CS->getHandlerBlock());
4134
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004135 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004136 if (!CatchBlock)
4137 CatchBlock = createBlock();
Fangrui Song6907ce22018-07-30 19:24:48 +00004138
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004139 // CXXCatchStmt is more than just a label. They have semantic meaning
4140 // as well, as they implicitly "initialize" the catch variable. Add
4141 // it to the CFG as a CFGElement so that the control-flow of these
4142 // semantics gets captured.
4143 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004144
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004145 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4146 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004147 CatchBlock->setLabel(CS);
4148
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004149 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004150 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004151 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004152
4153 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004154 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004155
4156 return CatchBlock;
4157}
4158
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004159CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004160 // C++0x for-range statements are specified as [stmt.ranged]:
4161 //
4162 // {
4163 // auto && __range = range-init;
4164 // for ( auto __begin = begin-expr,
4165 // __end = end-expr;
4166 // __begin != __end;
4167 // ++__begin ) {
4168 // for-range-declaration = *__begin;
4169 // statement
4170 // }
4171 // }
4172
4173 // Save local scope position before the addition of the implicit variables.
4174 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4175
4176 // Create local scopes and destructors for range, begin and end variables.
4177 if (Stmt *Range = S->getRangeStmt())
4178 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004179 if (Stmt *Begin = S->getBeginStmt())
4180 addLocalScopeForStmt(Begin);
4181 if (Stmt *End = S->getEndStmt())
4182 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004183 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004184
4185 LocalScope::const_iterator ContinueScopePos = ScopePos;
4186
4187 // "for" is a control-flow statement. Thus we stop processing the current
4188 // block.
Craig Topper25542942014-05-20 04:30:07 +00004189 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004190 if (Block) {
4191 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004192 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004193 LoopSuccessor = Block;
4194 } else
4195 LoopSuccessor = Succ;
4196
4197 // Save the current value for the break targets.
4198 // All breaks should go to the code following the loop.
4199 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4200 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4201
4202 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004203 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004204 ConditionBlock->setTerminator(S);
4205
4206 // Now add the actual condition to the condition block.
4207 if (Expr *C = S->getCond()) {
4208 Block = ConditionBlock;
4209 CFGBlock *BeginConditionBlock = addStmt(C);
4210 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004211 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004212 assert(BeginConditionBlock == ConditionBlock &&
4213 "condition block in for-range was unexpectedly complex");
4214 (void)BeginConditionBlock;
4215 }
4216
4217 // The condition block is the implicit successor for the loop body as well as
4218 // any code above the loop.
4219 Succ = ConditionBlock;
4220
4221 // See if this is a known constant.
4222 TryResult KnownVal(true);
4223
4224 if (S->getCond())
4225 KnownVal = tryEvaluateBool(S->getCond());
4226
4227 // Now create the loop body.
4228 {
4229 assert(S->getBody());
4230
4231 // Save the current values for Block, Succ, and continue targets.
4232 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4233 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4234
4235 // Generate increment code in its own basic block. This is the target of
4236 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004237 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004238 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004239 if (badCFG)
4240 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004241 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4242
4243 // The starting block for the loop increment is the block that should
4244 // represent the 'loop target' for looping back to the start of the loop.
4245 ContinueJumpTarget.block->setLoopTarget(S);
4246
4247 // Finish up the increment block and prepare to start the loop body.
4248 assert(Block);
4249 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004250 return nullptr;
4251 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004252
4253 // Add implicit scope and dtors for loop variable.
4254 addLocalScopeAndDtors(S->getLoopVarStmt());
4255
4256 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004257 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004258 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004259 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004260 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004261 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004262 return nullptr;
4263
Richard Smith02e85f32011-04-14 22:09:26 +00004264 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004265 addSuccessor(ConditionBlock,
4266 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004267 }
4268
4269 // Link up the condition block with the code that follows the loop (the
4270 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004271 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004272
4273 // Add the initialization statements.
4274 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004275 addStmt(S->getBeginStmt());
4276 addStmt(S->getEndStmt());
Richard Smith8baa5002018-09-28 18:44:09 +00004277 CFGBlock *Head = addStmt(S->getRangeStmt());
4278 if (S->getInit())
4279 Head = addStmt(S->getInit());
4280 return Head;
Richard Smith02e85f32011-04-14 22:09:26 +00004281}
4282
John McCall5d413782010-12-06 08:20:24 +00004283CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004284 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004285 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004286 // If adding implicit destructors visit the full expression for adding
4287 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004288 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004289 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004290
4291 // Full expression has to be added as CFGStmt so it will be sequenced
4292 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004293 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004294 }
4295 return Visit(E->getSubExpr(), asc);
4296}
4297
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004298CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4299 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004300 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004301 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004302 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004303
Artem Dergachev783a4572018-02-23 22:20:39 +00004304 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004305 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004306 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004307
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004308 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004309 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004310 }
4311 return Visit(E->getSubExpr(), asc);
4312}
4313
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004314CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4315 AddStmtChoice asc) {
Artem Dergachevbd880fe2018-07-31 19:39:37 +00004316 // If the constructor takes objects as arguments by value, we need to properly
4317 // construct these objects. Construction contexts we find here aren't for the
4318 // constructor C, they're for its arguments only.
4319 findConstructionContextsForArguments(C);
4320
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004321 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004322 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004323
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004324 return VisitChildren(C);
4325}
4326
Jordan Rosec9176072014-01-13 17:59:19 +00004327CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4328 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004329 autoCreateBlock();
4330 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004331
Artem Dergachev783a4572018-02-23 22:20:39 +00004332 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004333 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004334 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004335
Jordan Rosec9176072014-01-13 17:59:19 +00004336 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004337 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004338
Jordan Rosec9176072014-01-13 17:59:19 +00004339 if (BuildOpts.AddCXXNewAllocator)
4340 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004341
Jordan Rosec9176072014-01-13 17:59:19 +00004342 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004343 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004344
Jordan Rosec9176072014-01-13 17:59:19 +00004345 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4346 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004347 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004348
Jordan Rosec9176072014-01-13 17:59:19 +00004349 return Block;
4350}
Jordan Rosed2f40792013-09-03 17:00:57 +00004351
4352CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4353 AddStmtChoice asc) {
4354 autoCreateBlock();
4355 appendStmt(Block, DE);
4356 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004357 if (!DTy.isNull()) {
4358 DTy = DTy.getNonReferenceType();
4359 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4360 if (RD) {
4361 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4362 appendDeleteDtor(Block, RD, DE);
4363 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004364 }
4365
4366 return VisitChildren(DE);
4367}
4368
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004369CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4370 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004371 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004372 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004373 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004374 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004375 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004376 }
4377 return Visit(E->getSubExpr(), asc);
4378}
4379
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004380CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4381 AddStmtChoice asc) {
Artem Dergachevc531d542018-08-14 21:10:46 +00004382 // If the constructor takes objects as arguments by value, we need to properly
4383 // construct these objects. Construction contexts we find here aren't for the
4384 // constructor C, they're for its arguments only.
4385 findConstructionContextsForArguments(C);
4386
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004387 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004388 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004389 return VisitChildren(C);
4390}
4391
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004392CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4393 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004394 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004395 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004396 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004397 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004398 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004399}
4400
Bill Wendling8003edc2018-11-09 00:41:36 +00004401CFGBlock *CFGBuilder::VisitConstantExpr(ConstantExpr *E, AddStmtChoice asc) {
4402 return Visit(E->getSubExpr(), AddStmtChoice());
4403}
4404
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004405CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004406 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004407 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004408
Ted Kremenekeda180e22007-08-28 19:26:49 +00004409 if (!IBlock) {
4410 IBlock = createBlock(false);
4411 cfg->setIndirectGotoBlock(IBlock);
4412 }
Mike Stump31feda52009-07-17 01:31:16 +00004413
Ted Kremenekeda180e22007-08-28 19:26:49 +00004414 // IndirectGoto is a control-flow statement. Thus we stop processing the
4415 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004416 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004417 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004418
Ted Kremenekeda180e22007-08-28 19:26:49 +00004419 Block = createBlock(false);
4420 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004421 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004422 return addStmt(I->getTarget());
4423}
4424
Manuel Klimekb5616c92014-08-07 10:42:17 +00004425CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4426 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004427 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4428
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004429tryAgain:
4430 if (!E) {
4431 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004432 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004433 }
4434 switch (E->getStmtClass()) {
4435 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004436 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004437
4438 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004439 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4440 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004441
4442 case Stmt::CXXBindTemporaryExprClass:
4443 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004444 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004445
John McCallc07a0c72011-02-17 10:25:35 +00004446 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004447 case Stmt::ConditionalOperatorClass:
4448 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004449 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004450
4451 case Stmt::ImplicitCastExprClass:
4452 // For implicit cast we want BindToTemporary to be passed further.
4453 E = cast<CastExpr>(E)->getSubExpr();
4454 goto tryAgain;
4455
Manuel Klimekb0042c42014-07-30 08:34:42 +00004456 case Stmt::CXXFunctionalCastExprClass:
4457 // For functional cast we want BindToTemporary to be passed further.
4458 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4459 goto tryAgain;
4460
Bill Wendling8003edc2018-11-09 00:41:36 +00004461 case Stmt::ConstantExprClass:
4462 E = cast<ConstantExpr>(E)->getSubExpr();
4463 goto tryAgain;
4464
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004465 case Stmt::ParenExprClass:
4466 E = cast<ParenExpr>(E)->getSubExpr();
4467 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004468
Manuel Klimekb0042c42014-07-30 08:34:42 +00004469 case Stmt::MaterializeTemporaryExprClass: {
4470 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4471 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4472 SmallVector<const Expr *, 2> CommaLHSs;
4473 SmallVector<SubobjectAdjustment, 2> Adjustments;
4474 // Find the expression whose lifetime needs to be extended.
4475 E = const_cast<Expr *>(
4476 cast<MaterializeTemporaryExpr>(E)
4477 ->GetTemporaryExpr()
4478 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4479 // Visit the skipped comma operator left-hand sides for other temporaries.
4480 for (const Expr *CommaLHS : CommaLHSs) {
4481 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004482 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004483 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004484 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004485 }
Richard Smith4137af22014-07-27 05:12:49 +00004486
4487 case Stmt::BlockExprClass:
4488 // Don't recurse into blocks; their subexpressions don't get evaluated
4489 // here.
4490 return Block;
4491
4492 case Stmt::LambdaExprClass: {
4493 // For lambda expressions, only recurse into the capture initializers,
4494 // and not the body.
4495 auto *LE = cast<LambdaExpr>(E);
4496 CFGBlock *B = Block;
4497 for (Expr *Init : LE->capture_inits()) {
Richard Smith7ed5fb22018-07-27 17:13:18 +00004498 if (Init) {
4499 if (CFGBlock *R = VisitForTemporaryDtors(
4500 Init, /*BindToTemporary=*/false, Context))
4501 B = R;
4502 }
Richard Smith4137af22014-07-27 05:12:49 +00004503 }
4504 return B;
4505 }
4506
4507 case Stmt::CXXDefaultArgExprClass:
4508 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4509 goto tryAgain;
4510
4511 case Stmt::CXXDefaultInitExprClass:
4512 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4513 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004514 }
4515}
4516
Manuel Klimekb5616c92014-08-07 10:42:17 +00004517CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4518 TempDtorContext &Context) {
4519 if (isa<LambdaExpr>(E)) {
4520 // Do not visit the children of lambdas; they have their own CFGs.
4521 return Block;
4522 }
4523
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004524 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004525 // order that they will appear in the CFG. Because the CFG is built
4526 // bottom-up, this means we visit them in their natural order, which
4527 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004528 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004529 for (Stmt *Child : E->children())
4530 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004531 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004532 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004533
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004534 return B;
4535}
4536
Manuel Klimekb5616c92014-08-07 10:42:17 +00004537CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4538 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004539 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004540 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004541 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4542 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4543 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004544
Manuel Klimekedf925b92014-08-07 18:44:19 +00004545 // We do not know at CFG-construction time whether the right-hand-side was
4546 // executed, thus we add a branch node that depends on the temporary
4547 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004548 TempDtorContext RHSContext(
4549 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004550 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004551 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004552
Manuel Klimekb5616c92014-08-07 10:42:17 +00004553 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004554 }
4555
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004556 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004557 // For assignment operator (=) LHS expression is visited
4558 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004559 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4560 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004561 return LHSBlock ? LHSBlock : RHSBlock;
4562 }
4563
4564 // For any other binary operator RHS expression is visited before
4565 // LHS expression (order of children). For destructors visit them in reverse
4566 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004567 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4568 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004569 return RHSBlock ? RHSBlock : LHSBlock;
4570}
4571
4572CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004573 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004574 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004575 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004576 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004577 // If lifetime of temporary is not prolonged (by assigning to constant
4578 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004579
Chandler Carruthad747252011-09-13 06:09:01 +00004580 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004581
Richard Trieu95a192a2015-05-28 00:14:02 +00004582 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004583 // If the destructor is marked as a no-return destructor, we need to
4584 // create a new block for the destructor which does not have as a
4585 // successor anything built thus far. Control won't flow out of this
4586 // block.
4587 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004588 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004589 } else if (Context.needsTempDtorBranch()) {
4590 // If we need to introduce a branch, we add a new block that we will hook
4591 // up to a decision block later.
4592 if (B) Succ = B;
4593 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004594 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004595 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004596 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004597 if (Context.needsTempDtorBranch()) {
4598 Context.setDecisionPoint(Succ, E);
4599 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004600 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004601
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004602 B = Block;
4603 }
4604 return B;
4605}
4606
Manuel Klimekb5616c92014-08-07 10:42:17 +00004607void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4608 CFGBlock *FalseSucc) {
4609 if (!Context.TerminatorExpr) {
4610 // If no temporary was found, we do not need to insert a decision point.
4611 return;
4612 }
4613 assert(Context.TerminatorExpr);
4614 CFGBlock *Decision = createBlock(false);
4615 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004616 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004617 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004618 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004619 Block = Decision;
4620}
4621
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004622CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004623 AbstractConditionalOperator *E, bool BindToTemporary,
4624 TempDtorContext &Context) {
4625 VisitForTemporaryDtors(E->getCond(), false, Context);
4626 CFGBlock *ConditionBlock = Block;
4627 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004628 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004629 TryResult NegatedVal = ConditionVal;
4630 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004631
Manuel Klimekdeb02622014-08-08 07:37:13 +00004632 TempDtorContext TrueContext(
4633 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004634 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004635 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004636
Manuel Klimekb5616c92014-08-07 10:42:17 +00004637 Block = ConditionBlock;
4638 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004639 TempDtorContext FalseContext(
4640 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004641 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004642
Manuel Klimekb5616c92014-08-07 10:42:17 +00004643 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004644 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004645 } else if (TrueContext.TerminatorExpr) {
4646 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004647 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004648 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004649 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004650 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004651 return Block;
4652}
4653
Mike Stump31feda52009-07-17 01:31:16 +00004654/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4655/// no successors or predecessors. If this is the first block created in the
4656/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004657CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004658 bool first_block = begin() == end();
4659
4660 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004661 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004662 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004663 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004664
4665 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004666 if (first_block)
4667 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004668
4669 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004670 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004671}
4672
David Blaikiee90195c2014-08-29 18:53:26 +00004673/// buildCFG - Constructs a CFG from an AST.
4674std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4675 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004676 CFGBuilder Builder(C, BO);
4677 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004678}
4679
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004680const CXXDestructorDecl *
4681CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004682 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004683 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004684 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004685 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004686 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004687 case CFGElement::Statement:
4688 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004689 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004690 case CFGElement::ScopeBegin:
4691 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004692 llvm_unreachable("getDestructorDecl should only be used with "
4693 "ImplicitDtors");
4694 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004695 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004696 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004697
4698 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4699 //
4700 // Lifetime-extending constructs are handled here. This works for a single
4701 // temporary in an initializer expression.
4702 if (ty->isReferenceType()) {
4703 if (const Expr *Init = var->getInit()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00004704 ty = getReferenceInitTemporaryType(Init);
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004705 }
4706 }
4707
Ted Kremeneke7d78882012-03-19 23:48:41 +00004708 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004709 ty = arrayType->getElementType();
4710 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004711 const RecordType *recordType = ty->getAs<RecordType>();
4712 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004713 cast<CXXRecordDecl>(recordType->getDecl());
Fangrui Song6907ce22018-07-30 19:24:48 +00004714 return classDecl->getDestructor();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004715 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004716 case CFGElement::DeleteDtor: {
4717 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4718 QualType DTy = DE->getDestroyedType();
4719 DTy = DTy.getNonReferenceType();
4720 const CXXRecordDecl *classDecl =
4721 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4722 return classDecl->getDestructor();
4723 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004724 case CFGElement::TemporaryDtor: {
4725 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004726 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004727 const CXXTemporary *temp = bindExpr->getTemporary();
4728 return temp->getDestructor();
4729 }
4730 case CFGElement::BaseDtor:
4731 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004732 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004733 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004734 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004735 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004736}
4737
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004738bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004739 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4740 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004741 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004742}
4743
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004744//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004745// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004746//===----------------------------------------------------------------------===//
4747
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004748CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004749 : ReachableBlock(IsReachable ? B : nullptr),
4750 UnreachableBlock(!IsReachable ? B : nullptr,
4751 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004752
4753CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004754 : ReachableBlock(B),
4755 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4756 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004757
4758void CFGBlock::addSuccessor(AdjacentBlock Succ,
4759 BumpVectorContext &C) {
4760 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004761 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004762
4763 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004764 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004765
4766 Succs.push_back(Succ, C);
4767}
4768
Ted Kremenekb0371852010-09-09 00:06:04 +00004769bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004770 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004771 if (F.IgnoreNullPredecessors && !From)
4772 return true;
4773
4774 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004775 // If the 'To' has no label or is labeled but the label isn't a
4776 // CaseStmt then filter this edge.
4777 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004778 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004779 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004780 const Stmt *L = To->getLabel();
4781 if (!L || !isa<CaseStmt>(L))
4782 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004783 }
4784 }
4785 }
4786
4787 return false;
4788}
4789
4790//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004791// CFG pretty printing
4792//===----------------------------------------------------------------------===//
4793
Ted Kremenek7e776b12007-08-22 18:22:34 +00004794namespace {
4795
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004796class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004797 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4798 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4799
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004800 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004801 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004802 signed currentBlock = 0;
4803 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004804 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004805
Eugene Zelenko38c70522017-12-07 21:55:09 +00004806public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004807 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004808 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004809 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4810 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004811 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Fangrui Song6907ce22018-07-30 19:24:48 +00004812 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004813 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4814 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004815 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004816 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004817
Ted Kremenek96a7a592011-03-01 03:15:10 +00004818 switch (stmt->getStmtClass()) {
4819 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004820 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4821 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004822 case Stmt::IfStmtClass: {
4823 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4824 if (var)
4825 DeclMap[var] = P;
4826 break;
4827 }
4828 case Stmt::ForStmtClass: {
4829 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4830 if (var)
4831 DeclMap[var] = P;
4832 break;
4833 }
4834 case Stmt::WhileStmtClass: {
4835 const VarDecl *var =
4836 cast<WhileStmt>(stmt)->getConditionVariable();
4837 if (var)
4838 DeclMap[var] = P;
4839 break;
4840 }
4841 case Stmt::SwitchStmtClass: {
4842 const VarDecl *var =
4843 cast<SwitchStmt>(stmt)->getConditionVariable();
4844 if (var)
4845 DeclMap[var] = P;
4846 break;
4847 }
4848 case Stmt::CXXCatchStmtClass: {
4849 const VarDecl *var =
4850 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4851 if (var)
4852 DeclMap[var] = P;
4853 break;
4854 }
4855 default:
4856 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004857 }
4858 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004859 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004860 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004861 }
Mike Stump31feda52009-07-17 01:31:16 +00004862
Eugene Zelenko38c70522017-12-07 21:55:09 +00004863 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004864
Chris Lattnerc61089a2009-06-30 01:26:17 +00004865 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004866 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004867 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004868
Craig Topperb45acb82014-03-14 06:02:07 +00004869 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004870 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004871
4872 if (I == StmtMap.end())
4873 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004874
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004875 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004876 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004877 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004878 }
Mike Stump31feda52009-07-17 01:31:16 +00004879
Ted Kremenek60983dc2010-01-19 20:52:05 +00004880 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004881 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004882 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004883
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004884 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004885 DeclMapTy::iterator I = DeclMap.find(D);
4886
4887 if (I == DeclMap.end())
4888 return false;
4889
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004890 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004891 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004892 return false;
4893 }
4894
4895 OS << "[B" << I->second.first << "." << I->second.second << "]";
4896 return true;
4897 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004898};
4899
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004900class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004901 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004902 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004903 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004904 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004905
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004906public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004907 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004908 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004909 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004910 this->Policy.IncludeNewlines = false;
4911 }
Mike Stump31feda52009-07-17 01:31:16 +00004912
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004913 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004914 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004915 if (Stmt *C = I->getCond())
4916 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004917 }
Mike Stump31feda52009-07-17 01:31:16 +00004918
Ted Kremenek9aae5132007-08-23 21:42:29 +00004919 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004920 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004921 Terminator->printPretty(OS, Helper, Policy);
4922 }
4923
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004924 void VisitDeclStmt(DeclStmt *DS) {
4925 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4926 OS << "static init " << VD->getName();
4927 }
4928
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004929 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004930 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004931 if (F->getInit())
4932 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004933 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004934 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004935 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004936 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004937 if (F->getInc())
4938 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004939 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004940 }
Mike Stump31feda52009-07-17 01:31:16 +00004941
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004942 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004943 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004944 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004945 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004946 }
Mike Stump31feda52009-07-17 01:31:16 +00004947
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004948 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004949 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004950 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004951 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004952 }
Mike Stump31feda52009-07-17 01:31:16 +00004953
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004954 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004955 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004956 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004957 }
Mike Stump31feda52009-07-17 01:31:16 +00004958
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004959 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004960 OS << "try ...";
4961 }
4962
Nico Weber699670e2017-08-23 15:33:16 +00004963 void VisitSEHTryStmt(SEHTryStmt *CS) {
4964 OS << "__try ...";
4965 }
4966
John McCallc07a0c72011-02-17 10:25:35 +00004967 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004968 if (Stmt *Cond = C->getCond())
4969 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004970 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004971 }
Mike Stump31feda52009-07-17 01:31:16 +00004972
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004973 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004974 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004975 if (Stmt *Cond = C->getCond())
4976 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004977 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004978 }
Mike Stump31feda52009-07-17 01:31:16 +00004979
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004980 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004981 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004982 if (Stmt *T = I->getTarget())
4983 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004984 }
Mike Stump31feda52009-07-17 01:31:16 +00004985
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004986 void VisitBinaryOperator(BinaryOperator* B) {
4987 if (!B->isLogicalOp()) {
4988 VisitExpr(B);
4989 return;
4990 }
Mike Stump31feda52009-07-17 01:31:16 +00004991
Richard Trieuddd01ce2014-06-09 22:53:25 +00004992 if (B->getLHS())
4993 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004994
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004995 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004996 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004997 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004998 return;
John McCalle3027922010-08-25 11:45:40 +00004999 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00005000 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005001 return;
5002 default:
David Blaikie83d382b2011-09-23 05:06:16 +00005003 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00005004 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005005 }
Mike Stump31feda52009-07-17 01:31:16 +00005006
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005007 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00005008 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005009 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00005010
5011public:
5012 void print(CFGTerminator T) {
5013 if (T.isTemporaryDtorsBranch())
5014 OS << "(Temp Dtor) ";
5015 Visit(T.getStmt());
5016 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00005017};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005018
5019} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00005020
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005021static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
5022 const CXXCtorInitializer *I) {
5023 if (I->isBaseInitializer())
5024 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
5025 else if (I->isDelegatingInitializer())
5026 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
5027 else
5028 OS << I->getAnyMember()->getName();
5029 OS << "(";
5030 if (Expr *IE = I->getInit())
5031 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
5032 OS << ")";
5033
5034 if (I->isBaseInitializer())
5035 OS << " (Base initializer)";
5036 else if (I->isDelegatingInitializer())
5037 OS << " (Delegating initializer)";
5038 else
5039 OS << " (Member initializer)";
5040}
5041
Artem Dergachev1527dec2018-03-12 23:12:40 +00005042static void print_construction_context(raw_ostream &OS,
5043 StmtPrinterHelper &Helper,
5044 const ConstructionContext *CC) {
Artem Dergachevff267df2018-06-28 00:04:54 +00005045 SmallVector<const Stmt *, 3> Stmts;
Artem Dergachev1527dec2018-03-12 23:12:40 +00005046 switch (CC->getKind()) {
Artem Dergachev922455f2018-03-22 22:02:38 +00005047 case ConstructionContext::SimpleConstructorInitializerKind: {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005048 OS << ", ";
Artem Dergachev922455f2018-03-22 22:02:38 +00005049 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC);
5050 print_initializer(OS, Helper, SICC->getCXXCtorInitializer());
Artem Dergacheva657a322018-07-31 20:45:53 +00005051 return;
Artem Dergachev922455f2018-03-22 22:02:38 +00005052 }
5053 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: {
5054 OS << ", ";
5055 const auto *CICC =
5056 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC);
5057 print_initializer(OS, Helper, CICC->getCXXCtorInitializer());
Artem Dergachevff267df2018-06-28 00:04:54 +00005058 Stmts.push_back(CICC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005059 break;
5060 }
5061 case ConstructionContext::SimpleVariableKind: {
Artem Dergachev317291e2018-03-22 21:37:39 +00005062 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005063 Stmts.push_back(SDSCC->getDeclStmt());
Artem Dergachev317291e2018-03-22 21:37:39 +00005064 break;
5065 }
5066 case ConstructionContext::CXX17ElidedCopyVariableKind: {
5067 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005068 Stmts.push_back(CDSCC->getDeclStmt());
5069 Stmts.push_back(CDSCC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005070 break;
5071 }
5072 case ConstructionContext::NewAllocatedObjectKind: {
5073 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005074 Stmts.push_back(NECC->getCXXNewExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005075 break;
5076 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005077 case ConstructionContext::SimpleReturnedValueKind: {
5078 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005079 Stmts.push_back(RSCC->getReturnStmt());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005080 break;
5081 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005082 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: {
5083 const auto *RSCC =
5084 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005085 Stmts.push_back(RSCC->getReturnStmt());
5086 Stmts.push_back(RSCC->getCXXBindTemporaryExpr());
Artem Dergachev317291e2018-03-22 21:37:39 +00005087 break;
5088 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005089 case ConstructionContext::SimpleTemporaryObjectKind: {
5090 const auto *TOCC = cast<SimpleTemporaryObjectConstructionContext>(CC);
5091 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5092 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5093 break;
5094 }
5095 case ConstructionContext::ElidedTemporaryObjectKind: {
5096 const auto *TOCC = cast<ElidedTemporaryObjectConstructionContext>(CC);
5097 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5098 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5099 Stmts.push_back(TOCC->getConstructorAfterElision());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005100 break;
5101 }
Artem Dergacheva657a322018-07-31 20:45:53 +00005102 case ConstructionContext::ArgumentKind: {
5103 const auto *ACC = cast<ArgumentConstructionContext>(CC);
5104 if (const Stmt *BTE = ACC->getCXXBindTemporaryExpr()) {
5105 OS << ", ";
5106 Helper.handledStmt(const_cast<Stmt *>(BTE), OS);
5107 }
5108 OS << ", ";
5109 Helper.handledStmt(const_cast<Expr *>(ACC->getCallLikeExpr()), OS);
5110 OS << "+" << ACC->getIndex();
5111 return;
5112 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005113 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005114 for (auto I: Stmts)
5115 if (I) {
5116 OS << ", ";
5117 Helper.handledStmt(const_cast<Stmt *>(I), OS);
5118 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005119}
5120
Aaron Ballmanff924b02013-11-18 20:11:50 +00005121static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00005122 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00005123 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
5124 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00005125 assert(S != nullptr && "Expecting non-null Stmt");
5126
Aaron Ballmanff924b02013-11-18 20:11:50 +00005127 // special printing for statement-expressions.
5128 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
5129 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00005130
Benjamin Kramer5733e352015-07-18 17:09:36 +00005131 auto Children = Sub->children();
5132 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005133 OS << "({ ... ; ";
5134 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
5135 OS << " })\n";
5136 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005137 }
5138 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00005139 // special printing for comma expressions.
5140 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
5141 if (B->getOpcode() == BO_Comma) {
5142 OS << "... , ";
5143 Helper.handledStmt(B->getRHS(),OS);
5144 OS << '\n';
5145 return;
5146 }
5147 }
5148 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00005149
Artem Dergachev1527dec2018-03-12 23:12:40 +00005150 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
5151 if (isa<CXXOperatorCallExpr>(S))
5152 OS << " (OperatorCall)";
5153 OS << " (CXXRecordTypedCall";
5154 print_construction_context(OS, Helper, VTC->getConstructionContext());
5155 OS << ")";
5156 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005157 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005158 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005159 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005160 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005161 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005162 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005163 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00005164 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005165 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005166 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00005167 OS << " (" << CE->getStmtClassName() << ", "
5168 << CE->getCastKindName()
5169 << ", " << CE->getType().getAsString()
5170 << ")";
5171 }
Mike Stump31feda52009-07-17 01:31:16 +00005172
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005173 // Expressions need a newline.
5174 if (isa<Expr>(S))
5175 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005176 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005177 print_initializer(OS, Helper, IE->getInitializer());
5178 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005179 } else if (Optional<CFGAutomaticObjDtor> DE =
5180 E.getAs<CFGAutomaticObjDtor>()) {
5181 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005182 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005183
Artem Dergacheva25809f2018-06-04 18:56:25 +00005184 ASTContext &ACtx = VD->getASTContext();
5185 QualType T = VD->getType();
5186 if (T->isReferenceType())
5187 T = getReferenceInitTemporaryType(VD->getInit(), nullptr);
5188 if (const ArrayType *AT = ACtx.getAsArrayType(T))
5189 T = ACtx.getBaseElementType(AT);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005190
5191 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
5192 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00005193 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
5194 const VarDecl *VD = DE->getVarDecl();
5195 Helper.handleDecl(VD, OS);
5196
5197 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00005198 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
5199 const Stmt *LoopStmt = LE->getLoopStmt();
5200 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005201 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
5202 OS << "CFGScopeBegin(";
5203 if (const VarDecl *VD = SB->getVarDecl())
5204 OS << VD->getQualifiedNameAsString();
5205 OS << ")\n";
5206 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
5207 OS << "CFGScopeEnd(";
5208 if (const VarDecl *VD = SE->getVarDecl())
5209 OS << VD->getQualifiedNameAsString();
5210 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00005211 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
5212 OS << "CFGNewAllocator(";
5213 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
5214 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5215 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00005216 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
5217 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
5218 if (!RD)
5219 return;
5220 CXXDeleteExpr *DelExpr =
5221 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005222 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005223 OS << "->~" << RD->getName().str() << "()";
5224 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005225 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5226 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005227 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005228 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005229 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5230 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005231 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005232 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005233 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005234 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005235 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5236 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005237 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005238 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005239 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005240 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005241}
Mike Stump31feda52009-07-17 01:31:16 +00005242
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005243static void print_block(raw_ostream &OS, const CFG* cfg,
5244 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005245 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005246 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005247 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005248
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005249 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005250 if (ShowColors)
5251 OS.changeColor(raw_ostream::YELLOW, true);
Fangrui Song6907ce22018-07-30 19:24:48 +00005252
Ted Kremenek72be32a2011-12-22 23:33:52 +00005253 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005254
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005255 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005256 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005257 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005258 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005259 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005260 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005261 else if (B.hasNoReturnElement())
5262 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005263 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005264 OS << "]\n";
Fangrui Song6907ce22018-07-30 19:24:48 +00005265
Ted Kremenek72be32a2011-12-22 23:33:52 +00005266 if (ShowColors)
5267 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005268
Ted Kremenek71eca012007-08-29 23:20:49 +00005269 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005270 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005271 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005272 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005273
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005274 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005275 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005276 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005277 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005278 if (C->getLHS())
5279 C->getLHS()->printPretty(OS, &Helper,
5280 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005281 if (C->getRHS()) {
5282 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005283 C->getRHS()->printPretty(OS, &Helper,
5284 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005285 }
Mike Stump92244b02010-01-19 22:00:14 +00005286 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005287 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005288 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005289 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005290 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005291 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005292 0);
5293 else
5294 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005295 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005296 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5297 OS << "__except (";
5298 ES->getFilterExpr()->printPretty(OS, &Helper,
5299 PrintingPolicy(Helper.getLangOpts()), 0);
5300 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005301 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005302 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005303
Ted Kremenek71eca012007-08-29 23:20:49 +00005304 OS << ":\n";
5305 }
Mike Stump31feda52009-07-17 01:31:16 +00005306
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005307 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005308 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005309
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005310 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5311 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005312 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005313 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005314 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005315
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005316 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005317
Aaron Ballmanff924b02013-11-18 20:11:50 +00005318 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005319
Ted Kremenek72be32a2011-12-22 23:33:52 +00005320 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005321 }
Mike Stump31feda52009-07-17 01:31:16 +00005322
Ted Kremenek71eca012007-08-29 23:20:49 +00005323 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005324 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005325 if (ShowColors)
5326 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005327
Ted Kremenek72be32a2011-12-22 23:33:52 +00005328 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005329
Aaron Ballmanff924b02013-11-18 20:11:50 +00005330 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005331
Aaron Ballmanff924b02013-11-18 20:11:50 +00005332 PrintingPolicy PP(Helper.getLangOpts());
5333 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005334 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005335 OS << '\n';
Fangrui Song6907ce22018-07-30 19:24:48 +00005336
Ted Kremenek72be32a2011-12-22 23:33:52 +00005337 if (ShowColors)
5338 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005339 }
Mike Stump31feda52009-07-17 01:31:16 +00005340
Ted Kremenek71eca012007-08-29 23:20:49 +00005341 if (print_edges) {
5342 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005343 if (!B.pred_empty()) {
5344 const raw_ostream::Colors Color = raw_ostream::BLUE;
5345 if (ShowColors)
5346 OS.changeColor(Color);
5347 OS << " Preds " ;
5348 if (ShowColors)
5349 OS.resetColor();
5350 OS << '(' << B.pred_size() << "):";
5351 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005352
Ted Kremenek72be32a2011-12-22 23:33:52 +00005353 if (ShowColors)
5354 OS.changeColor(Color);
Fangrui Song6907ce22018-07-30 19:24:48 +00005355
Ted Kremenek72be32a2011-12-22 23:33:52 +00005356 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5357 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005358 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005359 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005360
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005361 CFGBlock *B = *I;
5362 bool Reachable = true;
5363 if (!B) {
5364 Reachable = false;
5365 B = I->getPossiblyUnreachableBlock();
5366 }
5367
5368 OS << " B" << B->getBlockID();
5369 if (!Reachable)
5370 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005371 }
Fangrui Song6907ce22018-07-30 19:24:48 +00005372
Ted Kremenek72be32a2011-12-22 23:33:52 +00005373 if (ShowColors)
5374 OS.resetColor();
5375
5376 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005377 }
Mike Stump31feda52009-07-17 01:31:16 +00005378
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005379 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005380 if (!B.succ_empty()) {
5381 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5382 if (ShowColors)
5383 OS.changeColor(Color);
5384 OS << " Succs ";
5385 if (ShowColors)
5386 OS.resetColor();
5387 OS << '(' << B.succ_size() << "):";
5388 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005389
Ted Kremenek72be32a2011-12-22 23:33:52 +00005390 if (ShowColors)
5391 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005392
Ted Kremenek72be32a2011-12-22 23:33:52 +00005393 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5394 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005395 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005396 OS << "\n ";
5397
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005398 CFGBlock *B = *I;
5399
5400 bool Reachable = true;
5401 if (!B) {
5402 Reachable = false;
5403 B = I->getPossiblyUnreachableBlock();
5404 }
5405
5406 if (B) {
5407 OS << " B" << B->getBlockID();
5408 if (!Reachable)
5409 OS << "(Unreachable)";
5410 }
5411 else {
5412 OS << " NULL";
5413 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005414 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005415
Ted Kremenek72be32a2011-12-22 23:33:52 +00005416 if (ShowColors)
5417 OS.resetColor();
5418 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005419 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005420 }
Mike Stump31feda52009-07-17 01:31:16 +00005421}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005422
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005423/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005424void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5425 print(llvm::errs(), LO, ShowColors);
5426}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005427
5428/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005429void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005430 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005431
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005432 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005433 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005434
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005435 // Iterate through the CFGBlocks and print them one by one.
5436 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5437 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005438 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005439 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005440
Aaron Ballmanff924b02013-11-18 20:11:50 +00005441 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005442 }
Mike Stump31feda52009-07-17 01:31:16 +00005443
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005444 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005445 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005446 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005447 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005448}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005449
5450/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005451void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5452 bool ShowColors) const {
5453 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005454}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005455
Yaron Kerencdae9412016-01-29 19:38:18 +00005456LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005457 dump(getParent(), LangOptions(), false);
5458}
5459
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005460/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5461/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005462void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005463 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005464 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005465 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005466 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005467}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005468
Ted Kremenek15647632008-01-30 23:02:42 +00005469/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005470void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005471 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005472 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005473 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005474}
5475
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005476Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00005477 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005478 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005479 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005480
Craig Topper25542942014-05-20 04:30:07 +00005481 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005482
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005483 switch (Terminator->getStmtClass()) {
5484 default:
5485 break;
Mike Stump31feda52009-07-17 01:31:16 +00005486
Jordan Rosecf10ea82013-06-06 21:53:45 +00005487 case Stmt::CXXForRangeStmtClass:
5488 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5489 break;
5490
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005491 case Stmt::ForStmtClass:
5492 E = cast<ForStmt>(Terminator)->getCond();
5493 break;
Mike Stump31feda52009-07-17 01:31:16 +00005494
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005495 case Stmt::WhileStmtClass:
5496 E = cast<WhileStmt>(Terminator)->getCond();
5497 break;
Mike Stump31feda52009-07-17 01:31:16 +00005498
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005499 case Stmt::DoStmtClass:
5500 E = cast<DoStmt>(Terminator)->getCond();
5501 break;
Mike Stump31feda52009-07-17 01:31:16 +00005502
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005503 case Stmt::IfStmtClass:
5504 E = cast<IfStmt>(Terminator)->getCond();
5505 break;
Mike Stump31feda52009-07-17 01:31:16 +00005506
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005507 case Stmt::ChooseExprClass:
5508 E = cast<ChooseExpr>(Terminator)->getCond();
5509 break;
Mike Stump31feda52009-07-17 01:31:16 +00005510
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005511 case Stmt::IndirectGotoStmtClass:
5512 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5513 break;
Mike Stump31feda52009-07-17 01:31:16 +00005514
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005515 case Stmt::SwitchStmtClass:
5516 E = cast<SwitchStmt>(Terminator)->getCond();
5517 break;
Mike Stump31feda52009-07-17 01:31:16 +00005518
John McCallc07a0c72011-02-17 10:25:35 +00005519 case Stmt::BinaryConditionalOperatorClass:
5520 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5521 break;
5522
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005523 case Stmt::ConditionalOperatorClass:
5524 E = cast<ConditionalOperator>(Terminator)->getCond();
5525 break;
Mike Stump31feda52009-07-17 01:31:16 +00005526
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005527 case Stmt::BinaryOperatorClass: // '&&' and '||'
5528 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005529 break;
Mike Stump31feda52009-07-17 01:31:16 +00005530
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005531 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005532 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005533 }
Mike Stump31feda52009-07-17 01:31:16 +00005534
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005535 if (!StripParens)
5536 return E;
5537
Craig Topper25542942014-05-20 04:30:07 +00005538 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005539}
5540
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005541//===----------------------------------------------------------------------===//
5542// CFG Graphviz Visualization
5543//===----------------------------------------------------------------------===//
5544
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005545#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005546static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005547#endif
5548
Chris Lattnerc61089a2009-06-30 01:26:17 +00005549void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005550#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005551 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005552 GraphHelper = &H;
5553 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005554 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005555#endif
5556}
5557
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005558namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005559
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005560template<>
5561struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005562 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005563
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005564 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005565#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005566 std::string OutSStr;
5567 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005568 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005569 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005570
5571 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5572
5573 // Process string output to make it nicer...
5574 for (unsigned i = 0; i != OutStr.length(); ++i)
5575 if (OutStr[i] == '\n') { // Left justify
5576 OutStr[i] = '\\';
5577 OutStr.insert(OutStr.begin()+i+1, 'l');
5578 }
Mike Stump31feda52009-07-17 01:31:16 +00005579
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005580 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005581#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005582 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005583#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005584 }
5585};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005586
5587} // namespace llvm