blob: 5d50cfb474e197762ebabe8b864130502820af72 [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
Artem Dergachev192a7472019-05-24 23:37:08 +00001434 // For C++ constructor add initializers to CFG. Constructors of virtual bases
1435 // are ignored unless the object is of the most derived class.
1436 // class VBase { VBase() = default; VBase(int) {} };
1437 // class A : virtual public VBase { A() : VBase(0) {} };
1438 // class B : public A {};
1439 // B b; // Constructor calls in order: VBase(), A(), B().
1440 // // VBase(0) is ignored because A isn't the most derived class.
1441 // This may result in the virtual base(s) being already initialized at this
1442 // point, in which case we should jump right onto non-virtual bases and
1443 // fields. To handle this, make a CFG branch. We only need to add one such
1444 // branch per constructor, since the Standard states that all virtual bases
1445 // shall be initialized before non-virtual bases and direct data members.
1446 if (const auto *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
1447 CFGBlock *VBaseSucc = nullptr;
Pete Cooper57d3f142015-07-30 17:22:52 +00001448 for (auto *I : llvm::reverse(CD->inits())) {
Artem Dergachev192a7472019-05-24 23:37:08 +00001449 if (BuildOpts.AddVirtualBaseBranches && !VBaseSucc &&
1450 I->isBaseInitializer() && I->isBaseVirtual()) {
1451 // We've reached the first virtual base init while iterating in reverse
1452 // order. Make a new block for virtual base initializers so that we
1453 // could skip them.
1454 VBaseSucc = Succ = B ? B : &cfg->getExit();
1455 Block = createBlock();
1456 }
Pete Cooper57d3f142015-07-30 17:22:52 +00001457 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001458 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001459 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001460 }
Artem Dergachev192a7472019-05-24 23:37:08 +00001461 if (VBaseSucc) {
1462 // Make a branch block for potentially skipping virtual base initializers.
1463 Succ = VBaseSucc;
1464 B = createBlock();
1465 B->setTerminator(
1466 CFGTerminator(nullptr, CFGTerminator::VirtualBaseBranch));
1467 addSuccessor(B, Block, true);
1468 }
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001469 }
1470
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001471 if (B)
1472 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001473
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001474 // Backpatch the gotos whose label -> block mappings we didn't know when we
1475 // encountered them.
1476 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1477 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001478
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001479 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001480 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001481 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001482
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001483 // If there is no target for the goto, then we are looking at an
1484 // incomplete AST. Handle this by not registering a successor.
1485 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001486
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001487 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001488 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1489 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001490 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1491 JT.scopePosition);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001492 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1493 B, I->scopePosition, JT.scopePosition);
1494 appendScopeBegin(JT.block, VD, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001495 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001496 }
1497
1498 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001499 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001500 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1501 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001502 // Lookup the target block.
1503 LabelMapTy::iterator LI = LabelMap.find(*I);
1504
1505 // If there is no target block that contains label, then we are looking
1506 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001507 if (LI == LabelMap.end()) continue;
Fangrui Song6907ce22018-07-30 19:24:48 +00001508
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001509 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001510 }
Mike Stump31feda52009-07-17 01:31:16 +00001511
Mike Stump31feda52009-07-17 01:31:16 +00001512 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001513 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001514
Artem Dergachev783a4572018-02-23 22:20:39 +00001515 if (BuildOpts.AddRichCXXConstructors)
1516 assert(ConstructionContextMap.empty() &&
1517 "Not all construction contexts were cleaned up!");
1518
David Blaikiee90195c2014-08-29 18:53:26 +00001519 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001520}
Mike Stump31feda52009-07-17 01:31:16 +00001521
Ted Kremenek9aae5132007-08-23 21:42:29 +00001522/// createBlock - Used to lazily create blocks that are connected
1523/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001524CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1525 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001526 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001527 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001528 return B;
1529}
Mike Stump31feda52009-07-17 01:31:16 +00001530
Chandler Carrutha70991b2011-09-13 09:13:49 +00001531/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1532/// CFG. It is *not* connected to the current (global) successor, and instead
1533/// directly tied to the exit block in order to be reachable.
1534CFGBlock *CFGBuilder::createNoReturnBlock() {
1535 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001536 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001537 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001538 return B;
1539}
1540
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001541/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001542CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001543 if (!BuildOpts.AddInitializers)
1544 return Block;
1545
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001546 bool HasTemporaries = false;
1547
1548 // Destructors of temporaries in initialization expression should be called
1549 // after initialization finishes.
1550 Expr *Init = I->getInit();
1551 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001552 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001553
Jordan Rose6d671cc2012-09-05 22:55:23 +00001554 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001555 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001556 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001557 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1558 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001559 }
1560 }
1561
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001562 autoCreateBlock();
1563 appendInitializer(Block, I);
1564
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001565 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001566 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001567 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001568 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001569
Ted Kremenek8219b822010-12-16 07:46:53 +00001570 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001571 // For expression with temporaries go directly to subexpression to omit
1572 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001573 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1574 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001575 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1576 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1577 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1578 // may cause the same Expr to appear more than once in the CFG. Doing it
1579 // here is safe because there's only one initializer per field.
1580 autoCreateBlock();
1581 appendStmt(Block, Default);
1582 if (Stmt *Child = Default->getExpr())
1583 if (CFGBlock *R = Visit(Child))
1584 Block = R;
1585 return Block;
1586 }
1587 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001588 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001589 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001590
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001591 return Block;
1592}
1593
Fangrui Song6907ce22018-07-30 19:24:48 +00001594/// Retrieve the type of the temporary object whose lifetime was
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001595/// extended by a local reference with the given initializer.
Artem Dergacheva25809f2018-06-04 18:56:25 +00001596static QualType getReferenceInitTemporaryType(const Expr *Init,
Richard Smithb8c0f552016-12-09 18:49:13 +00001597 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001598 while (true) {
1599 // Skip parentheses.
1600 Init = Init->IgnoreParens();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001601
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001602 // Skip through cleanups.
1603 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1604 Init = EWC->getSubExpr();
1605 continue;
1606 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001607
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001608 // Skip through the temporary-materialization expression.
1609 if (const MaterializeTemporaryExpr *MTE
1610 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1611 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001612 if (FoundMTE)
1613 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001614 continue;
1615 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001616
1617 // Skip sub-object accesses into rvalues.
1618 SmallVector<const Expr *, 2> CommaLHSs;
1619 SmallVector<SubobjectAdjustment, 2> Adjustments;
1620 const Expr *SkippedInit =
1621 Init->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments);
1622 if (SkippedInit != Init) {
1623 Init = SkippedInit;
1624 continue;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001625 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001626
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001627 break;
1628 }
1629
1630 return Init->getType();
1631}
Matthias Gehre351c2182017-07-12 07:04:19 +00001632
Peter Szecsi999a25f2017-08-19 11:19:16 +00001633// TODO: Support adding LoopExit element to the CFG in case where the loop is
1634// ended by ReturnStmt, GotoStmt or ThrowExpr.
1635void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1636 if(!BuildOpts.AddLoopExit)
1637 return;
1638 autoCreateBlock();
1639 appendLoopExit(Block, LoopStmt);
1640}
1641
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001642void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1643 LocalScope::const_iterator E, Stmt *S) {
1644 if (!BuildOpts.AddScopes)
1645 return;
1646
1647 if (B == E)
1648 return;
1649
1650 // To go from B to E, one first goes up the scopes from B to P
1651 // then sideways in one scope from P to P' and then down
1652 // the scopes from P' to E.
1653 // The lifetime of all objects between B and P end.
1654 LocalScope::const_iterator P = B.shared_parent(E);
1655 int Dist = B.distance(P);
1656 if (Dist <= 0)
1657 return;
1658
1659 for (LocalScope::const_iterator I = B; I != P; ++I)
1660 if (I.pointsToFirstDeclaredVar())
1661 DeclsWithEndedScope.insert(*I);
1662}
1663
Matthias Gehre351c2182017-07-12 07:04:19 +00001664void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1665 LocalScope::const_iterator E,
1666 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001667 getDeclsWithEndedScope(B, E, S);
1668 if (BuildOpts.AddScopes)
1669 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001670 if (BuildOpts.AddImplicitDtors)
1671 addAutomaticObjDtors(B, E, S);
1672 if (BuildOpts.AddLifetime)
1673 addLifetimeEnds(B, E, S);
1674}
1675
1676/// Add to current block automatic objects that leave the scope.
1677void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1678 LocalScope::const_iterator E, Stmt *S) {
1679 if (!BuildOpts.AddLifetime)
1680 return;
1681
1682 if (B == E)
1683 return;
1684
1685 // To go from B to E, one first goes up the scopes from B to P
1686 // then sideways in one scope from P to P' and then down
1687 // the scopes from P' to E.
1688 // The lifetime of all objects between B and P end.
1689 LocalScope::const_iterator P = B.shared_parent(E);
1690 int dist = B.distance(P);
1691 if (dist <= 0)
1692 return;
1693
1694 // We need to perform the scope leaving in reverse order
1695 SmallVector<VarDecl *, 10> DeclsTrivial;
1696 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1697 DeclsTrivial.reserve(dist);
1698 DeclsNonTrivial.reserve(dist);
1699
1700 for (LocalScope::const_iterator I = B; I != P; ++I)
1701 if (hasTrivialDestructor(*I))
1702 DeclsTrivial.push_back(*I);
1703 else
1704 DeclsNonTrivial.push_back(*I);
1705
1706 autoCreateBlock();
1707 // object with trivial destructor end their lifetime last (when storage
1708 // duration ends)
1709 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1710 E = DeclsTrivial.rend();
1711 I != E; ++I)
1712 appendLifetimeEnds(Block, *I, S);
1713
1714 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1715 I = DeclsNonTrivial.rbegin(),
1716 E = DeclsNonTrivial.rend();
1717 I != E; ++I)
1718 appendLifetimeEnds(Block, *I, S);
1719}
1720
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001721/// Add to current block markers for ending scopes.
1722void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1723 LocalScope::const_iterator E, Stmt *S) {
1724 // If implicit destructors are enabled, we'll add scope ends in
1725 // addAutomaticObjDtors.
1726 if (BuildOpts.AddImplicitDtors)
1727 return;
1728
1729 autoCreateBlock();
1730
1731 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1732 I != E; ++I)
1733 appendScopeEnd(Block, *I, S);
1734
1735 return;
1736}
1737
Marcin Swiderski5e415732010-09-30 23:05:00 +00001738/// addAutomaticObjDtors - Add to current block automatic objects destructors
1739/// for objects in range of local scope positions. Use S as trigger statement
1740/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001741void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001742 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001743 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001744 return;
1745
Marcin Swiderski5e415732010-09-30 23:05:00 +00001746 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001747 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001748
Chandler Carruthad747252011-09-13 06:09:01 +00001749 // We need to append the destructors in reverse order, but any one of them
1750 // may be a no-return destructor which changes the CFG. As a result, buffer
1751 // this sequence up and replay them in reverse order when appending onto the
1752 // CFGBlock(s).
1753 SmallVector<VarDecl*, 10> Decls;
1754 Decls.reserve(B.distance(E));
1755 for (LocalScope::const_iterator I = B; I != E; ++I)
1756 Decls.push_back(*I);
1757
1758 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1759 E = Decls.rend();
1760 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001761 if (hasTrivialDestructor(*I)) {
1762 // If AddScopes is enabled and *I is a first variable in a scope, add a
1763 // ScopeEnd marker in a Block.
1764 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1765 autoCreateBlock();
1766 appendScopeEnd(Block, *I, S);
1767 }
1768 continue;
1769 }
Chandler Carruthad747252011-09-13 06:09:01 +00001770 // If this destructor is marked as a no-return destructor, we need to
1771 // create a new block for the destructor which does not have as a successor
1772 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001773 QualType Ty = (*I)->getType();
1774 if (Ty->isReferenceType()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00001775 Ty = getReferenceInitTemporaryType((*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001776 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001777 Ty = Context->getBaseElementType(Ty);
1778
Richard Trieu95a192a2015-05-28 00:14:02 +00001779 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001780 Block = createNoReturnBlock();
1781 else
Chandler Carruthad747252011-09-13 06:09:01 +00001782 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001783
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001784 // Add ScopeEnd just after automatic obj destructor.
1785 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1786 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001787 appendAutomaticObjDtor(Block, *I, S);
1788 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001789}
1790
Marcin Swiderski20b88732010-10-05 05:37:00 +00001791/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1792/// base and member objects in destructor.
1793void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001794 assert(BuildOpts.AddImplicitDtors &&
1795 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001796 const CXXRecordDecl *RD = DD->getParent();
1797
1798 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001799 for (const auto &VI : RD->vbases()) {
Artem Dergachev192a7472019-05-24 23:37:08 +00001800 // TODO: Add a VirtualBaseBranch to see if the most derived class
1801 // (which is different from the current class) is responsible for
1802 // destroying them.
Aaron Ballman445a9392014-03-13 16:15:17 +00001803 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001804 if (!CD->hasTrivialDestructor()) {
1805 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001806 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001807 }
1808 }
1809
1810 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001811 for (const auto &BI : RD->bases()) {
1812 if (!BI.isVirtual()) {
1813 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001814 if (!CD->hasTrivialDestructor()) {
1815 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001816 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001817 }
1818 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001819 }
1820
1821 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001822 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001823 // Check for constant size array. Set type to array element type.
1824 QualType QT = FI->getType();
1825 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1826 if (AT->getSize() == 0)
1827 continue;
1828 QT = AT->getElementType();
1829 }
1830
1831 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001832 if (!CD->hasTrivialDestructor()) {
1833 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001834 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001835 }
1836 }
1837}
1838
Marcin Swiderski5e415732010-09-30 23:05:00 +00001839/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1840/// way return valid LocalScope object.
1841LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001842 if (Scope)
1843 return Scope;
1844 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1845 return new (alloc.Allocate<LocalScope>())
1846 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001847}
1848
1849/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Fangrui Song6907ce22018-07-30 19:24:48 +00001850/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001851void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001852 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1853 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001854 return;
1855
Craig Topper25542942014-05-20 04:30:07 +00001856 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001857
1858 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001859 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001860 for (auto *BI : CS->body()) {
1861 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001862 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001863 Scope = addLocalScopeForDeclStmt(DS, Scope);
1864 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001865 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001866 }
1867
1868 // For any other statement scope will be implicit and as such will be
1869 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001870 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001871 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001872}
1873
1874/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1875/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001876LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001877 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001878 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1879 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001880 return Scope;
1881
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001882 for (auto *DI : DS->decls())
1883 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001884 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001885 return Scope;
1886}
1887
Matthias Gehre351c2182017-07-12 07:04:19 +00001888bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1889 // Check for const references bound to temporary. Set type to pointee.
1890 QualType QT = VD->getType();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001891 if (QT->isReferenceType()) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001892 // Attempt to determine whether this declaration lifetime-extends a
1893 // temporary.
1894 //
1895 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1896 // temporaries, and a single declaration can extend multiple temporaries.
1897 // We should look at the storage duration on each nested
1898 // MaterializeTemporaryExpr instead.
1899
1900 const Expr *Init = VD->getInit();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001901 if (!Init) {
1902 // Probably an exception catch-by-reference variable.
1903 // FIXME: It doesn't really mean that the object has a trivial destructor.
1904 // Also are there other cases?
Matthias Gehre351c2182017-07-12 07:04:19 +00001905 return true;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001906 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001907
Artem Dergacheva25809f2018-06-04 18:56:25 +00001908 // Lifetime-extending a temporary?
Matthias Gehre351c2182017-07-12 07:04:19 +00001909 bool FoundMTE = false;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001910 QT = getReferenceInitTemporaryType(Init, &FoundMTE);
Matthias Gehre351c2182017-07-12 07:04:19 +00001911 if (!FoundMTE)
1912 return true;
1913 }
1914
1915 // Check for constant size array. Set type to array element type.
1916 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1917 if (AT->getSize() == 0)
1918 return true;
1919 QT = AT->getElementType();
1920 }
1921
1922 // Check if type is a C++ class with non-trivial destructor.
1923 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1924 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1925 return true;
1926}
1927
Marcin Swiderski5e415732010-09-30 23:05:00 +00001928/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1929/// create add scope for automatic objects and temporary objects bound to
1930/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001931LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001932 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001933 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1934 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001935 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1936 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001937 return Scope;
1938
1939 // Check if variable is local.
1940 switch (VD->getStorageClass()) {
1941 case SC_None:
1942 case SC_Auto:
1943 case SC_Register:
1944 break;
1945 default: return Scope;
1946 }
1947
Matthias Gehre351c2182017-07-12 07:04:19 +00001948 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001949 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001950 // Add the variable to scope
1951 Scope = createOrReuseLocalScope(Scope);
1952 Scope->addVar(VD);
1953 ScopePos = Scope->begin();
1954 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001955 return Scope;
1956 }
1957
1958 assert(BuildOpts.AddLifetime);
1959 // Add the variable to scope
1960 Scope = createOrReuseLocalScope(Scope);
1961 Scope->addVar(VD);
1962 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001963 return Scope;
1964}
1965
1966/// addLocalScopeAndDtors - For given statement add local scope for it and
1967/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001968void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001969 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001970 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001971 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001972}
1973
Marcin Swiderski321a7072010-09-30 22:54:37 +00001974/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1975/// variables with automatic storage duration to CFGBlock's elements vector.
1976/// Elements will be prepended to physical beginning of the vector which
1977/// happens to be logical end. Use blocks terminator as statement that specifies
1978/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001979/// FIXME: This mechanism for adding automatic destructors doesn't handle
1980/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001981void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001982 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001983 if (!BuildOpts.AddImplicitDtors)
1984 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001985 BumpVectorContext &C = cfg->getBumpVectorContext();
1986 CFGBlock::iterator InsertPos
1987 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1988 for (LocalScope::const_iterator I = B; I != E; ++I)
1989 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
Artem Dergachev4e530322019-05-24 01:34:22 +00001990 Blk->getTerminatorStmt());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001991}
1992
Matthias Gehre351c2182017-07-12 07:04:19 +00001993/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1994/// variables with automatic storage duration to CFGBlock's elements vector.
1995/// Elements will be prepended to physical beginning of the vector which
1996/// happens to be logical end. Use blocks terminator as statement that specifies
1997/// where lifetime ends.
1998void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1999 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
2000 if (!BuildOpts.AddLifetime)
2001 return;
2002 BumpVectorContext &C = cfg->getBumpVectorContext();
2003 CFGBlock::iterator InsertPos =
2004 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
Artem Dergachev4e530322019-05-24 01:34:22 +00002005 for (LocalScope::const_iterator I = B; I != E; ++I) {
2006 InsertPos =
2007 Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminatorStmt());
2008 }
Matthias Gehre351c2182017-07-12 07:04:19 +00002009}
Eugene Zelenko38c70522017-12-07 21:55:09 +00002010
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002011/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
2012/// variables with automatic storage duration to CFGBlock's elements vector.
2013/// Elements will be prepended to physical beginning of the vector which
2014/// happens to be logical end. Use blocks terminator as statement that specifies
2015/// where scope ends.
2016const VarDecl *
2017CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
2018 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
2019 if (!BuildOpts.AddScopes)
2020 return nullptr;
2021 BumpVectorContext &C = cfg->getBumpVectorContext();
2022 CFGBlock::iterator InsertPos =
2023 Blk->beginScopeEndInsert(Blk->end(), 1, C);
2024 LocalScope::const_iterator PlaceToInsert = B;
2025 for (LocalScope::const_iterator I = B; I != E; ++I)
2026 PlaceToInsert = I;
Artem Dergachev4e530322019-05-24 01:34:22 +00002027 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminatorStmt());
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002028 return *PlaceToInsert;
2029}
2030
Ted Kremenek93668002009-07-17 22:18:43 +00002031/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00002032/// blocks for ternary operators, &&, and ||. We also process "," and
2033/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002034CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00002035 if (!S) {
2036 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00002037 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00002038 }
Jordy Rose17347372011-06-10 08:49:37 +00002039
2040 if (Expr *E = dyn_cast<Expr>(S))
2041 S = E->IgnoreParens();
2042
Ted Kremenek93668002009-07-17 22:18:43 +00002043 switch (S->getStmtClass()) {
2044 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002045 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002046
2047 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002048 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002049
John McCallc07a0c72011-02-17 10:25:35 +00002050 case Stmt::BinaryConditionalOperatorClass:
2051 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
2052
Ted Kremenek93668002009-07-17 22:18:43 +00002053 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002054 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002055
Ted Kremenek93668002009-07-17 22:18:43 +00002056 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00002057 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002058
Ted Kremenek93668002009-07-17 22:18:43 +00002059 case Stmt::BreakStmtClass:
2060 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002061
Ted Kremenek93668002009-07-17 22:18:43 +00002062 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00002063 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00002064 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00002065 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002066 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002067
Ted Kremenek93668002009-07-17 22:18:43 +00002068 case Stmt::CaseStmtClass:
2069 return VisitCaseStmt(cast<CaseStmt>(S));
2070
2071 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002072 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002073
Ted Kremenek93668002009-07-17 22:18:43 +00002074 case Stmt::CompoundStmtClass:
2075 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002076
Ted Kremenek93668002009-07-17 22:18:43 +00002077 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002078 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002079
Ted Kremenek93668002009-07-17 22:18:43 +00002080 case Stmt::ContinueStmtClass:
2081 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002082
Ted Kremenekb27378c2010-01-19 20:40:33 +00002083 case Stmt::CXXCatchStmtClass:
2084 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
2085
John McCall5d413782010-12-06 08:20:24 +00002086 case Stmt::ExprWithCleanupsClass:
2087 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00002088
Jordan Rosee5d53932012-08-23 18:10:53 +00002089 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00002090 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00002091 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
2092 // called function's declaration, not by the caller. If we simply add
2093 // this expression to the CFG, we could end up with the same Expr
2094 // appearing multiple times.
2095 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00002096 //
2097 // It's likewise possible for multiple CXXDefaultInitExprs for the same
2098 // expression to be used in the same function (through aggregate
2099 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00002100 return VisitStmt(S, asc);
2101
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002102 case Stmt::CXXBindTemporaryExprClass:
2103 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
2104
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002105 case Stmt::CXXConstructExprClass:
2106 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
2107
Jordan Rosec9176072014-01-13 17:59:19 +00002108 case Stmt::CXXNewExprClass:
2109 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2110
Jordan Rosed2f40792013-09-03 17:00:57 +00002111 case Stmt::CXXDeleteExprClass:
2112 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2113
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002114 case Stmt::CXXFunctionalCastExprClass:
2115 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2116
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002117 case Stmt::CXXTemporaryObjectExprClass:
2118 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2119
Ted Kremenekb27378c2010-01-19 20:40:33 +00002120 case Stmt::CXXThrowExprClass:
2121 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002122
Ted Kremenekb27378c2010-01-19 20:40:33 +00002123 case Stmt::CXXTryStmtClass:
2124 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002125
Richard Smith02e85f32011-04-14 22:09:26 +00002126 case Stmt::CXXForRangeStmtClass:
2127 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2128
Ted Kremenek93668002009-07-17 22:18:43 +00002129 case Stmt::DeclStmtClass:
2130 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002131
Ted Kremenek93668002009-07-17 22:18:43 +00002132 case Stmt::DefaultStmtClass:
2133 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002134
Ted Kremenek93668002009-07-17 22:18:43 +00002135 case Stmt::DoStmtClass:
2136 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002137
Ted Kremenek93668002009-07-17 22:18:43 +00002138 case Stmt::ForStmtClass:
2139 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002140
Ted Kremenek93668002009-07-17 22:18:43 +00002141 case Stmt::GotoStmtClass:
2142 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002143
Ted Kremenek93668002009-07-17 22:18:43 +00002144 case Stmt::IfStmtClass:
2145 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002146
Ted Kremenek8219b822010-12-16 07:46:53 +00002147 case Stmt::ImplicitCastExprClass:
2148 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002149
Bill Wendling8003edc2018-11-09 00:41:36 +00002150 case Stmt::ConstantExprClass:
2151 return VisitConstantExpr(cast<ConstantExpr>(S), asc);
2152
Ted Kremenek93668002009-07-17 22:18:43 +00002153 case Stmt::IndirectGotoStmtClass:
2154 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002155
Ted Kremenek93668002009-07-17 22:18:43 +00002156 case Stmt::LabelStmtClass:
2157 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002158
Ted Kremenekda76a942012-04-12 20:34:52 +00002159 case Stmt::LambdaExprClass:
2160 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2161
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002162 case Stmt::MaterializeTemporaryExprClass:
2163 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2164 asc);
2165
Ted Kremenek5868ec62010-04-11 17:02:10 +00002166 case Stmt::MemberExprClass:
2167 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2168
Ted Kremenek04268232011-11-05 00:10:15 +00002169 case Stmt::NullStmtClass:
2170 return Block;
2171
Ted Kremenek93668002009-07-17 22:18:43 +00002172 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002173 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2174
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002175 case Stmt::ObjCAutoreleasePoolStmtClass:
2176 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2177
Ted Kremenek93668002009-07-17 22:18:43 +00002178 case Stmt::ObjCAtSynchronizedStmtClass:
2179 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002180
Ted Kremenek93668002009-07-17 22:18:43 +00002181 case Stmt::ObjCAtThrowStmtClass:
2182 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002183
Ted Kremenek93668002009-07-17 22:18:43 +00002184 case Stmt::ObjCAtTryStmtClass:
2185 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002186
Ted Kremenek93668002009-07-17 22:18:43 +00002187 case Stmt::ObjCForCollectionStmtClass:
2188 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002189
Artem Dergachevbd880fe2018-07-31 19:39:37 +00002190 case Stmt::ObjCMessageExprClass:
2191 return VisitObjCMessageExpr(cast<ObjCMessageExpr>(S), asc);
2192
Ted Kremenek04268232011-11-05 00:10:15 +00002193 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002194 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002195
John McCallfe96e0b2011-11-06 09:01:30 +00002196 case Stmt::PseudoObjectExprClass:
2197 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2198
Ted Kremenek93668002009-07-17 22:18:43 +00002199 case Stmt::ReturnStmtClass:
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002200 case Stmt::CoreturnStmtClass:
2201 return VisitReturnStmt(S);
Mike Stump11289f42009-09-09 15:08:12 +00002202
Nico Weber699670e2017-08-23 15:33:16 +00002203 case Stmt::SEHExceptStmtClass:
2204 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2205
2206 case Stmt::SEHFinallyStmtClass:
2207 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2208
2209 case Stmt::SEHLeaveStmtClass:
2210 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2211
2212 case Stmt::SEHTryStmtClass:
2213 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2214
Peter Collingbournee190dee2011-03-11 19:24:49 +00002215 case Stmt::UnaryExprOrTypeTraitExprClass:
2216 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2217 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002218
Ted Kremenek93668002009-07-17 22:18:43 +00002219 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002220 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002221
Ted Kremenek93668002009-07-17 22:18:43 +00002222 case Stmt::SwitchStmtClass:
2223 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002224
Zhanyong Wan6dace612010-11-22 08:45:56 +00002225 case Stmt::UnaryOperatorClass:
2226 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2227
Ted Kremenek93668002009-07-17 22:18:43 +00002228 case Stmt::WhileStmtClass:
2229 return VisitWhileStmt(cast<WhileStmt>(S));
2230 }
2231}
Mike Stump11289f42009-09-09 15:08:12 +00002232
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002233CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002234 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002235 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002236 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002237 }
Mike Stump11289f42009-09-09 15:08:12 +00002238
Ted Kremenek93668002009-07-17 22:18:43 +00002239 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002240}
Mike Stump31feda52009-07-17 01:31:16 +00002241
Ted Kremenek93668002009-07-17 22:18:43 +00002242/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002243CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2244 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002245
Ted Kremenek8ae67872013-02-05 22:00:19 +00002246 // Visit the children in their reverse order so that they appear in
2247 // left-to-right (natural) order in the CFG.
2248 reverse_children RChildren(S);
2249 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2250 I != E; ++I) {
2251 if (Stmt *Child = *I)
2252 if (CFGBlock *R = Visit(Child))
2253 B = R;
2254 }
2255 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002256}
Mike Stump11289f42009-09-09 15:08:12 +00002257
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002258CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2259 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002260 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002261
Ted Kremenek7c58d352011-03-10 01:14:11 +00002262 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002263 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002264 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002265 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002266
Ted Kremenek9aae5132007-08-23 21:42:29 +00002267 return Block;
2268}
Mike Stump11289f42009-09-09 15:08:12 +00002269
Zhanyong Wan6dace612010-11-22 08:45:56 +00002270CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002271 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002272 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002273 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002274 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002275 }
2276
Ted Kremenek8219b822010-12-16 07:46:53 +00002277 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002278}
2279
Ted Kremeneka16436f2012-07-14 05:04:06 +00002280CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2281 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2282 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002283
Ted Kremeneka16436f2012-07-14 05:04:06 +00002284 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002285 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002286
Craig Topper25542942014-05-20 04:30:07 +00002287 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2288 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002289}
2290
2291std::pair<CFGBlock*, CFGBlock*>
2292CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2293 Stmt *Term,
2294 CFGBlock *TrueBlock,
2295 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002296 // Introspect the RHS. If it is a nested logical operation, we recursively
2297 // build the CFG using this function. Otherwise, resort to default
2298 // CFG construction behavior.
2299 Expr *RHS = B->getRHS()->IgnoreParens();
2300 CFGBlock *RHSBlock, *ExitBlock;
2301
2302 do {
2303 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2304 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002305 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002306 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2307 break;
2308 }
2309
2310 // The RHS is not a nested logical operation. Don't push the terminator
2311 // down further, but instead visit RHS and construct the respective
2312 // pieces of the CFG, and link up the RHSBlock with the terminator
2313 // we have been provided.
2314 ExitBlock = RHSBlock = createBlock(false);
2315
Richard Trieu6a6af522017-01-04 00:46:30 +00002316 // Even though KnownVal is only used in the else branch of the next
2317 // conditional, tryEvaluateBool performs additional checking on the
2318 // Expr, so it should be called unconditionally.
2319 TryResult KnownVal = tryEvaluateBool(RHS);
2320 if (!KnownVal.isKnown())
2321 KnownVal = tryEvaluateBool(B);
2322
Ted Kremenekb50e7162012-07-14 05:04:10 +00002323 if (!Term) {
2324 assert(TrueBlock == FalseBlock);
2325 addSuccessor(RHSBlock, TrueBlock);
2326 }
2327 else {
2328 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002329 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2330 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002331 }
2332
2333 Block = RHSBlock;
2334 RHSBlock = addStmt(RHS);
2335 }
2336 while (false);
2337
2338 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002339 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002340
2341 // Generate the blocks for evaluating the LHS.
2342 Expr *LHS = B->getLHS()->IgnoreParens();
2343
2344 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2345 if (B_LHS->isLogicalOp()) {
2346 if (B->getOpcode() == BO_LOr)
2347 FalseBlock = RHSBlock;
2348 else
2349 TrueBlock = RHSBlock;
2350
2351 // For the LHS, treat 'B' as the terminator that we want to sink
2352 // into the nested branch. The RHS always gets the top-most
2353 // terminator.
2354 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2355 }
2356
2357 // Create the block evaluating the LHS.
2358 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002359 CFGBlock *LHSBlock = createBlock(false);
2360 LHSBlock->setTerminator(B);
2361
Ted Kremeneka16436f2012-07-14 05:04:06 +00002362 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002363 CFGBlock *EntryLHSBlock = addStmt(LHS);
2364
2365 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002366 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002367
2368 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002369 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002370
2371 // Now link the LHSBlock with RHSBlock.
2372 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002373 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2374 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002375 } else {
2376 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002377 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2378 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002379 }
2380
Ted Kremenekb50e7162012-07-14 05:04:10 +00002381 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002382}
2383
2384CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2385 AddStmtChoice asc) {
2386 // && or ||
2387 if (B->isLogicalOp())
2388 return VisitLogicalOperator(B);
2389
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002390 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002391 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002392 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002393 addStmt(B->getRHS());
2394 return addStmt(B->getLHS());
2395 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002396
2397 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002398 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002399 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002400 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002401 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002402 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002403 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002404 }
Mike Stump11289f42009-09-09 15:08:12 +00002405
Ted Kremenek7c58d352011-03-10 01:14:11 +00002406 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002407 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002408 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002409 }
2410
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002411 CFGBlock *RBlock = Visit(B->getRHS());
2412 CFGBlock *LBlock = Visit(B->getLHS());
2413 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2414 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2415 // return RBlock. Otherwise we'll incorrectly return NULL.
2416 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002417}
2418
Ted Kremeneke2499842012-04-12 20:03:44 +00002419CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002420 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002421 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002422 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002423 }
2424 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002425}
2426
Ted Kremenek93668002009-07-17 22:18:43 +00002427CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2428 // "break" is a control-flow statement. Thus we stop processing the current
2429 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002430 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002431 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002432
Ted Kremenek93668002009-07-17 22:18:43 +00002433 // Now create a new block that ends with the break statement.
2434 Block = createBlock(false);
2435 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002436
Ted Kremenek93668002009-07-17 22:18:43 +00002437 // If there is no target for the break, then we are looking at an incomplete
2438 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002439 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002440 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002441 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002442 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002443 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002444
Ted Kremenek9aae5132007-08-23 21:42:29 +00002445 return Block;
2446}
Mike Stump11289f42009-09-09 15:08:12 +00002447
Sebastian Redl31ad7542011-03-13 17:09:40 +00002448static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002449 QualType Ty = E->getType();
2450 if (Ty->isFunctionPointerType())
2451 Ty = Ty->getAs<PointerType>()->getPointeeType();
2452 else if (Ty->isBlockPointerType())
2453 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002454
Mike Stump04c68512010-01-21 15:20:48 +00002455 const FunctionType *FT = Ty->getAs<FunctionType>();
2456 if (FT) {
2457 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002458 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00002459 Proto->isNothrow())
Mike Stump04c68512010-01-21 15:20:48 +00002460 return false;
2461 }
2462 return true;
2463}
2464
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002465CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002466 // Compute the callee type.
2467 QualType calleeType = C->getCallee()->getType();
2468 if (calleeType == Context->BoundMemberTy) {
2469 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2470
2471 // We should only get a null bound type if processing a dependent
2472 // CFG. Recover by assuming nothing.
2473 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002474 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002475
John McCallc67067f2011-05-11 07:19:11 +00002476 // If this is a call to a no-return function, this stops the block here.
2477 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2478
Mike Stump04c68512010-01-21 15:20:48 +00002479 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002480
2481 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002482 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002483 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002484 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002485 }
2486
Jordan Rose5374c072013-08-19 16:27:28 +00002487 // If this is a call to a builtin function, it might not actually evaluate
2488 // its arguments. Don't add them to the CFG if this is the case.
2489 bool OmitArguments = false;
2490
Mike Stump92244b02010-01-19 22:00:14 +00002491 if (FunctionDecl *FD = C->getDirectCallee()) {
Artem Dergachev594b5412018-08-29 21:50:52 +00002492 // TODO: Support construction contexts for variadic function arguments.
2493 // These are a bit problematic and not very useful because passing
2494 // C++ objects as C-style variadic arguments doesn't work in general
2495 // (see [expr.call]).
2496 if (!FD->isVariadic())
2497 findConstructionContextsForArguments(C);
2498
Nico Weber758fbac2018-02-13 21:31:47 +00002499 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002500 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002501 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002502 AddEHEdge = false;
Erik Pilkington9c3b5882019-01-30 20:34:53 +00002503 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size ||
2504 FD->getBuiltinID() == Builtin::BI__builtin_dynamic_object_size)
Jordan Rose5374c072013-08-19 16:27:28 +00002505 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002506 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002507
Sebastian Redl31ad7542011-03-13 17:09:40 +00002508 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002509 AddEHEdge = false;
2510
Jordan Rose5374c072013-08-19 16:27:28 +00002511 if (OmitArguments) {
2512 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2513 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2514 autoCreateBlock();
2515 appendStmt(Block, C);
2516 return Visit(C->getCallee());
2517 }
2518
2519 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002520 autoCreateBlock();
2521 appendCall(Block, C);
2522
2523 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002524 }
Mike Stump11289f42009-09-09 15:08:12 +00002525
Mike Stump92244b02010-01-19 22:00:14 +00002526 if (Block) {
2527 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002528 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002529 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002530 }
Mike Stump11289f42009-09-09 15:08:12 +00002531
Chandler Carrutha70991b2011-09-13 09:13:49 +00002532 if (NoReturn)
2533 Block = createNoReturnBlock();
2534 else
2535 Block = createBlock();
2536
Artem Dergachev1527dec2018-03-12 23:12:40 +00002537 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002538
Mike Stump04c68512010-01-21 15:20:48 +00002539 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002540 // Add exceptional edges.
2541 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002542 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002543 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002544 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002545 }
Mike Stump11289f42009-09-09 15:08:12 +00002546
Mike Stump8c5d7992009-07-25 21:26:53 +00002547 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002548}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002549
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002550CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2551 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002552 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002553 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002554 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002555 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002556
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002557 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002558 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002559 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002560 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002561 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002562 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002563
Ted Kremenek21822592009-07-17 18:20:32 +00002564 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002565 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002566 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002567 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002568 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002569
Ted Kremenek21822592009-07-17 18:20:32 +00002570 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002571 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002572 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002573 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2574 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002575 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002576 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002577}
Mike Stump11289f42009-09-09 15:08:12 +00002578
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002579CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002580 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002581 addLocalScopeForStmt(C);
2582
Matthias Gehre09a134e2015-11-14 00:36:50 +00002583 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002584 // If the body ends with a ReturnStmt, the dtors will be added in
2585 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002586 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002587 }
2588
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002589 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002590
2591 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2592 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002593 // If we hit a segment of code just containing ';' (NullStmts), we can
2594 // get a null block back. In such cases, just use the LastBlock
2595 if (CFGBlock *newBlock = addStmt(*I))
2596 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002597
Ted Kremenekce499c22009-08-27 23:16:26 +00002598 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002599 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002600 }
Mike Stump92244b02010-01-19 22:00:14 +00002601
Ted Kremenek93668002009-07-17 22:18:43 +00002602 return LastBlock;
2603}
Mike Stump11289f42009-09-09 15:08:12 +00002604
John McCallc07a0c72011-02-17 10:25:35 +00002605CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002606 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002607 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002608 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002609
Ted Kremenek51d40b02009-07-17 18:15:54 +00002610 // Create the confluence block that will "merge" the results of the ternary
2611 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002612 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002613 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002614 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002615 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002616
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002617 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002618
Ted Kremenek51d40b02009-07-17 18:15:54 +00002619 // Create a block for the LHS expression if there is an LHS expression. A
2620 // GCC extension allows LHS to be NULL, causing the condition to be the
2621 // value that is returned instead.
2622 // e.g: x ?: y is shorthand for: x ? x : y;
2623 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002624 Block = nullptr;
2625 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002626 const Expr *trueExpr = C->getTrueExpr();
2627 if (trueExpr != opaqueValue) {
2628 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002629 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002630 return nullptr;
2631 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002632 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002633 else
2634 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002635
Ted Kremenek51d40b02009-07-17 18:15:54 +00002636 // Create the block for the RHS expression.
2637 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002638 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002639 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002640 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002641
Richard Smithf676e452012-07-24 21:02:14 +00002642 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2643 if (BinaryOperator *Cond =
2644 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2645 if (Cond->isLogicalOp())
2646 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2647
Ted Kremenek51d40b02009-07-17 18:15:54 +00002648 // Create the block that will contain the condition.
2649 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002650
Mike Stump773582d2009-07-23 23:25:26 +00002651 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002652 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002653 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2654 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002655 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002656 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002657
Ted Kremenekd8138012011-02-24 03:09:15 +00002658 if (opaqueValue) {
2659 // Run the condition expression if it's not trivially expressed in
2660 // terms of the opaque value (or if there is no opaque value).
2661 if (condExpr != opaqueValue)
2662 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002663
Ted Kremenekd8138012011-02-24 03:09:15 +00002664 // Before that, run the common subexpression if there was one.
2665 // At least one of this or the above will be run.
2666 return addStmt(BCO->getCommon());
2667 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002668
Ted Kremenekd8138012011-02-24 03:09:15 +00002669 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002670}
2671
Ted Kremenek93668002009-07-17 22:18:43 +00002672CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002673 // Check if the Decl is for an __label__. If so, elide it from the
2674 // CFG entirely.
2675 if (isa<LabelDecl>(*DS->decl_begin()))
2676 return Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00002677
Ted Kremenek3a601142011-05-24 20:41:31 +00002678 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002679 if (DS->isSingleDecl())
2680 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002681
Craig Topper25542942014-05-20 04:30:07 +00002682 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002683
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002684 // Build an individual DeclStmt for each decl.
2685 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2686 E = DS->decl_rend();
2687 I != E; ++I) {
Mike Stump11289f42009-09-09 15:08:12 +00002688
Ted Kremenek93668002009-07-17 22:18:43 +00002689 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2690 // automatically freed with the CFG.
2691 DeclGroupRef DG(*I);
2692 Decl *D = *I;
George Karpenkovc1ac8082018-10-02 21:19:01 +00002693 DeclStmt *DSNew = new (Context) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002694 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002695
Ted Kremenek93668002009-07-17 22:18:43 +00002696 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002697 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002698 }
Mike Stump11289f42009-09-09 15:08:12 +00002699
2700 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002701}
Mike Stump11289f42009-09-09 15:08:12 +00002702
Ted Kremenek93668002009-07-17 22:18:43 +00002703/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002704/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002705CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002706 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002707 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002708
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002709 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002710 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2711 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002712 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002713 }
Mike Stump11289f42009-09-09 15:08:12 +00002714
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002715 bool HasTemporaries = false;
2716
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002717 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002718 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002719
2720 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2721 // For static variables, we need to create a branch to track
2722 // whether or not they are initialized.
2723 if (Block) {
2724 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002725 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002726 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002727 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002728 }
2729 blockAfterStaticInit = Succ;
2730 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002731
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002732 // Destructors of temporaries in initialization expression should be called
2733 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002734 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002735 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002736 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002737
Jordan Rose6d671cc2012-09-05 22:55:23 +00002738 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002739 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002740 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002741 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2742 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002743 }
2744 }
2745
2746 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002747 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002748
Artem Dergachev783a4572018-02-23 22:20:39 +00002749 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002750 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002751 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002752
Ted Kremenek213d0532012-03-22 05:57:43 +00002753 // Keep track of the last non-null block, as 'Block' can be nulled out
2754 // if the initializer expression is something like a 'while' in a
2755 // statement-expression.
2756 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002757
Ted Kremenek93668002009-07-17 22:18:43 +00002758 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002759 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002760 // For expression with temporaries go directly to subexpression to omit
2761 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002762 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2763 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2764 LastBlock = newBlock;
2765 }
2766 else {
2767 if (CFGBlock *newBlock = Visit(Init))
2768 LastBlock = newBlock;
2769 }
Ted Kremenek93668002009-07-17 22:18:43 +00002770 }
Mike Stump11289f42009-09-09 15:08:12 +00002771
Ted Kremenek93668002009-07-17 22:18:43 +00002772 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002773 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002774 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002775 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2776 LastBlock = newBlock;
2777 }
Mike Stump11289f42009-09-09 15:08:12 +00002778
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002779 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2780
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002781 // Remove variable from local scope.
2782 if (ScopePos && VD == *ScopePos)
2783 ++ScopePos;
2784
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002785 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002786 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002787 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002788 Block = createBlock(false);
2789 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002790 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002791 addSuccessor(Block, B);
2792 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002793 }
2794
2795 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002796}
2797
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002798CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002799 // We may see an if statement in the middle of a basic block, or it may be the
2800 // first statement we are processing. In either case, we create a new basic
2801 // block. First, we create the blocks for the then...else statements, and
2802 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002803 // middle of a block, we stop processing that block. That block is then the
2804 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002805
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002806 // Save local scope position because in case of condition variable ScopePos
2807 // won't be restored when traversing AST.
2808 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2809
Richard Smitha547eb22016-07-14 00:11:03 +00002810 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002811 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002812 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002813
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002814 // Create local scope for possible condition variable.
2815 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002816 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002817 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002818
Matthias Gehre351c2182017-07-12 07:04:19 +00002819 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002820
Chris Lattner57540c52011-04-15 05:22:18 +00002821 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002822 // block.
2823 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002824 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002825 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002826 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002827 }
Mike Stump31feda52009-07-17 01:31:16 +00002828
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002829 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002830 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002831
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002832 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002833 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002834
Ted Kremenek9aae5132007-08-23 21:42:29 +00002835 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002836 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002837 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002838
2839 // If branch is not a compound statement create implicit scope
2840 // and add destructors.
2841 if (!isa<CompoundStmt>(Else))
2842 addLocalScopeAndDtors(Else);
2843
Ted Kremenek93668002009-07-17 22:18:43 +00002844 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002845
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002846 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2847 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002848 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002849 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002850 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002851 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002852 }
Mike Stump31feda52009-07-17 01:31:16 +00002853
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002854 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002855 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002856 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002857 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002858 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002859 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002860 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002861
2862 // If branch is not a compound statement create implicit scope
2863 // and add destructors.
2864 if (!isa<CompoundStmt>(Then))
2865 addLocalScopeAndDtors(Then);
2866
Ted Kremenek93668002009-07-17 22:18:43 +00002867 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002868
Ted Kremenek1b379512009-04-01 03:52:47 +00002869 if (!ThenBlock) {
2870 // We can reach here if the "then" body has all NullStmts.
2871 // Create an empty block so we can distinguish between true and false
2872 // branches in path-sensitive analyses.
2873 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002874 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002875 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002876 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002877 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002878 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002879 }
2880
Ted Kremenekb50e7162012-07-14 05:04:10 +00002881 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2882 // having these handle the actual control-flow jump. Note that
2883 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2884 // we resort to the old control-flow behavior. This special handling
2885 // removes infeasible paths from the control-flow graph by having the
2886 // control-flow transfer of '&&' or '||' go directly into the then/else
2887 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002888 BinaryOperator *Cond =
2889 I->getConditionVariable()
2890 ? nullptr
2891 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2892 CFGBlock *LastBlock;
2893 if (Cond && Cond->isLogicalOp())
2894 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2895 else {
2896 // Now create a new block containing the if statement.
2897 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002898
Richard Smith509bbd12017-01-13 22:16:41 +00002899 // Set the terminator of the new block to the If statement.
2900 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002901
Richard Smith509bbd12017-01-13 22:16:41 +00002902 // See if this is a known constant.
2903 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002904
Richard Smith509bbd12017-01-13 22:16:41 +00002905 // Add the successors. If we know that specific branches are
2906 // unreachable, inform addSuccessor() of that knowledge.
2907 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2908 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002909
Richard Smith509bbd12017-01-13 22:16:41 +00002910 // Add the condition as the last statement in the new block. This may
2911 // create new blocks as the condition may contain control-flow. Any newly
2912 // created blocks will be pointed to be "Block".
2913 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002914
Richard Smith509bbd12017-01-13 22:16:41 +00002915 // If the IfStmt contains a condition variable, add it and its
2916 // initializer to the CFG.
2917 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2918 autoCreateBlock();
2919 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2920 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002921 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002922
Richard Smitha547eb22016-07-14 00:11:03 +00002923 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2924 if (Stmt *Init = I->getInit()) {
2925 autoCreateBlock();
2926 LastBlock = addStmt(Init);
2927 }
2928
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002929 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002930}
Mike Stump31feda52009-07-17 01:31:16 +00002931
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002932CFGBlock *CFGBuilder::VisitReturnStmt(Stmt *S) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002933 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002934 //
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002935 // NOTE: If a "return" or "co_return" appears in the middle of a block, this
2936 // means that the code afterwards is DEAD (unreachable). We still keep
2937 // a basic block for that code; a simple "mark-and-sweep" from the entry
2938 // block will be able to report such dead blocks.
2939 assert(isa<ReturnStmt>(S) || isa<CoreturnStmt>(S));
Ted Kremenek9aae5132007-08-23 21:42:29 +00002940
2941 // Create the new block.
2942 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002943
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002944 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), S);
Pavel Labath921e7652013-09-06 08:12:48 +00002945
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002946 if (auto *R = dyn_cast<ReturnStmt>(S))
2947 findConstructionContexts(
2948 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
2949 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002950
Pavel Labath921e7652013-09-06 08:12:48 +00002951 // If the one of the destructors does not return, we already have the Exit
2952 // block as a successor.
2953 if (!Block->hasNoReturnElement())
2954 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002955
2956 // Add the return statement to the block. This may create new blocks if R
2957 // contains control-flow (short-circuit operations).
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002958 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002959}
2960
Nico Weber699670e2017-08-23 15:33:16 +00002961CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2962 // SEHExceptStmt are treated like labels, so they are the first statement in a
2963 // block.
2964
2965 // Save local scope position because in case of exception variable ScopePos
2966 // won't be restored when traversing AST.
2967 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2968
2969 addStmt(ES->getBlock());
2970 CFGBlock *SEHExceptBlock = Block;
2971 if (!SEHExceptBlock)
2972 SEHExceptBlock = createBlock();
2973
2974 appendStmt(SEHExceptBlock, ES);
2975
2976 // Also add the SEHExceptBlock as a label, like with regular labels.
2977 SEHExceptBlock->setLabel(ES);
2978
2979 // Bail out if the CFG is bad.
2980 if (badCFG)
2981 return nullptr;
2982
2983 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2984 Block = nullptr;
2985
2986 return SEHExceptBlock;
2987}
2988
2989CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2990 return VisitCompoundStmt(FS->getBlock());
2991}
2992
2993CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2994 // "__leave" is a control-flow statement. Thus we stop processing the current
2995 // block.
2996 if (badCFG)
2997 return nullptr;
2998
2999 // Now create a new block that ends with the __leave statement.
3000 Block = createBlock(false);
3001 Block->setTerminator(LS);
3002
3003 // If there is no target for the __leave, then we are looking at an incomplete
3004 // AST. This means that the CFG cannot be constructed.
3005 if (SEHLeaveJumpTarget.block) {
3006 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
3007 addSuccessor(Block, SEHLeaveJumpTarget.block);
3008 } else
3009 badCFG = true;
3010
3011 return Block;
3012}
3013
3014CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
3015 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
3016 // processing the current block.
3017 CFGBlock *SEHTrySuccessor = nullptr;
3018
3019 if (Block) {
3020 if (badCFG)
3021 return nullptr;
3022 SEHTrySuccessor = Block;
3023 } else SEHTrySuccessor = Succ;
3024
3025 // FIXME: Implement __finally support.
3026 if (Terminator->getFinallyHandler())
3027 return NYS();
3028
3029 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
3030
3031 // Create a new block that will contain the __try statement.
3032 CFGBlock *NewTryTerminatedBlock = createBlock(false);
3033
3034 // Add the terminator in the __try block.
3035 NewTryTerminatedBlock->setTerminator(Terminator);
3036
3037 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
3038 // The code after the try is the implicit successor if there's an __except.
3039 Succ = SEHTrySuccessor;
3040 Block = nullptr;
3041 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
3042 if (!ExceptBlock)
3043 return nullptr;
3044 // Add this block to the list of successors for the block with the try
3045 // statement.
3046 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
3047 }
3048 if (PrevSEHTryTerminatedBlock)
3049 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
3050 else
3051 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
3052
3053 // The code after the try is the implicit successor.
3054 Succ = SEHTrySuccessor;
3055
3056 // Save the current "__try" context.
3057 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
3058 NewTryTerminatedBlock);
3059 cfg->addTryDispatchBlock(TryTerminatedBlock);
3060
3061 // Save the current value for the __leave target.
3062 // All __leaves should go to the code following the __try
3063 // (FIXME: or if the __try has a __finally, to the __finally.)
3064 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
3065 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
3066
3067 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
3068 Block = nullptr;
3069 return addStmt(Terminator->getTryBlock());
3070}
3071
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003072CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003073 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00003074 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003075 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003076
Ted Kremenek93668002009-07-17 22:18:43 +00003077 if (!LabelBlock) // This can happen when the body is empty, i.e.
3078 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00003079
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003080 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
3081 "label already in map");
3082 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003083
3084 // Labels partition blocks, so this is the end of the basic block we were
3085 // processing (L is the block's label). Because this is label (and we have
3086 // already processed the substatement) there is no extra control-flow to worry
3087 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00003088 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003089 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003090 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003091
3092 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00003093 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003094
Ted Kremenek9aae5132007-08-23 21:42:29 +00003095 // This block is now the implicit successor of other blocks.
3096 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003097
Ted Kremenek9aae5132007-08-23 21:42:29 +00003098 return LabelBlock;
3099}
3100
Devin Coughlinb6029b72015-11-25 22:35:37 +00003101CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
3102 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3103 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
3104 if (Expr *CopyExpr = CI.getCopyExpr()) {
3105 CFGBlock *Tmp = Visit(CopyExpr);
3106 if (Tmp)
3107 LastBlock = Tmp;
3108 }
3109 }
3110 return LastBlock;
3111}
3112
Ted Kremenekda76a942012-04-12 20:34:52 +00003113CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
3114 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3115 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
3116 et = E->capture_init_end(); it != et; ++it) {
3117 if (Expr *Init = *it) {
3118 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00003119 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00003120 LastBlock = Tmp;
3121 }
3122 }
3123 return LastBlock;
3124}
Fangrui Song6907ce22018-07-30 19:24:48 +00003125
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003126CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003127 // Goto is a control-flow statement. Thus we stop processing the current
3128 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003129
Ted Kremenek9aae5132007-08-23 21:42:29 +00003130 Block = createBlock(false);
3131 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003132
3133 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003134 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003135
Ted Kremenek9aae5132007-08-23 21:42:29 +00003136 if (I == LabelMap.end())
3137 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003138 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3139 else {
3140 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003141 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003142 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003143 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003144
Mike Stump31feda52009-07-17 01:31:16 +00003145 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003146}
3147
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003148CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003149 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003150
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003151 // Save local scope position because in case of condition variable ScopePos
3152 // won't be restored when traversing AST.
3153 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3154
3155 // Create local scope for init statement and possible condition variable.
3156 // Add destructor for init statement and condition variable.
3157 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003158 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003159 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003160 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3161
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003162 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003163 addLocalScopeForVarDecl(VD);
3164 LocalScope::const_iterator ContinueScopePos = ScopePos;
3165
Matthias Gehre351c2182017-07-12 07:04:19 +00003166 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003167
Peter Szecsi999a25f2017-08-19 11:19:16 +00003168 addLoopExit(F);
3169
Mike Stump014b3ea2009-07-21 01:12:51 +00003170 // "for" is a control-flow statement. Thus we stop processing the current
3171 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003172 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003173 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003174 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003175 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003176 } else
3177 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003178
Ted Kremenek304a9532010-05-21 20:30:15 +00003179 // Save the current value for the break targets.
3180 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003181 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003182 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003183
Craig Topper25542942014-05-20 04:30:07 +00003184 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003185
Ted Kremenek9aae5132007-08-23 21:42:29 +00003186 // Now create the loop body.
3187 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003188 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003189
Ted Kremenekb50e7162012-07-14 05:04:10 +00003190 // Save the current values for Block, Succ, continue and break targets.
3191 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3192 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003193
Ted Kremenekb50e7162012-07-14 05:04:10 +00003194 // Create an empty block to represent the transition block for looping back
3195 // to the head of the loop. If we have increment code, it will
3196 // go in this block as well.
3197 Block = Succ = TransitionBlock = createBlock(false);
3198 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003199
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003200 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003201 // Generate increment code in its own basic block. This is the target of
3202 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003203 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003204 }
Mike Stump31feda52009-07-17 01:31:16 +00003205
Ted Kremenek902393b2009-04-28 00:51:56 +00003206 // Finish up the increment (or empty) block if it hasn't been already.
3207 if (Block) {
3208 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003209 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003210 return nullptr;
3211 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003212 }
Mike Stump31feda52009-07-17 01:31:16 +00003213
Ted Kremenekb50e7162012-07-14 05:04:10 +00003214 // The starting block for the loop increment is the block that should
3215 // represent the 'loop target' for looping back to the start of the loop.
3216 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3217 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003218
Ted Kremenekb50e7162012-07-14 05:04:10 +00003219 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003220 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003221
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003222 // If body is not a compound statement create implicit scope
3223 // and add destructors.
3224 if (!isa<CompoundStmt>(F->getBody()))
3225 addLocalScopeAndDtors(F->getBody());
3226
Mike Stump31feda52009-07-17 01:31:16 +00003227 // Now populate the body block, and in the process create new blocks as we
3228 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003229 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003230
Ted Kremenekb50e7162012-07-14 05:04:10 +00003231 if (!BodyBlock) {
3232 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3233 // Use the continue jump target as the proxy for the body.
3234 BodyBlock = ContinueJumpTarget.block;
3235 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003236 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003237 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003238 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003239
Ted Kremenekb50e7162012-07-14 05:04:10 +00003240 // Because of short-circuit evaluation, the condition of the loop can span
3241 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3242 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003243 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003244
Ted Kremenekb50e7162012-07-14 05:04:10 +00003245 do {
3246 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003247 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003248
3249 // Specially handle logical operators, which have a slightly
3250 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003251 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003252 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003253 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003254 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003255 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3256 break;
3257 }
3258
3259 // The default case when not handling logical operators.
3260 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3261 ExitConditionBlock->setTerminator(F);
3262
3263 // See if this is a known constant.
3264 TryResult KnownVal(true);
3265
3266 if (C) {
3267 // Now add the actual condition to the condition block.
3268 // Because the condition itself may contain control-flow, new blocks may
3269 // be created. Thus we update "Succ" after adding the condition.
3270 Block = ExitConditionBlock;
3271 EntryConditionBlock = addStmt(C);
3272
3273 // If this block contains a condition variable, add both the condition
3274 // variable and initializer to the CFG.
3275 if (VarDecl *VD = F->getConditionVariable()) {
3276 if (Expr *Init = VD->getInit()) {
3277 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003278 const DeclStmt *DS = F->getConditionVariableDeclStmt();
3279 assert(DS->isSingleDecl());
3280 findConstructionContexts(
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00003281 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003282 Init);
3283 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003284 EntryConditionBlock = addStmt(Init);
3285 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003286 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003287 }
3288 }
3289
3290 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003291 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003292
3293 KnownVal = tryEvaluateBool(C);
3294 }
3295
3296 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003297 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003298 // Link up the condition block with the code that follows the loop. (the
3299 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003300 addSuccessor(ExitConditionBlock,
3301 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003302 } while (false);
3303
3304 // Link up the loop-back block to the entry condition block.
3305 addSuccessor(TransitionBlock, EntryConditionBlock);
Fangrui Song6907ce22018-07-30 19:24:48 +00003306
Ted Kremenekb50e7162012-07-14 05:04:10 +00003307 // The condition block is the implicit successor for any code above the loop.
3308 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003309
Ted Kremenek9aae5132007-08-23 21:42:29 +00003310 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003311 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003312 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003313 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3314 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003315 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003316 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003317 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003318
3319 // There is no loop initialization. We are thus basically a while loop.
3320 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003321 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003322 Succ = EntryConditionBlock;
3323 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003324}
3325
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003326CFGBlock *
3327CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3328 AddStmtChoice asc) {
3329 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003330 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003331 MTE->getTemporary());
3332
3333 return VisitStmt(MTE, asc);
3334}
3335
Ted Kremenek5868ec62010-04-11 17:02:10 +00003336CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003337 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003338 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003339 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003340 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003341 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003342}
3343
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003344CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003345 // Objective-C fast enumeration 'for' statements:
3346 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3347 //
3348 // for ( Type newVariable in collection_expression ) { statements }
3349 //
3350 // becomes:
3351 //
3352 // prologue:
3353 // 1. collection_expression
3354 // T. jump to loop_entry
3355 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003356 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003357 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3358 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3359 // TB:
3360 // statements
3361 // T. jump to loop_entry
3362 // FB:
3363 // what comes after
3364 //
3365 // and
3366 //
3367 // Type existingItem;
3368 // for ( existingItem in expression ) { statements }
3369 //
3370 // becomes:
3371 //
Mike Stump31feda52009-07-17 01:31:16 +00003372 // the same with newVariable replaced with existingItem; the binding works
3373 // the same except that for one ObjCForCollectionStmt::getElement() returns
3374 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003375
Craig Topper25542942014-05-20 04:30:07 +00003376 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003377
Ted Kremenek9d56e642008-11-11 17:10:00 +00003378 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003379 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003380 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003381 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003382 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003383 } else
3384 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003385
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003386 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003387 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003388
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003389 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003390 ExitConditionBlock->setTerminator(S);
3391
3392 // The last statement in the block should be the ObjCForCollectionStmt, which
3393 // performs the actual binding to 'element' and determines if there are any
3394 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003395 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003396 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003397
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003398 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003399 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003400 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003401 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3402 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003403 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003404 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003405 return nullptr;
3406 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003407 }
Mike Stump31feda52009-07-17 01:31:16 +00003408
3409 // The condition block is the implicit successor for the loop body as well as
3410 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003411 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003412
Ted Kremenek9d56e642008-11-11 17:10:00 +00003413 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003414 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003415 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003416 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003417 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003418 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003419
Anna Zaks56b49752013-06-22 00:23:20 +00003420 // Add an intermediate block between the BodyBlock and the
3421 // EntryConditionBlock to represent the "loop back" transition, for looping
3422 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003423 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003424 Succ = LoopBackBlock = createBlock();
3425 LoopBackBlock->setLoopTarget(S);
Fangrui Song6907ce22018-07-30 19:24:48 +00003426
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003427 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003428 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003429
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003430 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003431
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003432 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003433 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003434 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003435 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003436 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003437 }
Mike Stump31feda52009-07-17 01:31:16 +00003438
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003439 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003440 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003441 }
Mike Stump31feda52009-07-17 01:31:16 +00003442
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003443 // Link up the condition block with the code that follows the loop.
3444 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003445 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003446
Ted Kremenek9d56e642008-11-11 17:10:00 +00003447 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003448 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003449 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003450}
3451
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003452CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3453 // Inline the body.
3454 return addStmt(S->getSubStmt());
3455 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3456}
3457
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003458CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003459 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003460
Ted Kremenek49805452009-05-02 01:49:13 +00003461 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003462 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003463
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003464 // The sync body starts its own basic block. This makes it a little easier
3465 // for diagnostic clients.
3466 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003467 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003468 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003469
Craig Topper25542942014-05-20 04:30:07 +00003470 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003471 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003472 }
Mike Stump31feda52009-07-17 01:31:16 +00003473
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003474 // Add the @synchronized to the CFG.
3475 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003476 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003477
Ted Kremenek49805452009-05-02 01:49:13 +00003478 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003479 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003480}
Mike Stump31feda52009-07-17 01:31:16 +00003481
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003482CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003483 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003484 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003485}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003486
John McCallfe96e0b2011-11-06 09:01:30 +00003487CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3488 autoCreateBlock();
3489
3490 // Add the PseudoObject as the last thing.
3491 appendStmt(Block, E);
3492
Fangrui Song6907ce22018-07-30 19:24:48 +00003493 CFGBlock *lastBlock = Block;
John McCallfe96e0b2011-11-06 09:01:30 +00003494
3495 // Before that, evaluate all of the semantics in order. In
3496 // CFG-land, that means appending them in reverse order.
3497 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3498 Expr *Semantic = E->getSemanticExpr(--i);
3499
3500 // If the semantic is an opaque value, we're being asked to bind
3501 // it to its source expression.
3502 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3503 Semantic = OVE->getSourceExpr();
3504
3505 if (CFGBlock *B = Visit(Semantic))
3506 lastBlock = B;
3507 }
3508
3509 return lastBlock;
3510}
3511
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003512CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003513 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003514
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003515 // Save local scope position because in case of condition variable ScopePos
3516 // won't be restored when traversing AST.
3517 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3518
3519 // Create local scope for possible condition variable.
3520 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003521 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003522 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003523 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003524 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003525 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003526 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003527
Mike Stump014b3ea2009-07-21 01:12:51 +00003528 // "while" is a control-flow statement. Thus we stop processing the current
3529 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003530 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003531 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003532 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003533 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003534 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003535 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003536 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003537 }
Mike Stump31feda52009-07-17 01:31:16 +00003538
Craig Topper25542942014-05-20 04:30:07 +00003539 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003540
Ted Kremenek9aae5132007-08-23 21:42:29 +00003541 // Process the loop body.
3542 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003543 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003544
Ted Kremenekb50e7162012-07-14 05:04:10 +00003545 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003546 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3547 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003548 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003549
Mike Stump31feda52009-07-17 01:31:16 +00003550 // Create an empty block to represent the transition block for looping back
3551 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003552 Succ = TransitionBlock = createBlock(false);
3553 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003554 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003555
Ted Kremenek9aae5132007-08-23 21:42:29 +00003556 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003557 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003558
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003559 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003560 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003561
3562 // If body is not a compound statement create implicit scope
3563 // and add destructors.
3564 if (!isa<CompoundStmt>(W->getBody()))
3565 addLocalScopeAndDtors(W->getBody());
3566
Ted Kremenek9aae5132007-08-23 21:42:29 +00003567 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003568 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003569
Ted Kremeneke9610502007-08-30 18:39:40 +00003570 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003571 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003572 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003573 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003574 }
3575
3576 // Because of short-circuit evaluation, the condition of the loop can span
3577 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3578 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003579 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003580
3581 do {
3582 Expr *C = W->getCond();
3583
3584 // Specially handle logical operators, which have a slightly
3585 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003586 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003587 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003588 std::tie(EntryConditionBlock, ExitConditionBlock) =
3589 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003590 break;
3591 }
3592
3593 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003594 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003595 ExitConditionBlock->setTerminator(W);
3596
3597 // Now add the actual condition to the condition block.
3598 // Because the condition itself may contain control-flow, new blocks may
3599 // be created. Thus we update "Succ" after adding the condition.
3600 Block = ExitConditionBlock;
3601 Block = EntryConditionBlock = addStmt(C);
3602
3603 // If this block contains a condition variable, add both the condition
3604 // variable and initializer to the CFG.
3605 if (VarDecl *VD = W->getConditionVariable()) {
3606 if (Expr *Init = VD->getInit()) {
3607 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003608 const DeclStmt *DS = W->getConditionVariableDeclStmt();
3609 assert(DS->isSingleDecl());
3610 findConstructionContexts(
3611 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3612 const_cast<DeclStmt *>(DS)),
3613 Init);
3614 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003615 EntryConditionBlock = addStmt(Init);
3616 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003617 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003618 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003619 }
Mike Stump31feda52009-07-17 01:31:16 +00003620
Ted Kremenekb50e7162012-07-14 05:04:10 +00003621 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003622 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003623
3624 // See if this is a known constant.
3625 const TryResult& KnownVal = tryEvaluateBool(C);
3626
Ted Kremenek30754282009-07-24 04:47:11 +00003627 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003628 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003629 // Link up the condition block with the code that follows the loop. (the
3630 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003631 addSuccessor(ExitConditionBlock,
3632 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003633 } while(false);
3634
3635 // Link up the loop-back block to the entry condition block.
3636 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003637
3638 // There can be no more statements in the condition block since we loop back
3639 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003640 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003641
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003642 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003643 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003644 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003645}
Mike Stump11289f42009-09-09 15:08:12 +00003646
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003647CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003648 // FIXME: For now we pretend that @catch and the code it contains does not
3649 // exit.
3650 return Block;
3651}
Mike Stump31feda52009-07-17 01:31:16 +00003652
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003653CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003654 // FIXME: This isn't complete. We basically treat @throw like a return
3655 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003656
Ted Kremenek0868eea2009-09-24 18:45:41 +00003657 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003658 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003659 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003660
Ted Kremenek93041ba2008-12-09 20:20:09 +00003661 // Create the new block.
3662 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003663
Ted Kremenek93041ba2008-12-09 20:20:09 +00003664 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003665 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003666
3667 // Add the statement to the block. This may create new blocks if S contains
3668 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003669 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003670}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003671
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003672CFGBlock *CFGBuilder::VisitObjCMessageExpr(ObjCMessageExpr *ME,
3673 AddStmtChoice asc) {
3674 findConstructionContextsForArguments(ME);
3675
3676 autoCreateBlock();
Artem Dergacheve1f30622018-07-31 19:46:14 +00003677 appendObjCMessage(Block, ME);
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003678
3679 return VisitChildren(ME);
3680}
3681
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003682CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003683 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003684 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003685 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003686
3687 // Create the new block.
3688 Block = createBlock(false);
3689
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003690 if (TryTerminatedBlock)
3691 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003692 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003693 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003694 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003695 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003696
3697 // Add the statement to the block. This may create new blocks if S contains
3698 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003699 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003700}
3701
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003702CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003703 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003704
Peter Szecsi999a25f2017-08-19 11:19:16 +00003705 addLoopExit(D);
3706
Mike Stump8d50b6a2009-07-21 01:27:50 +00003707 // "do...while" is a control-flow statement. Thus we stop processing the
3708 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003709 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003710 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003711 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003712 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003713 } else
3714 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003715
3716 // Because of short-circuit evaluation, the condition of the loop can span
3717 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3718 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003719 CFGBlock *ExitConditionBlock = createBlock(false);
3720 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003721
Ted Kremenek81e14852007-08-27 19:46:09 +00003722 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003723 ExitConditionBlock->setTerminator(D);
3724
3725 // Now add the actual condition to the condition block. Because the condition
3726 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003727 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003728 Block = ExitConditionBlock;
3729 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003730 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003731 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003732 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003733 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003734 }
Mike Stump31feda52009-07-17 01:31:16 +00003735
Ted Kremeneka1523a32008-02-27 07:20:00 +00003736 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003737 Succ = EntryConditionBlock;
3738
Mike Stump773582d2009-07-23 23:25:26 +00003739 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003740 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003741
Ted Kremenek9aae5132007-08-23 21:42:29 +00003742 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003743 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003744 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003745 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003746
Ted Kremenek9aae5132007-08-23 21:42:29 +00003747 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003748 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3749 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3750 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003751
Ted Kremenek9aae5132007-08-23 21:42:29 +00003752 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003753 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003754
Ted Kremenek9aae5132007-08-23 21:42:29 +00003755 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003756 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003757
Ted Kremenek9aae5132007-08-23 21:42:29 +00003758 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003759 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003760
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003761 // If body is not a compound statement create implicit scope
3762 // and add destructors.
3763 if (!isa<CompoundStmt>(D->getBody()))
3764 addLocalScopeAndDtors(D->getBody());
3765
Ted Kremenek9aae5132007-08-23 21:42:29 +00003766 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003767 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003768
Ted Kremeneke9610502007-08-30 18:39:40 +00003769 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003770 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003771 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003772 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003773 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003774 }
Mike Stump31feda52009-07-17 01:31:16 +00003775
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003776 // Add an intermediate block between the BodyBlock and the
3777 // ExitConditionBlock to represent the "loop back" transition. Create an
3778 // empty block to represent the transition block for looping back to the
3779 // head of the loop.
3780 // FIXME: Can we do this more efficiently without adding another block?
3781 Block = nullptr;
3782 Succ = BodyBlock;
3783 CFGBlock *LoopBackBlock = createBlock();
3784 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003785
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003786 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003787 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003788 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003789 else
Craig Topper25542942014-05-20 04:30:07 +00003790 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003791 }
Mike Stump31feda52009-07-17 01:31:16 +00003792
Ted Kremenek30754282009-07-24 04:47:11 +00003793 // Link up the condition block with the code that follows the loop.
3794 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003795 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003796
3797 // There can be no more statements in the body block(s) since we loop back to
3798 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003799 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003800
Ted Kremenek9aae5132007-08-23 21:42:29 +00003801 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003802 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003803 return BodyBlock;
3804}
3805
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003806CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003807 // "continue" is a control-flow statement. Thus we stop processing the
3808 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003809 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003810 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003811
Ted Kremenek9aae5132007-08-23 21:42:29 +00003812 // Now create a new block that ends with the continue statement.
3813 Block = createBlock(false);
3814 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003815
Ted Kremenek9aae5132007-08-23 21:42:29 +00003816 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003817 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003818 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003819 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003820 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003821 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003822 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003823
Ted Kremenek9aae5132007-08-23 21:42:29 +00003824 return Block;
3825}
Mike Stump11289f42009-09-09 15:08:12 +00003826
Peter Collingbournee190dee2011-03-11 19:24:49 +00003827CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3828 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003829 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003830 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003831 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003832 }
Mike Stump11289f42009-09-09 15:08:12 +00003833
Ted Kremenek93668002009-07-17 22:18:43 +00003834 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003835 CFGBlock *lastBlock = Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00003836
Ted Kremenek93668002009-07-17 22:18:43 +00003837 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003838 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003839 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003840 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003841 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003842 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003843}
Mike Stump11289f42009-09-09 15:08:12 +00003844
Ted Kremenek93668002009-07-17 22:18:43 +00003845/// VisitStmtExpr - Utility method to handle (nested) statement
3846/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003847CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003848 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003849 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003850 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003851 }
Ted Kremenek93668002009-07-17 22:18:43 +00003852 return VisitCompoundStmt(SE->getSubStmt());
3853}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003854
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003855CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003856 // "switch" is a control-flow statement. Thus we stop processing the current
3857 // block.
Craig Topper25542942014-05-20 04:30:07 +00003858 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003859
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003860 // Save local scope position because in case of condition variable ScopePos
3861 // won't be restored when traversing AST.
3862 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3863
Richard Smitha547eb22016-07-14 00:11:03 +00003864 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003865 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003866 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003867
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003868 // Create local scope for possible condition variable.
3869 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003870 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003871 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003872
Matthias Gehre351c2182017-07-12 07:04:19 +00003873 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003874
Ted Kremenek9aae5132007-08-23 21:42:29 +00003875 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003876 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003877 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003878 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003879 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003880
3881 // Save the current "switch" context.
3882 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003883 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003884 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003885
Mike Stump31feda52009-07-17 01:31:16 +00003886 // Set the "default" case to be the block after the switch statement. If the
3887 // switch statement contains a "default:", this value will be overwritten with
3888 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003889 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003890
Ted Kremenek9aae5132007-08-23 21:42:29 +00003891 // Create a new block that will contain the switch statement.
3892 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003893
Ted Kremenek9aae5132007-08-23 21:42:29 +00003894 // Now process the switch body. The code after the switch is the implicit
3895 // successor.
3896 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003897 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003898
3899 // When visiting the body, the case statements should automatically get linked
3900 // up to the switch. We also don't keep a pointer to the body, since all
3901 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003902 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003903 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003904
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003905 // For pruning unreachable case statements, save the current state
3906 // for tracking the condition value.
3907 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3908 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003909
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003910 // Determine if the switch condition can be explicitly evaluated.
3911 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003912 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003913 bool b = tryEvaluate(Terminator->getCond(), result);
3914 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003915 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003916
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003917 // If body is not a compound statement create implicit scope
3918 // and add destructors.
3919 if (!isa<CompoundStmt>(Terminator->getBody()))
3920 addLocalScopeAndDtors(Terminator->getBody());
3921
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003922 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003923 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003924 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003925 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003926 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003927
Mike Stump31feda52009-07-17 01:31:16 +00003928 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003929 // following the switch body. Moreover, take into account if all the
3930 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003931 //
3932 // Note: We add a successor to a switch that is considered covered yet has no
3933 // case statements if the enumeration has no enumerators.
3934 bool SwitchAlwaysHasSuccessor = false;
3935 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3936 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3937 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003938 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3939 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003940
Ted Kremenek81e14852007-08-27 19:46:09 +00003941 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003942 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003943 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003944 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003945
Richard Smitha547eb22016-07-14 00:11:03 +00003946 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003947 // SwitchStmt and the condition variable initialization to the CFG.
3948 if (VarDecl *VD = Terminator->getConditionVariable()) {
3949 if (Expr *Init = VD->getInit()) {
3950 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003951 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003952 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003953 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003954 }
3955 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003956
Richard Smitha547eb22016-07-14 00:11:03 +00003957 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3958 if (Stmt *Init = Terminator->getInit()) {
3959 autoCreateBlock();
3960 LastBlock = addStmt(Init);
3961 }
3962
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003963 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003964}
Fangrui Song6907ce22018-07-30 19:24:48 +00003965
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003966static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003967 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003968 const CaseStmt *CS,
3969 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003970 if (!switchCond)
3971 return true;
3972
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003973 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003974
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003975 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003976 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003977 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003978 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003979 const llvm::APSInt &condInt = switchCond->Val.getInt();
Fangrui Song6907ce22018-07-30 19:24:48 +00003980
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003981 if (condInt == lhsInt) {
3982 addCase = true;
3983 switchExclusivelyCovered = true;
3984 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003985 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003986 if (const Expr *RHS = CS->getRHS()) {
3987 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003988 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003989 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003990 addCase = true;
3991 switchExclusivelyCovered = true;
3992 }
3993 }
3994 }
3995 }
3996 else
3997 addCase = true;
3998 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003999 return addCase;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004000}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004001
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004002CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00004003 // CaseStmts are essentially labels, so they are the first statement in a
4004 // block.
Craig Topper25542942014-05-20 04:30:07 +00004005 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00004006
Ted Kremenek60fa6572010-08-04 23:54:30 +00004007 if (Stmt *Sub = CS->getSubStmt()) {
4008 // For deeply nested chains of CaseStmts, instead of doing a recursion
4009 // (which can blow out the stack), manually unroll and create blocks
4010 // along the way.
4011 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004012 CFGBlock *currentBlock = createBlock(false);
4013 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00004014
Ted Kremenek60fa6572010-08-04 23:54:30 +00004015 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004016 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004017 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004018 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00004019
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004020 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00004021 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004022 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00004023 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004024
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004025 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00004026 CS = cast<CaseStmt>(Sub);
4027 Sub = CS->getSubStmt();
4028 }
4029
4030 addStmt(Sub);
4031 }
Mike Stump11289f42009-09-09 15:08:12 +00004032
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004033 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004034 if (!CaseBlock)
4035 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004036
4037 // Cases statements partition blocks, so this is the top of the basic block we
4038 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00004039 CaseBlock->setLabel(CS);
4040
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004041 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004042 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004043
4044 // Add this block to the list of successors for the block with the switch
4045 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00004046 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004047 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00004048 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004049 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00004050
Ted Kremenek9aae5132007-08-23 21:42:29 +00004051 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004052 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004053
Ted Kremenek60fa6572010-08-04 23:54:30 +00004054 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004055 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004056 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004057 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00004058 // This block is now the implicit successor of other blocks.
4059 Succ = CaseBlock;
4060 }
Mike Stump31feda52009-07-17 01:31:16 +00004061
Ted Kremenek60fa6572010-08-04 23:54:30 +00004062 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00004063}
Mike Stump31feda52009-07-17 01:31:16 +00004064
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004065CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00004066 if (Terminator->getSubStmt())
4067 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00004068
Ted Kremenek654c78f2008-02-13 22:05:39 +00004069 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004070
4071 if (!DefaultCaseBlock)
4072 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004073
4074 // Default statements partition blocks, so this is the top of the basic block
4075 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004076 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00004077
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004078 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004079 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00004080
Mike Stump31feda52009-07-17 01:31:16 +00004081 // Unlike case statements, we don't add the default block to the successors
4082 // for the switch statement immediately. This is done when we finish
4083 // processing the switch statement. This allows for the default case
4084 // (including a fall-through to the code after the switch statement) to always
4085 // be the last successor of a switch-terminated block.
4086
Ted Kremenek654c78f2008-02-13 22:05:39 +00004087 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004088 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004089
Ted Kremenek654c78f2008-02-13 22:05:39 +00004090 // This block is now the implicit successor of other blocks.
4091 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00004092
4093 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00004094}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004095
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004096CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
4097 // "try"/"catch" is a control-flow statement. Thus we stop processing the
4098 // current block.
Craig Topper25542942014-05-20 04:30:07 +00004099 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004100
4101 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004102 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004103 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004104 TrySuccessor = Block;
4105 } else TrySuccessor = Succ;
4106
Mike Stump0bdba6c2010-01-20 01:15:34 +00004107 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004108
4109 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00004110 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004111 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00004112 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004113
Mike Stump0bdba6c2010-01-20 01:15:34 +00004114 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004115 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
4116 // The code after the try is the implicit successor.
4117 Succ = TrySuccessor;
4118 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00004119 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00004120 HasCatchAll = true;
4121 }
Craig Topper25542942014-05-20 04:30:07 +00004122 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004123 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00004124 if (!CatchBlock)
4125 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004126 // Add this block to the list of successors for the block with the try
4127 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004128 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004129 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00004130 if (!HasCatchAll) {
4131 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004132 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00004133 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004134 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00004135 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004136
4137 // The code after the try is the implicit successor.
4138 Succ = TrySuccessor;
4139
Mike Stump845384a2010-01-20 01:30:58 +00004140 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00004141 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
4142 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00004143
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004144 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004145 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004146 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004147}
4148
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004149CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004150 // CXXCatchStmt are treated like labels, so they are the first statement in a
4151 // block.
4152
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004153 // Save local scope position because in case of exception variable ScopePos
4154 // won't be restored when traversing AST.
4155 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4156
4157 // Create local scope for possible exception variable.
4158 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004159 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004160 LocalScope::const_iterator BeginScopePos = ScopePos;
4161 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004162 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004163 }
4164
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004165 if (CS->getHandlerBlock())
4166 addStmt(CS->getHandlerBlock());
4167
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004168 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004169 if (!CatchBlock)
4170 CatchBlock = createBlock();
Fangrui Song6907ce22018-07-30 19:24:48 +00004171
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004172 // CXXCatchStmt is more than just a label. They have semantic meaning
4173 // as well, as they implicitly "initialize" the catch variable. Add
4174 // it to the CFG as a CFGElement so that the control-flow of these
4175 // semantics gets captured.
4176 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004177
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004178 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4179 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004180 CatchBlock->setLabel(CS);
4181
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004182 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004183 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004184 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004185
4186 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004187 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004188
4189 return CatchBlock;
4190}
4191
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004192CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004193 // C++0x for-range statements are specified as [stmt.ranged]:
4194 //
4195 // {
4196 // auto && __range = range-init;
4197 // for ( auto __begin = begin-expr,
4198 // __end = end-expr;
4199 // __begin != __end;
4200 // ++__begin ) {
4201 // for-range-declaration = *__begin;
4202 // statement
4203 // }
4204 // }
4205
4206 // Save local scope position before the addition of the implicit variables.
4207 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4208
4209 // Create local scopes and destructors for range, begin and end variables.
4210 if (Stmt *Range = S->getRangeStmt())
4211 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004212 if (Stmt *Begin = S->getBeginStmt())
4213 addLocalScopeForStmt(Begin);
4214 if (Stmt *End = S->getEndStmt())
4215 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004216 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004217
4218 LocalScope::const_iterator ContinueScopePos = ScopePos;
4219
4220 // "for" is a control-flow statement. Thus we stop processing the current
4221 // block.
Craig Topper25542942014-05-20 04:30:07 +00004222 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004223 if (Block) {
4224 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004225 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004226 LoopSuccessor = Block;
4227 } else
4228 LoopSuccessor = Succ;
4229
4230 // Save the current value for the break targets.
4231 // All breaks should go to the code following the loop.
4232 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4233 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4234
4235 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004236 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004237 ConditionBlock->setTerminator(S);
4238
4239 // Now add the actual condition to the condition block.
4240 if (Expr *C = S->getCond()) {
4241 Block = ConditionBlock;
4242 CFGBlock *BeginConditionBlock = addStmt(C);
4243 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004244 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004245 assert(BeginConditionBlock == ConditionBlock &&
4246 "condition block in for-range was unexpectedly complex");
4247 (void)BeginConditionBlock;
4248 }
4249
4250 // The condition block is the implicit successor for the loop body as well as
4251 // any code above the loop.
4252 Succ = ConditionBlock;
4253
4254 // See if this is a known constant.
4255 TryResult KnownVal(true);
4256
4257 if (S->getCond())
4258 KnownVal = tryEvaluateBool(S->getCond());
4259
4260 // Now create the loop body.
4261 {
4262 assert(S->getBody());
4263
4264 // Save the current values for Block, Succ, and continue targets.
4265 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4266 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4267
4268 // Generate increment code in its own basic block. This is the target of
4269 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004270 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004271 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004272 if (badCFG)
4273 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004274 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4275
4276 // The starting block for the loop increment is the block that should
4277 // represent the 'loop target' for looping back to the start of the loop.
4278 ContinueJumpTarget.block->setLoopTarget(S);
4279
4280 // Finish up the increment block and prepare to start the loop body.
4281 assert(Block);
4282 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004283 return nullptr;
4284 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004285
4286 // Add implicit scope and dtors for loop variable.
4287 addLocalScopeAndDtors(S->getLoopVarStmt());
4288
4289 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004290 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004291 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004292 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004293 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004294 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004295 return nullptr;
4296
Richard Smith02e85f32011-04-14 22:09:26 +00004297 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004298 addSuccessor(ConditionBlock,
4299 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004300 }
4301
4302 // Link up the condition block with the code that follows the loop (the
4303 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004304 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004305
4306 // Add the initialization statements.
4307 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004308 addStmt(S->getBeginStmt());
4309 addStmt(S->getEndStmt());
Richard Smith8baa5002018-09-28 18:44:09 +00004310 CFGBlock *Head = addStmt(S->getRangeStmt());
4311 if (S->getInit())
4312 Head = addStmt(S->getInit());
4313 return Head;
Richard Smith02e85f32011-04-14 22:09:26 +00004314}
4315
John McCall5d413782010-12-06 08:20:24 +00004316CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004317 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004318 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004319 // If adding implicit destructors visit the full expression for adding
4320 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004321 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004322 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004323
4324 // Full expression has to be added as CFGStmt so it will be sequenced
4325 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004326 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004327 }
4328 return Visit(E->getSubExpr(), asc);
4329}
4330
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004331CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4332 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004333 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004334 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004335 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004336
Artem Dergachev783a4572018-02-23 22:20:39 +00004337 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004338 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004339 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004340
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004341 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004342 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004343 }
4344 return Visit(E->getSubExpr(), asc);
4345}
4346
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004347CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4348 AddStmtChoice asc) {
Artem Dergachevbd880fe2018-07-31 19:39:37 +00004349 // If the constructor takes objects as arguments by value, we need to properly
4350 // construct these objects. Construction contexts we find here aren't for the
4351 // constructor C, they're for its arguments only.
4352 findConstructionContextsForArguments(C);
4353
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004354 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004355 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004356
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004357 return VisitChildren(C);
4358}
4359
Jordan Rosec9176072014-01-13 17:59:19 +00004360CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4361 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004362 autoCreateBlock();
4363 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004364
Artem Dergachev783a4572018-02-23 22:20:39 +00004365 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004366 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004367 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004368
Jordan Rosec9176072014-01-13 17:59:19 +00004369 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004370 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004371
Jordan Rosec9176072014-01-13 17:59:19 +00004372 if (BuildOpts.AddCXXNewAllocator)
4373 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004374
Richard Smithb9fb1212019-05-06 03:47:15 +00004375 if (NE->isArray() && *NE->getArraySize())
4376 Block = Visit(*NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004377
Jordan Rosec9176072014-01-13 17:59:19 +00004378 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4379 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004380 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004381
Jordan Rosec9176072014-01-13 17:59:19 +00004382 return Block;
4383}
Jordan Rosed2f40792013-09-03 17:00:57 +00004384
4385CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4386 AddStmtChoice asc) {
4387 autoCreateBlock();
4388 appendStmt(Block, DE);
4389 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004390 if (!DTy.isNull()) {
4391 DTy = DTy.getNonReferenceType();
4392 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4393 if (RD) {
4394 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4395 appendDeleteDtor(Block, RD, DE);
4396 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004397 }
4398
4399 return VisitChildren(DE);
4400}
4401
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004402CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4403 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004404 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004405 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004406 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004407 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004408 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004409 }
4410 return Visit(E->getSubExpr(), asc);
4411}
4412
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004413CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4414 AddStmtChoice asc) {
Artem Dergachevc531d542018-08-14 21:10:46 +00004415 // If the constructor takes objects as arguments by value, we need to properly
4416 // construct these objects. Construction contexts we find here aren't for the
4417 // constructor C, they're for its arguments only.
4418 findConstructionContextsForArguments(C);
4419
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004420 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004421 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004422 return VisitChildren(C);
4423}
4424
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004425CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4426 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004427 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004428 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004429 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004430 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004431 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004432}
4433
Bill Wendling8003edc2018-11-09 00:41:36 +00004434CFGBlock *CFGBuilder::VisitConstantExpr(ConstantExpr *E, AddStmtChoice asc) {
4435 return Visit(E->getSubExpr(), AddStmtChoice());
4436}
4437
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004438CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004439 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004440 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004441
Ted Kremenekeda180e22007-08-28 19:26:49 +00004442 if (!IBlock) {
4443 IBlock = createBlock(false);
4444 cfg->setIndirectGotoBlock(IBlock);
4445 }
Mike Stump31feda52009-07-17 01:31:16 +00004446
Ted Kremenekeda180e22007-08-28 19:26:49 +00004447 // IndirectGoto is a control-flow statement. Thus we stop processing the
4448 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004449 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004450 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004451
Ted Kremenekeda180e22007-08-28 19:26:49 +00004452 Block = createBlock(false);
4453 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004454 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004455 return addStmt(I->getTarget());
4456}
4457
Manuel Klimekb5616c92014-08-07 10:42:17 +00004458CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4459 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004460 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4461
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004462tryAgain:
4463 if (!E) {
4464 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004465 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004466 }
4467 switch (E->getStmtClass()) {
4468 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004469 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004470
4471 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004472 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4473 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004474
4475 case Stmt::CXXBindTemporaryExprClass:
4476 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004477 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004478
John McCallc07a0c72011-02-17 10:25:35 +00004479 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004480 case Stmt::ConditionalOperatorClass:
4481 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004482 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004483
4484 case Stmt::ImplicitCastExprClass:
4485 // For implicit cast we want BindToTemporary to be passed further.
4486 E = cast<CastExpr>(E)->getSubExpr();
4487 goto tryAgain;
4488
Manuel Klimekb0042c42014-07-30 08:34:42 +00004489 case Stmt::CXXFunctionalCastExprClass:
4490 // For functional cast we want BindToTemporary to be passed further.
4491 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4492 goto tryAgain;
4493
Bill Wendling8003edc2018-11-09 00:41:36 +00004494 case Stmt::ConstantExprClass:
4495 E = cast<ConstantExpr>(E)->getSubExpr();
4496 goto tryAgain;
4497
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004498 case Stmt::ParenExprClass:
4499 E = cast<ParenExpr>(E)->getSubExpr();
4500 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004501
Manuel Klimekb0042c42014-07-30 08:34:42 +00004502 case Stmt::MaterializeTemporaryExprClass: {
4503 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4504 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4505 SmallVector<const Expr *, 2> CommaLHSs;
4506 SmallVector<SubobjectAdjustment, 2> Adjustments;
4507 // Find the expression whose lifetime needs to be extended.
4508 E = const_cast<Expr *>(
4509 cast<MaterializeTemporaryExpr>(E)
4510 ->GetTemporaryExpr()
4511 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4512 // Visit the skipped comma operator left-hand sides for other temporaries.
4513 for (const Expr *CommaLHS : CommaLHSs) {
4514 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004515 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004516 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004517 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004518 }
Richard Smith4137af22014-07-27 05:12:49 +00004519
4520 case Stmt::BlockExprClass:
4521 // Don't recurse into blocks; their subexpressions don't get evaluated
4522 // here.
4523 return Block;
4524
4525 case Stmt::LambdaExprClass: {
4526 // For lambda expressions, only recurse into the capture initializers,
4527 // and not the body.
4528 auto *LE = cast<LambdaExpr>(E);
4529 CFGBlock *B = Block;
4530 for (Expr *Init : LE->capture_inits()) {
Richard Smith7ed5fb22018-07-27 17:13:18 +00004531 if (Init) {
4532 if (CFGBlock *R = VisitForTemporaryDtors(
4533 Init, /*BindToTemporary=*/false, Context))
4534 B = R;
4535 }
Richard Smith4137af22014-07-27 05:12:49 +00004536 }
4537 return B;
4538 }
4539
4540 case Stmt::CXXDefaultArgExprClass:
4541 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4542 goto tryAgain;
4543
4544 case Stmt::CXXDefaultInitExprClass:
4545 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4546 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004547 }
4548}
4549
Manuel Klimekb5616c92014-08-07 10:42:17 +00004550CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4551 TempDtorContext &Context) {
4552 if (isa<LambdaExpr>(E)) {
4553 // Do not visit the children of lambdas; they have their own CFGs.
4554 return Block;
4555 }
4556
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004557 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004558 // order that they will appear in the CFG. Because the CFG is built
4559 // bottom-up, this means we visit them in their natural order, which
4560 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004561 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004562 for (Stmt *Child : E->children())
4563 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004564 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004565 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004566
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004567 return B;
4568}
4569
Manuel Klimekb5616c92014-08-07 10:42:17 +00004570CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4571 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004572 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004573 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004574 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4575 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4576 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004577
Manuel Klimekedf925b92014-08-07 18:44:19 +00004578 // We do not know at CFG-construction time whether the right-hand-side was
4579 // executed, thus we add a branch node that depends on the temporary
4580 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004581 TempDtorContext RHSContext(
4582 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004583 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004584 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004585
Manuel Klimekb5616c92014-08-07 10:42:17 +00004586 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004587 }
4588
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004589 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004590 // For assignment operator (=) LHS expression is visited
4591 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004592 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4593 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004594 return LHSBlock ? LHSBlock : RHSBlock;
4595 }
4596
4597 // For any other binary operator RHS expression is visited before
4598 // LHS expression (order of children). For destructors visit them in reverse
4599 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004600 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4601 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004602 return RHSBlock ? RHSBlock : LHSBlock;
4603}
4604
4605CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004606 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004607 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004608 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004609 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004610 // If lifetime of temporary is not prolonged (by assigning to constant
4611 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004612
Chandler Carruthad747252011-09-13 06:09:01 +00004613 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004614
Richard Trieu95a192a2015-05-28 00:14:02 +00004615 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004616 // If the destructor is marked as a no-return destructor, we need to
4617 // create a new block for the destructor which does not have as a
4618 // successor anything built thus far. Control won't flow out of this
4619 // block.
4620 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004621 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004622 } else if (Context.needsTempDtorBranch()) {
4623 // If we need to introduce a branch, we add a new block that we will hook
4624 // up to a decision block later.
4625 if (B) Succ = B;
4626 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004627 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004628 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004629 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004630 if (Context.needsTempDtorBranch()) {
4631 Context.setDecisionPoint(Succ, E);
4632 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004633 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004634
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004635 B = Block;
4636 }
4637 return B;
4638}
4639
Manuel Klimekb5616c92014-08-07 10:42:17 +00004640void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4641 CFGBlock *FalseSucc) {
4642 if (!Context.TerminatorExpr) {
4643 // If no temporary was found, we do not need to insert a decision point.
4644 return;
4645 }
4646 assert(Context.TerminatorExpr);
4647 CFGBlock *Decision = createBlock(false);
Artem Dergachev4e530322019-05-24 01:34:22 +00004648 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr,
4649 CFGTerminator::TemporaryDtorsBranch));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004650 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004651 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004652 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004653 Block = Decision;
4654}
4655
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004656CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004657 AbstractConditionalOperator *E, bool BindToTemporary,
4658 TempDtorContext &Context) {
4659 VisitForTemporaryDtors(E->getCond(), false, Context);
4660 CFGBlock *ConditionBlock = Block;
4661 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004662 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004663 TryResult NegatedVal = ConditionVal;
4664 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004665
Manuel Klimekdeb02622014-08-08 07:37:13 +00004666 TempDtorContext TrueContext(
4667 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004668 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004669 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004670
Manuel Klimekb5616c92014-08-07 10:42:17 +00004671 Block = ConditionBlock;
4672 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004673 TempDtorContext FalseContext(
4674 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004675 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004676
Manuel Klimekb5616c92014-08-07 10:42:17 +00004677 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004678 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004679 } else if (TrueContext.TerminatorExpr) {
4680 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004681 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004682 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004683 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004684 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004685 return Block;
4686}
4687
Mike Stump31feda52009-07-17 01:31:16 +00004688/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4689/// no successors or predecessors. If this is the first block created in the
4690/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004691CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004692 bool first_block = begin() == end();
4693
4694 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004695 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004696 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004697 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004698
4699 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004700 if (first_block)
4701 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004702
4703 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004704 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004705}
4706
David Blaikiee90195c2014-08-29 18:53:26 +00004707/// buildCFG - Constructs a CFG from an AST.
4708std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4709 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004710 CFGBuilder Builder(C, BO);
4711 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004712}
4713
Artem Dergachevab7747b2019-04-30 03:01:02 +00004714bool CFG::isLinear() const {
4715 // Quick path: if we only have the ENTRY block, the EXIT block, and some code
4716 // in between, then we have no room for control flow.
4717 if (size() <= 3)
4718 return true;
4719
4720 // Traverse the CFG until we find a branch.
4721 // TODO: While this should still be very fast,
4722 // maybe we should cache the answer.
4723 llvm::SmallPtrSet<const CFGBlock *, 4> Visited;
4724 const CFGBlock *B = Entry;
4725 while (B != Exit) {
4726 auto IteratorAndFlag = Visited.insert(B);
4727 if (!IteratorAndFlag.second) {
4728 // We looped back to a block that we've already visited. Not linear.
4729 return false;
4730 }
4731
4732 // Iterate over reachable successors.
4733 const CFGBlock *FirstReachableB = nullptr;
4734 for (const CFGBlock::AdjacentBlock &AB : B->succs()) {
4735 if (!AB.isReachable())
4736 continue;
4737
4738 if (FirstReachableB == nullptr) {
4739 FirstReachableB = &*AB;
4740 } else {
4741 // We've encountered a branch. It's not a linear CFG.
4742 return false;
4743 }
4744 }
4745
4746 if (!FirstReachableB) {
4747 // We reached a dead end. EXIT is unreachable. This is linear enough.
4748 return true;
4749 }
4750
4751 // There's only one way to move forward. Proceed.
4752 B = FirstReachableB;
4753 }
4754
4755 // We reached EXIT and found no branches.
4756 return true;
4757}
4758
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004759const CXXDestructorDecl *
4760CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004761 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004762 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004763 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004764 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004765 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004766 case CFGElement::Statement:
4767 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004768 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004769 case CFGElement::ScopeBegin:
4770 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004771 llvm_unreachable("getDestructorDecl should only be used with "
4772 "ImplicitDtors");
4773 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004774 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004775 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004776
4777 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4778 //
4779 // Lifetime-extending constructs are handled here. This works for a single
4780 // temporary in an initializer expression.
4781 if (ty->isReferenceType()) {
4782 if (const Expr *Init = var->getInit()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00004783 ty = getReferenceInitTemporaryType(Init);
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004784 }
4785 }
4786
Ted Kremeneke7d78882012-03-19 23:48:41 +00004787 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004788 ty = arrayType->getElementType();
4789 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004790 const RecordType *recordType = ty->getAs<RecordType>();
4791 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004792 cast<CXXRecordDecl>(recordType->getDecl());
Fangrui Song6907ce22018-07-30 19:24:48 +00004793 return classDecl->getDestructor();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004794 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004795 case CFGElement::DeleteDtor: {
4796 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4797 QualType DTy = DE->getDestroyedType();
4798 DTy = DTy.getNonReferenceType();
4799 const CXXRecordDecl *classDecl =
4800 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4801 return classDecl->getDestructor();
4802 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004803 case CFGElement::TemporaryDtor: {
4804 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004805 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004806 const CXXTemporary *temp = bindExpr->getTemporary();
4807 return temp->getDestructor();
4808 }
4809 case CFGElement::BaseDtor:
4810 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004811 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004812 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004813 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004814 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004815}
4816
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004817bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004818 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4819 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004820 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004821}
4822
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004823//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004824// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004825//===----------------------------------------------------------------------===//
4826
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004827CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004828 : ReachableBlock(IsReachable ? B : nullptr),
4829 UnreachableBlock(!IsReachable ? B : nullptr,
4830 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004831
4832CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004833 : ReachableBlock(B),
4834 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4835 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004836
4837void CFGBlock::addSuccessor(AdjacentBlock Succ,
4838 BumpVectorContext &C) {
4839 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004840 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004841
4842 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004843 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004844
4845 Succs.push_back(Succ, C);
4846}
4847
Ted Kremenekb0371852010-09-09 00:06:04 +00004848bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004849 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004850 if (F.IgnoreNullPredecessors && !From)
4851 return true;
4852
4853 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004854 // If the 'To' has no label or is labeled but the label isn't a
4855 // CaseStmt then filter this edge.
4856 if (const SwitchStmt *S =
Artem Dergachev4e530322019-05-24 01:34:22 +00004857 dyn_cast_or_null<SwitchStmt>(From->getTerminatorStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004858 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004859 const Stmt *L = To->getLabel();
4860 if (!L || !isa<CaseStmt>(L))
4861 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004862 }
4863 }
4864 }
4865
4866 return false;
4867}
4868
4869//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004870// CFG pretty printing
4871//===----------------------------------------------------------------------===//
4872
Ted Kremenek7e776b12007-08-22 18:22:34 +00004873namespace {
4874
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004875class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004876 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4877 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4878
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004879 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004880 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004881 signed currentBlock = 0;
4882 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004883 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004884
Eugene Zelenko38c70522017-12-07 21:55:09 +00004885public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004886 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004887 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004888 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4889 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004890 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Fangrui Song6907ce22018-07-30 19:24:48 +00004891 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004892 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4893 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004894 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004895 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004896
Ted Kremenek96a7a592011-03-01 03:15:10 +00004897 switch (stmt->getStmtClass()) {
4898 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004899 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4900 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004901 case Stmt::IfStmtClass: {
4902 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4903 if (var)
4904 DeclMap[var] = P;
4905 break;
4906 }
4907 case Stmt::ForStmtClass: {
4908 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4909 if (var)
4910 DeclMap[var] = P;
4911 break;
4912 }
4913 case Stmt::WhileStmtClass: {
4914 const VarDecl *var =
4915 cast<WhileStmt>(stmt)->getConditionVariable();
4916 if (var)
4917 DeclMap[var] = P;
4918 break;
4919 }
4920 case Stmt::SwitchStmtClass: {
4921 const VarDecl *var =
4922 cast<SwitchStmt>(stmt)->getConditionVariable();
4923 if (var)
4924 DeclMap[var] = P;
4925 break;
4926 }
4927 case Stmt::CXXCatchStmtClass: {
4928 const VarDecl *var =
4929 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4930 if (var)
4931 DeclMap[var] = P;
4932 break;
4933 }
4934 default:
4935 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004936 }
4937 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004938 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004939 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004940 }
Mike Stump31feda52009-07-17 01:31:16 +00004941
Eugene Zelenko38c70522017-12-07 21:55:09 +00004942 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004943
Chris Lattnerc61089a2009-06-30 01:26:17 +00004944 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004945 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004946 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004947
Craig Topperb45acb82014-03-14 06:02:07 +00004948 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004949 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004950
4951 if (I == StmtMap.end())
4952 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004953
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004954 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004955 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004956 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004957 }
Mike Stump31feda52009-07-17 01:31:16 +00004958
Ted Kremenek60983dc2010-01-19 20:52:05 +00004959 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004960 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004961 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004962
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004963 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004964 DeclMapTy::iterator I = DeclMap.find(D);
4965
4966 if (I == DeclMap.end())
4967 return false;
4968
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004969 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004970 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004971 return false;
4972 }
4973
4974 OS << "[B" << I->second.first << "." << I->second.second << "]";
4975 return true;
4976 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004977};
4978
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004979class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004980 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004981 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004982 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004983 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004984
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004985public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004986 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004987 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004988 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004989 this->Policy.IncludeNewlines = false;
4990 }
Mike Stump31feda52009-07-17 01:31:16 +00004991
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004992 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004993 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004994 if (Stmt *C = I->getCond())
4995 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004996 }
Mike Stump31feda52009-07-17 01:31:16 +00004997
Ted Kremenek9aae5132007-08-23 21:42:29 +00004998 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004999 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00005000 Terminator->printPretty(OS, Helper, Policy);
5001 }
5002
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00005003 void VisitDeclStmt(DeclStmt *DS) {
5004 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
5005 OS << "static init " << VD->getName();
5006 }
5007
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005008 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005009 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00005010 if (F->getInit())
5011 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00005012 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005013 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005014 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00005015 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00005016 if (F->getInc())
5017 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00005018 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00005019 }
Mike Stump31feda52009-07-17 01:31:16 +00005020
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005021 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005022 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005023 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005024 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00005025 }
Mike Stump31feda52009-07-17 01:31:16 +00005026
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005027 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005028 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005029 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005030 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00005031 }
Mike Stump31feda52009-07-17 01:31:16 +00005032
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005033 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00005034 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00005035 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00005036 }
Mike Stump31feda52009-07-17 01:31:16 +00005037
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005038 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005039 OS << "try ...";
5040 }
5041
Nico Weber699670e2017-08-23 15:33:16 +00005042 void VisitSEHTryStmt(SEHTryStmt *CS) {
5043 OS << "__try ...";
5044 }
5045
John McCallc07a0c72011-02-17 10:25:35 +00005046 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00005047 if (Stmt *Cond = C->getCond())
5048 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005049 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005050 }
Mike Stump31feda52009-07-17 01:31:16 +00005051
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005052 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00005053 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005054 if (Stmt *Cond = C->getCond())
5055 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00005056 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00005057 }
Mike Stump31feda52009-07-17 01:31:16 +00005058
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005059 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005060 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005061 if (Stmt *T = I->getTarget())
5062 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005063 }
Mike Stump31feda52009-07-17 01:31:16 +00005064
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005065 void VisitBinaryOperator(BinaryOperator* B) {
5066 if (!B->isLogicalOp()) {
5067 VisitExpr(B);
5068 return;
5069 }
Mike Stump31feda52009-07-17 01:31:16 +00005070
Richard Trieuddd01ce2014-06-09 22:53:25 +00005071 if (B->getLHS())
5072 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005073
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005074 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00005075 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00005076 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005077 return;
John McCalle3027922010-08-25 11:45:40 +00005078 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00005079 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005080 return;
5081 default:
David Blaikie83d382b2011-09-23 05:06:16 +00005082 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00005083 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005084 }
Mike Stump31feda52009-07-17 01:31:16 +00005085
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005086 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00005087 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005088 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00005089
5090public:
5091 void print(CFGTerminator T) {
Artem Dergachev4e530322019-05-24 01:34:22 +00005092 switch (T.getKind()) {
5093 case CFGTerminator::StmtBranch:
5094 Visit(T.getStmt());
5095 break;
5096 case CFGTerminator::TemporaryDtorsBranch:
Ted Kremenekfcc14172014-03-08 02:22:29 +00005097 OS << "(Temp Dtor) ";
Artem Dergachev4e530322019-05-24 01:34:22 +00005098 Visit(T.getStmt());
5099 break;
Artem Dergachev192a7472019-05-24 23:37:08 +00005100 case CFGTerminator::VirtualBaseBranch:
5101 OS << "(See if most derived ctor has already initialized vbases)";
5102 break;
Artem Dergachev4e530322019-05-24 01:34:22 +00005103 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00005104 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00005105};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005106
5107} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00005108
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005109static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
5110 const CXXCtorInitializer *I) {
5111 if (I->isBaseInitializer())
5112 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
5113 else if (I->isDelegatingInitializer())
5114 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
5115 else
5116 OS << I->getAnyMember()->getName();
5117 OS << "(";
5118 if (Expr *IE = I->getInit())
5119 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
5120 OS << ")";
5121
5122 if (I->isBaseInitializer())
5123 OS << " (Base initializer)";
5124 else if (I->isDelegatingInitializer())
5125 OS << " (Delegating initializer)";
5126 else
5127 OS << " (Member initializer)";
5128}
5129
Artem Dergachev1527dec2018-03-12 23:12:40 +00005130static void print_construction_context(raw_ostream &OS,
5131 StmtPrinterHelper &Helper,
5132 const ConstructionContext *CC) {
Artem Dergachevff267df2018-06-28 00:04:54 +00005133 SmallVector<const Stmt *, 3> Stmts;
Artem Dergachev1527dec2018-03-12 23:12:40 +00005134 switch (CC->getKind()) {
Artem Dergachev922455f2018-03-22 22:02:38 +00005135 case ConstructionContext::SimpleConstructorInitializerKind: {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005136 OS << ", ";
Artem Dergachev922455f2018-03-22 22:02:38 +00005137 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC);
5138 print_initializer(OS, Helper, SICC->getCXXCtorInitializer());
Artem Dergacheva657a322018-07-31 20:45:53 +00005139 return;
Artem Dergachev922455f2018-03-22 22:02:38 +00005140 }
5141 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: {
5142 OS << ", ";
5143 const auto *CICC =
5144 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC);
5145 print_initializer(OS, Helper, CICC->getCXXCtorInitializer());
Artem Dergachevff267df2018-06-28 00:04:54 +00005146 Stmts.push_back(CICC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005147 break;
5148 }
5149 case ConstructionContext::SimpleVariableKind: {
Artem Dergachev317291e2018-03-22 21:37:39 +00005150 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005151 Stmts.push_back(SDSCC->getDeclStmt());
Artem Dergachev317291e2018-03-22 21:37:39 +00005152 break;
5153 }
5154 case ConstructionContext::CXX17ElidedCopyVariableKind: {
5155 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005156 Stmts.push_back(CDSCC->getDeclStmt());
5157 Stmts.push_back(CDSCC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005158 break;
5159 }
5160 case ConstructionContext::NewAllocatedObjectKind: {
5161 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005162 Stmts.push_back(NECC->getCXXNewExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005163 break;
5164 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005165 case ConstructionContext::SimpleReturnedValueKind: {
5166 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005167 Stmts.push_back(RSCC->getReturnStmt());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005168 break;
5169 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005170 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: {
5171 const auto *RSCC =
5172 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005173 Stmts.push_back(RSCC->getReturnStmt());
5174 Stmts.push_back(RSCC->getCXXBindTemporaryExpr());
Artem Dergachev317291e2018-03-22 21:37:39 +00005175 break;
5176 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005177 case ConstructionContext::SimpleTemporaryObjectKind: {
5178 const auto *TOCC = cast<SimpleTemporaryObjectConstructionContext>(CC);
5179 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5180 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5181 break;
5182 }
5183 case ConstructionContext::ElidedTemporaryObjectKind: {
5184 const auto *TOCC = cast<ElidedTemporaryObjectConstructionContext>(CC);
5185 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5186 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5187 Stmts.push_back(TOCC->getConstructorAfterElision());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005188 break;
5189 }
Artem Dergacheva657a322018-07-31 20:45:53 +00005190 case ConstructionContext::ArgumentKind: {
5191 const auto *ACC = cast<ArgumentConstructionContext>(CC);
5192 if (const Stmt *BTE = ACC->getCXXBindTemporaryExpr()) {
5193 OS << ", ";
5194 Helper.handledStmt(const_cast<Stmt *>(BTE), OS);
5195 }
5196 OS << ", ";
5197 Helper.handledStmt(const_cast<Expr *>(ACC->getCallLikeExpr()), OS);
5198 OS << "+" << ACC->getIndex();
5199 return;
5200 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005201 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005202 for (auto I: Stmts)
5203 if (I) {
5204 OS << ", ";
5205 Helper.handledStmt(const_cast<Stmt *>(I), OS);
5206 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005207}
5208
Aaron Ballmanff924b02013-11-18 20:11:50 +00005209static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00005210 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00005211 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
5212 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00005213 assert(S != nullptr && "Expecting non-null Stmt");
5214
Aaron Ballmanff924b02013-11-18 20:11:50 +00005215 // special printing for statement-expressions.
5216 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
5217 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00005218
Benjamin Kramer5733e352015-07-18 17:09:36 +00005219 auto Children = Sub->children();
5220 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005221 OS << "({ ... ; ";
5222 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
5223 OS << " })\n";
5224 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005225 }
5226 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00005227 // special printing for comma expressions.
5228 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
5229 if (B->getOpcode() == BO_Comma) {
5230 OS << "... , ";
5231 Helper.handledStmt(B->getRHS(),OS);
5232 OS << '\n';
5233 return;
5234 }
5235 }
5236 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00005237
Artem Dergachev1527dec2018-03-12 23:12:40 +00005238 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
5239 if (isa<CXXOperatorCallExpr>(S))
5240 OS << " (OperatorCall)";
5241 OS << " (CXXRecordTypedCall";
5242 print_construction_context(OS, Helper, VTC->getConstructionContext());
5243 OS << ")";
5244 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005245 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005246 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005247 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005248 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005249 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005250 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005251 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00005252 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005253 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005254 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00005255 OS << " (" << CE->getStmtClassName() << ", "
5256 << CE->getCastKindName()
5257 << ", " << CE->getType().getAsString()
5258 << ")";
5259 }
Mike Stump31feda52009-07-17 01:31:16 +00005260
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005261 // Expressions need a newline.
5262 if (isa<Expr>(S))
5263 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005264 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005265 print_initializer(OS, Helper, IE->getInitializer());
5266 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005267 } else if (Optional<CFGAutomaticObjDtor> DE =
5268 E.getAs<CFGAutomaticObjDtor>()) {
5269 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005270 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005271
Artem Dergacheva25809f2018-06-04 18:56:25 +00005272 ASTContext &ACtx = VD->getASTContext();
5273 QualType T = VD->getType();
5274 if (T->isReferenceType())
5275 T = getReferenceInitTemporaryType(VD->getInit(), nullptr);
5276 if (const ArrayType *AT = ACtx.getAsArrayType(T))
5277 T = ACtx.getBaseElementType(AT);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005278
5279 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
5280 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00005281 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
5282 const VarDecl *VD = DE->getVarDecl();
5283 Helper.handleDecl(VD, OS);
5284
5285 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00005286 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
5287 const Stmt *LoopStmt = LE->getLoopStmt();
5288 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005289 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
5290 OS << "CFGScopeBegin(";
5291 if (const VarDecl *VD = SB->getVarDecl())
5292 OS << VD->getQualifiedNameAsString();
5293 OS << ")\n";
5294 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
5295 OS << "CFGScopeEnd(";
5296 if (const VarDecl *VD = SE->getVarDecl())
5297 OS << VD->getQualifiedNameAsString();
5298 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00005299 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
5300 OS << "CFGNewAllocator(";
5301 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
5302 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5303 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00005304 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
5305 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
5306 if (!RD)
5307 return;
5308 CXXDeleteExpr *DelExpr =
5309 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005310 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005311 OS << "->~" << RD->getName().str() << "()";
5312 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005313 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5314 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005315 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005316 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005317 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5318 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005319 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005320 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005321 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005322 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005323 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5324 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005325 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005326 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005327 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005328 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005329}
Mike Stump31feda52009-07-17 01:31:16 +00005330
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005331static void print_block(raw_ostream &OS, const CFG* cfg,
5332 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005333 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005334 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005335 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005336
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005337 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005338 if (ShowColors)
5339 OS.changeColor(raw_ostream::YELLOW, true);
Fangrui Song6907ce22018-07-30 19:24:48 +00005340
Ted Kremenek72be32a2011-12-22 23:33:52 +00005341 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005342
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005343 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005344 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005345 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005346 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005347 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005348 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005349 else if (B.hasNoReturnElement())
5350 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005351 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005352 OS << "]\n";
Fangrui Song6907ce22018-07-30 19:24:48 +00005353
Ted Kremenek72be32a2011-12-22 23:33:52 +00005354 if (ShowColors)
5355 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005356
Ted Kremenek71eca012007-08-29 23:20:49 +00005357 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005358 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005359 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005360 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005361
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005362 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005363 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005364 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005365 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005366 if (C->getLHS())
5367 C->getLHS()->printPretty(OS, &Helper,
5368 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005369 if (C->getRHS()) {
5370 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005371 C->getRHS()->printPretty(OS, &Helper,
5372 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005373 }
Mike Stump92244b02010-01-19 22:00:14 +00005374 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005375 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005376 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005377 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005378 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005379 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005380 0);
5381 else
5382 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005383 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005384 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5385 OS << "__except (";
5386 ES->getFilterExpr()->printPretty(OS, &Helper,
5387 PrintingPolicy(Helper.getLangOpts()), 0);
5388 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005389 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005390 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005391
Ted Kremenek71eca012007-08-29 23:20:49 +00005392 OS << ":\n";
5393 }
Mike Stump31feda52009-07-17 01:31:16 +00005394
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005395 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005396 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005397
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005398 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5399 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005400 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005401 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005402 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005403
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005404 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005405
Aaron Ballmanff924b02013-11-18 20:11:50 +00005406 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005407
Ted Kremenek72be32a2011-12-22 23:33:52 +00005408 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005409 }
Mike Stump31feda52009-07-17 01:31:16 +00005410
Ted Kremenek71eca012007-08-29 23:20:49 +00005411 // Print the terminator of this block.
Artem Dergachev4e530322019-05-24 01:34:22 +00005412 if (B.getTerminator().isValid()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005413 if (ShowColors)
5414 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005415
Ted Kremenek72be32a2011-12-22 23:33:52 +00005416 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005417
Aaron Ballmanff924b02013-11-18 20:11:50 +00005418 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005419
Aaron Ballmanff924b02013-11-18 20:11:50 +00005420 PrintingPolicy PP(Helper.getLangOpts());
5421 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005422 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005423 OS << '\n';
Fangrui Song6907ce22018-07-30 19:24:48 +00005424
Ted Kremenek72be32a2011-12-22 23:33:52 +00005425 if (ShowColors)
5426 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005427 }
Mike Stump31feda52009-07-17 01:31:16 +00005428
Ted Kremenek71eca012007-08-29 23:20:49 +00005429 if (print_edges) {
5430 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005431 if (!B.pred_empty()) {
5432 const raw_ostream::Colors Color = raw_ostream::BLUE;
5433 if (ShowColors)
5434 OS.changeColor(Color);
5435 OS << " Preds " ;
5436 if (ShowColors)
5437 OS.resetColor();
5438 OS << '(' << B.pred_size() << "):";
5439 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005440
Ted Kremenek72be32a2011-12-22 23:33:52 +00005441 if (ShowColors)
5442 OS.changeColor(Color);
Fangrui Song6907ce22018-07-30 19:24:48 +00005443
Ted Kremenek72be32a2011-12-22 23:33:52 +00005444 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5445 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005446 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005447 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005448
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005449 CFGBlock *B = *I;
5450 bool Reachable = true;
5451 if (!B) {
5452 Reachable = false;
5453 B = I->getPossiblyUnreachableBlock();
5454 }
5455
5456 OS << " B" << B->getBlockID();
5457 if (!Reachable)
5458 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005459 }
Fangrui Song6907ce22018-07-30 19:24:48 +00005460
Ted Kremenek72be32a2011-12-22 23:33:52 +00005461 if (ShowColors)
5462 OS.resetColor();
5463
5464 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005465 }
Mike Stump31feda52009-07-17 01:31:16 +00005466
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005467 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005468 if (!B.succ_empty()) {
5469 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5470 if (ShowColors)
5471 OS.changeColor(Color);
5472 OS << " Succs ";
5473 if (ShowColors)
5474 OS.resetColor();
5475 OS << '(' << B.succ_size() << "):";
5476 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005477
Ted Kremenek72be32a2011-12-22 23:33:52 +00005478 if (ShowColors)
5479 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005480
Ted Kremenek72be32a2011-12-22 23:33:52 +00005481 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5482 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005483 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005484 OS << "\n ";
5485
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005486 CFGBlock *B = *I;
5487
5488 bool Reachable = true;
5489 if (!B) {
5490 Reachable = false;
5491 B = I->getPossiblyUnreachableBlock();
5492 }
5493
5494 if (B) {
5495 OS << " B" << B->getBlockID();
5496 if (!Reachable)
5497 OS << "(Unreachable)";
5498 }
5499 else {
5500 OS << " NULL";
5501 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005502 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005503
Ted Kremenek72be32a2011-12-22 23:33:52 +00005504 if (ShowColors)
5505 OS.resetColor();
5506 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005507 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005508 }
Mike Stump31feda52009-07-17 01:31:16 +00005509}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005510
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005511/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005512void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5513 print(llvm::errs(), LO, ShowColors);
5514}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005515
5516/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005517void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005518 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005519
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005520 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005521 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005522
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005523 // Iterate through the CFGBlocks and print them one by one.
5524 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5525 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005526 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005527 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005528
Aaron Ballmanff924b02013-11-18 20:11:50 +00005529 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005530 }
Mike Stump31feda52009-07-17 01:31:16 +00005531
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005532 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005533 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005534 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005535 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005536}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005537
5538/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005539void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5540 bool ShowColors) const {
5541 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005542}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005543
Yaron Kerencdae9412016-01-29 19:38:18 +00005544LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005545 dump(getParent(), LangOptions(), false);
5546}
5547
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005548/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5549/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005550void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005551 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005552 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005553 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005554 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005555}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005556
Ted Kremenek15647632008-01-30 23:02:42 +00005557/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005558void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005559 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005560 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005561 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005562}
5563
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005564Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Artem Dergachev4e530322019-05-24 01:34:22 +00005565 Stmt *Terminator = getTerminatorStmt();
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005566 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005567 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005568
Craig Topper25542942014-05-20 04:30:07 +00005569 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005570
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005571 switch (Terminator->getStmtClass()) {
5572 default:
5573 break;
Mike Stump31feda52009-07-17 01:31:16 +00005574
Jordan Rosecf10ea82013-06-06 21:53:45 +00005575 case Stmt::CXXForRangeStmtClass:
5576 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5577 break;
5578
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005579 case Stmt::ForStmtClass:
5580 E = cast<ForStmt>(Terminator)->getCond();
5581 break;
Mike Stump31feda52009-07-17 01:31:16 +00005582
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005583 case Stmt::WhileStmtClass:
5584 E = cast<WhileStmt>(Terminator)->getCond();
5585 break;
Mike Stump31feda52009-07-17 01:31:16 +00005586
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005587 case Stmt::DoStmtClass:
5588 E = cast<DoStmt>(Terminator)->getCond();
5589 break;
Mike Stump31feda52009-07-17 01:31:16 +00005590
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005591 case Stmt::IfStmtClass:
5592 E = cast<IfStmt>(Terminator)->getCond();
5593 break;
Mike Stump31feda52009-07-17 01:31:16 +00005594
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005595 case Stmt::ChooseExprClass:
5596 E = cast<ChooseExpr>(Terminator)->getCond();
5597 break;
Mike Stump31feda52009-07-17 01:31:16 +00005598
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005599 case Stmt::IndirectGotoStmtClass:
5600 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5601 break;
Mike Stump31feda52009-07-17 01:31:16 +00005602
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005603 case Stmt::SwitchStmtClass:
5604 E = cast<SwitchStmt>(Terminator)->getCond();
5605 break;
Mike Stump31feda52009-07-17 01:31:16 +00005606
John McCallc07a0c72011-02-17 10:25:35 +00005607 case Stmt::BinaryConditionalOperatorClass:
5608 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5609 break;
5610
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005611 case Stmt::ConditionalOperatorClass:
5612 E = cast<ConditionalOperator>(Terminator)->getCond();
5613 break;
Mike Stump31feda52009-07-17 01:31:16 +00005614
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005615 case Stmt::BinaryOperatorClass: // '&&' and '||'
5616 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005617 break;
Mike Stump31feda52009-07-17 01:31:16 +00005618
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005619 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005620 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005621 }
Mike Stump31feda52009-07-17 01:31:16 +00005622
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005623 if (!StripParens)
5624 return E;
5625
Craig Topper25542942014-05-20 04:30:07 +00005626 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005627}
5628
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005629//===----------------------------------------------------------------------===//
5630// CFG Graphviz Visualization
5631//===----------------------------------------------------------------------===//
5632
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005633#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005634static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005635#endif
5636
Chris Lattnerc61089a2009-06-30 01:26:17 +00005637void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005638#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005639 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005640 GraphHelper = &H;
5641 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005642 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005643#endif
5644}
5645
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005646namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005647
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005648template<>
5649struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005650 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005651
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005652 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005653#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005654 std::string OutSStr;
5655 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005656 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005657 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005658
5659 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5660
5661 // Process string output to make it nicer...
5662 for (unsigned i = 0; i != OutStr.length(); ++i)
5663 if (OutStr[i] == '\n') { // Left justify
5664 OutStr[i] = '\\';
5665 OutStr.insert(OutStr.begin()+i+1, 'l');
5666 }
Mike Stump31feda52009-07-17 01:31:16 +00005667
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005668 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005669#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005670 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005671#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005672 }
5673};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005674
5675} // namespace llvm