blob: 0a62ed2c03675891a30b2b8a16a3908d34b21069 [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 }
1381 default:
1382 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001383 }
1384}
1385
Artem Dergachev1527dec2018-03-12 23:12:40 +00001386void CFGBuilder::cleanupConstructionContext(Expr *E) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001387 assert(BuildOpts.AddRichCXXConstructors &&
1388 "We should not be managing construction contexts!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001389 assert(ConstructionContextMap.count(E) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001390 "Cannot exit construction context without the context!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001391 ConstructionContextMap.erase(E);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001392}
1393
1394
Mike Stump31feda52009-07-17 01:31:16 +00001395/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1396/// arbitrary statement. Examples include a single expression or a function
1397/// body (compound statement). The ownership of the returned CFG is
1398/// transferred to the caller. If CFG construction fails, this method returns
1399/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001400std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001401 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001402 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001403 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001404
Mike Stump31feda52009-07-17 01:31:16 +00001405 // Create an empty block that will serve as the exit block for the CFG. Since
1406 // this is the first block added to the CFG, it will be implicitly registered
1407 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001408 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001409 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001410 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001411
Matthias Gehre351c2182017-07-12 07:04:19 +00001412 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1413 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1414
Marcin Swiderski20b88732010-10-05 05:37:00 +00001415 if (BuildOpts.AddImplicitDtors)
1416 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1417 addImplicitDtorsForDestructor(DD);
1418
Ted Kremenek9aae5132007-08-23 21:42:29 +00001419 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001420 CFGBlock *B = addStmt(Statement);
1421
1422 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001423 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001424
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001425 // For C++ constructor add initializers to CFG.
1426 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001427 for (auto *I : llvm::reverse(CD->inits())) {
1428 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001429 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001430 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001431 }
1432 }
1433
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001434 if (B)
1435 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001436
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001437 // Backpatch the gotos whose label -> block mappings we didn't know when we
1438 // encountered them.
1439 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1440 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001441
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001442 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001443 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001444 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001445
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001446 // If there is no target for the goto, then we are looking at an
1447 // incomplete AST. Handle this by not registering a successor.
1448 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001449
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001450 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001451 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1452 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001453 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1454 JT.scopePosition);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001455 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1456 B, I->scopePosition, JT.scopePosition);
1457 appendScopeBegin(JT.block, VD, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001458 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001459 }
1460
1461 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001462 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001463 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1464 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001465 // Lookup the target block.
1466 LabelMapTy::iterator LI = LabelMap.find(*I);
1467
1468 // If there is no target block that contains label, then we are looking
1469 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001470 if (LI == LabelMap.end()) continue;
Fangrui Song6907ce22018-07-30 19:24:48 +00001471
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001472 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001473 }
Mike Stump31feda52009-07-17 01:31:16 +00001474
Mike Stump31feda52009-07-17 01:31:16 +00001475 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001476 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001477
Artem Dergachev783a4572018-02-23 22:20:39 +00001478 if (BuildOpts.AddRichCXXConstructors)
1479 assert(ConstructionContextMap.empty() &&
1480 "Not all construction contexts were cleaned up!");
1481
David Blaikiee90195c2014-08-29 18:53:26 +00001482 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001483}
Mike Stump31feda52009-07-17 01:31:16 +00001484
Ted Kremenek9aae5132007-08-23 21:42:29 +00001485/// createBlock - Used to lazily create blocks that are connected
1486/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001487CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1488 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001489 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001490 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001491 return B;
1492}
Mike Stump31feda52009-07-17 01:31:16 +00001493
Chandler Carrutha70991b2011-09-13 09:13:49 +00001494/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1495/// CFG. It is *not* connected to the current (global) successor, and instead
1496/// directly tied to the exit block in order to be reachable.
1497CFGBlock *CFGBuilder::createNoReturnBlock() {
1498 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001499 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001500 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001501 return B;
1502}
1503
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001504/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001505CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001506 if (!BuildOpts.AddInitializers)
1507 return Block;
1508
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001509 bool HasTemporaries = false;
1510
1511 // Destructors of temporaries in initialization expression should be called
1512 // after initialization finishes.
1513 Expr *Init = I->getInit();
1514 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001515 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001516
Jordan Rose6d671cc2012-09-05 22:55:23 +00001517 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001518 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001519 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001520 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1521 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001522 }
1523 }
1524
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001525 autoCreateBlock();
1526 appendInitializer(Block, I);
1527
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001528 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001529 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001530 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001531 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001532
Ted Kremenek8219b822010-12-16 07:46:53 +00001533 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001534 // For expression with temporaries go directly to subexpression to omit
1535 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001536 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1537 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001538 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1539 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1540 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1541 // may cause the same Expr to appear more than once in the CFG. Doing it
1542 // here is safe because there's only one initializer per field.
1543 autoCreateBlock();
1544 appendStmt(Block, Default);
1545 if (Stmt *Child = Default->getExpr())
1546 if (CFGBlock *R = Visit(Child))
1547 Block = R;
1548 return Block;
1549 }
1550 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001551 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001552 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001553
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001554 return Block;
1555}
1556
Fangrui Song6907ce22018-07-30 19:24:48 +00001557/// Retrieve the type of the temporary object whose lifetime was
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001558/// extended by a local reference with the given initializer.
Artem Dergacheva25809f2018-06-04 18:56:25 +00001559static QualType getReferenceInitTemporaryType(const Expr *Init,
Richard Smithb8c0f552016-12-09 18:49:13 +00001560 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001561 while (true) {
1562 // Skip parentheses.
1563 Init = Init->IgnoreParens();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001564
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001565 // Skip through cleanups.
1566 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1567 Init = EWC->getSubExpr();
1568 continue;
1569 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001570
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001571 // Skip through the temporary-materialization expression.
1572 if (const MaterializeTemporaryExpr *MTE
1573 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1574 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001575 if (FoundMTE)
1576 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001577 continue;
1578 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001579
1580 // Skip sub-object accesses into rvalues.
1581 SmallVector<const Expr *, 2> CommaLHSs;
1582 SmallVector<SubobjectAdjustment, 2> Adjustments;
1583 const Expr *SkippedInit =
1584 Init->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments);
1585 if (SkippedInit != Init) {
1586 Init = SkippedInit;
1587 continue;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001588 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001589
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001590 break;
1591 }
1592
1593 return Init->getType();
1594}
Matthias Gehre351c2182017-07-12 07:04:19 +00001595
Peter Szecsi999a25f2017-08-19 11:19:16 +00001596// TODO: Support adding LoopExit element to the CFG in case where the loop is
1597// ended by ReturnStmt, GotoStmt or ThrowExpr.
1598void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1599 if(!BuildOpts.AddLoopExit)
1600 return;
1601 autoCreateBlock();
1602 appendLoopExit(Block, LoopStmt);
1603}
1604
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001605void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1606 LocalScope::const_iterator E, Stmt *S) {
1607 if (!BuildOpts.AddScopes)
1608 return;
1609
1610 if (B == E)
1611 return;
1612
1613 // To go from B to E, one first goes up the scopes from B to P
1614 // then sideways in one scope from P to P' and then down
1615 // the scopes from P' to E.
1616 // The lifetime of all objects between B and P end.
1617 LocalScope::const_iterator P = B.shared_parent(E);
1618 int Dist = B.distance(P);
1619 if (Dist <= 0)
1620 return;
1621
1622 for (LocalScope::const_iterator I = B; I != P; ++I)
1623 if (I.pointsToFirstDeclaredVar())
1624 DeclsWithEndedScope.insert(*I);
1625}
1626
Matthias Gehre351c2182017-07-12 07:04:19 +00001627void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1628 LocalScope::const_iterator E,
1629 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001630 getDeclsWithEndedScope(B, E, S);
1631 if (BuildOpts.AddScopes)
1632 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001633 if (BuildOpts.AddImplicitDtors)
1634 addAutomaticObjDtors(B, E, S);
1635 if (BuildOpts.AddLifetime)
1636 addLifetimeEnds(B, E, S);
1637}
1638
1639/// Add to current block automatic objects that leave the scope.
1640void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1641 LocalScope::const_iterator E, Stmt *S) {
1642 if (!BuildOpts.AddLifetime)
1643 return;
1644
1645 if (B == E)
1646 return;
1647
1648 // To go from B to E, one first goes up the scopes from B to P
1649 // then sideways in one scope from P to P' and then down
1650 // the scopes from P' to E.
1651 // The lifetime of all objects between B and P end.
1652 LocalScope::const_iterator P = B.shared_parent(E);
1653 int dist = B.distance(P);
1654 if (dist <= 0)
1655 return;
1656
1657 // We need to perform the scope leaving in reverse order
1658 SmallVector<VarDecl *, 10> DeclsTrivial;
1659 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1660 DeclsTrivial.reserve(dist);
1661 DeclsNonTrivial.reserve(dist);
1662
1663 for (LocalScope::const_iterator I = B; I != P; ++I)
1664 if (hasTrivialDestructor(*I))
1665 DeclsTrivial.push_back(*I);
1666 else
1667 DeclsNonTrivial.push_back(*I);
1668
1669 autoCreateBlock();
1670 // object with trivial destructor end their lifetime last (when storage
1671 // duration ends)
1672 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1673 E = DeclsTrivial.rend();
1674 I != E; ++I)
1675 appendLifetimeEnds(Block, *I, S);
1676
1677 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1678 I = DeclsNonTrivial.rbegin(),
1679 E = DeclsNonTrivial.rend();
1680 I != E; ++I)
1681 appendLifetimeEnds(Block, *I, S);
1682}
1683
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001684/// Add to current block markers for ending scopes.
1685void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1686 LocalScope::const_iterator E, Stmt *S) {
1687 // If implicit destructors are enabled, we'll add scope ends in
1688 // addAutomaticObjDtors.
1689 if (BuildOpts.AddImplicitDtors)
1690 return;
1691
1692 autoCreateBlock();
1693
1694 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1695 I != E; ++I)
1696 appendScopeEnd(Block, *I, S);
1697
1698 return;
1699}
1700
Marcin Swiderski5e415732010-09-30 23:05:00 +00001701/// addAutomaticObjDtors - Add to current block automatic objects destructors
1702/// for objects in range of local scope positions. Use S as trigger statement
1703/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001704void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001705 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001706 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001707 return;
1708
Marcin Swiderski5e415732010-09-30 23:05:00 +00001709 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001710 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001711
Chandler Carruthad747252011-09-13 06:09:01 +00001712 // We need to append the destructors in reverse order, but any one of them
1713 // may be a no-return destructor which changes the CFG. As a result, buffer
1714 // this sequence up and replay them in reverse order when appending onto the
1715 // CFGBlock(s).
1716 SmallVector<VarDecl*, 10> Decls;
1717 Decls.reserve(B.distance(E));
1718 for (LocalScope::const_iterator I = B; I != E; ++I)
1719 Decls.push_back(*I);
1720
1721 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1722 E = Decls.rend();
1723 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001724 if (hasTrivialDestructor(*I)) {
1725 // If AddScopes is enabled and *I is a first variable in a scope, add a
1726 // ScopeEnd marker in a Block.
1727 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1728 autoCreateBlock();
1729 appendScopeEnd(Block, *I, S);
1730 }
1731 continue;
1732 }
Chandler Carruthad747252011-09-13 06:09:01 +00001733 // If this destructor is marked as a no-return destructor, we need to
1734 // create a new block for the destructor which does not have as a successor
1735 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001736 QualType Ty = (*I)->getType();
1737 if (Ty->isReferenceType()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00001738 Ty = getReferenceInitTemporaryType((*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001739 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001740 Ty = Context->getBaseElementType(Ty);
1741
Richard Trieu95a192a2015-05-28 00:14:02 +00001742 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001743 Block = createNoReturnBlock();
1744 else
Chandler Carruthad747252011-09-13 06:09:01 +00001745 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001746
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001747 // Add ScopeEnd just after automatic obj destructor.
1748 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1749 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001750 appendAutomaticObjDtor(Block, *I, S);
1751 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001752}
1753
Marcin Swiderski20b88732010-10-05 05:37:00 +00001754/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1755/// base and member objects in destructor.
1756void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001757 assert(BuildOpts.AddImplicitDtors &&
1758 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001759 const CXXRecordDecl *RD = DD->getParent();
1760
1761 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001762 for (const auto &VI : RD->vbases()) {
1763 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001764 if (!CD->hasTrivialDestructor()) {
1765 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001766 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001767 }
1768 }
1769
1770 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001771 for (const auto &BI : RD->bases()) {
1772 if (!BI.isVirtual()) {
1773 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001774 if (!CD->hasTrivialDestructor()) {
1775 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001776 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001777 }
1778 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001779 }
1780
1781 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001782 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001783 // Check for constant size array. Set type to array element type.
1784 QualType QT = FI->getType();
1785 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1786 if (AT->getSize() == 0)
1787 continue;
1788 QT = AT->getElementType();
1789 }
1790
1791 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001792 if (!CD->hasTrivialDestructor()) {
1793 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001794 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001795 }
1796 }
1797}
1798
Marcin Swiderski5e415732010-09-30 23:05:00 +00001799/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1800/// way return valid LocalScope object.
1801LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001802 if (Scope)
1803 return Scope;
1804 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1805 return new (alloc.Allocate<LocalScope>())
1806 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001807}
1808
1809/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Fangrui Song6907ce22018-07-30 19:24:48 +00001810/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001811void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001812 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1813 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001814 return;
1815
Craig Topper25542942014-05-20 04:30:07 +00001816 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001817
1818 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001819 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001820 for (auto *BI : CS->body()) {
1821 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001822 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001823 Scope = addLocalScopeForDeclStmt(DS, Scope);
1824 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001825 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001826 }
1827
1828 // For any other statement scope will be implicit and as such will be
1829 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001830 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001831 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001832}
1833
1834/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1835/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001836LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001837 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001838 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1839 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001840 return Scope;
1841
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001842 for (auto *DI : DS->decls())
1843 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001844 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001845 return Scope;
1846}
1847
Matthias Gehre351c2182017-07-12 07:04:19 +00001848bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1849 // Check for const references bound to temporary. Set type to pointee.
1850 QualType QT = VD->getType();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001851 if (QT->isReferenceType()) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001852 // Attempt to determine whether this declaration lifetime-extends a
1853 // temporary.
1854 //
1855 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1856 // temporaries, and a single declaration can extend multiple temporaries.
1857 // We should look at the storage duration on each nested
1858 // MaterializeTemporaryExpr instead.
1859
1860 const Expr *Init = VD->getInit();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001861 if (!Init) {
1862 // Probably an exception catch-by-reference variable.
1863 // FIXME: It doesn't really mean that the object has a trivial destructor.
1864 // Also are there other cases?
Matthias Gehre351c2182017-07-12 07:04:19 +00001865 return true;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001866 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001867
Artem Dergacheva25809f2018-06-04 18:56:25 +00001868 // Lifetime-extending a temporary?
Matthias Gehre351c2182017-07-12 07:04:19 +00001869 bool FoundMTE = false;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001870 QT = getReferenceInitTemporaryType(Init, &FoundMTE);
Matthias Gehre351c2182017-07-12 07:04:19 +00001871 if (!FoundMTE)
1872 return true;
1873 }
1874
1875 // Check for constant size array. Set type to array element type.
1876 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1877 if (AT->getSize() == 0)
1878 return true;
1879 QT = AT->getElementType();
1880 }
1881
1882 // Check if type is a C++ class with non-trivial destructor.
1883 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1884 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1885 return true;
1886}
1887
Marcin Swiderski5e415732010-09-30 23:05:00 +00001888/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1889/// create add scope for automatic objects and temporary objects bound to
1890/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001891LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001892 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001893 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1894 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001895 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1896 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001897 return Scope;
1898
1899 // Check if variable is local.
1900 switch (VD->getStorageClass()) {
1901 case SC_None:
1902 case SC_Auto:
1903 case SC_Register:
1904 break;
1905 default: return Scope;
1906 }
1907
Matthias Gehre351c2182017-07-12 07:04:19 +00001908 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001909 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001910 // Add the variable to scope
1911 Scope = createOrReuseLocalScope(Scope);
1912 Scope->addVar(VD);
1913 ScopePos = Scope->begin();
1914 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001915 return Scope;
1916 }
1917
1918 assert(BuildOpts.AddLifetime);
1919 // Add the variable to scope
1920 Scope = createOrReuseLocalScope(Scope);
1921 Scope->addVar(VD);
1922 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001923 return Scope;
1924}
1925
1926/// addLocalScopeAndDtors - For given statement add local scope for it and
1927/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001928void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001929 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001930 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001931 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001932}
1933
Marcin Swiderski321a7072010-09-30 22:54:37 +00001934/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1935/// variables with automatic storage duration to CFGBlock's elements vector.
1936/// Elements will be prepended to physical beginning of the vector which
1937/// happens to be logical end. Use blocks terminator as statement that specifies
1938/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001939/// FIXME: This mechanism for adding automatic destructors doesn't handle
1940/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001941void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001942 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001943 if (!BuildOpts.AddImplicitDtors)
1944 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001945 BumpVectorContext &C = cfg->getBumpVectorContext();
1946 CFGBlock::iterator InsertPos
1947 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1948 for (LocalScope::const_iterator I = B; I != E; ++I)
1949 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1950 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001951}
1952
Matthias Gehre351c2182017-07-12 07:04:19 +00001953/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1954/// variables with automatic storage duration to CFGBlock's elements vector.
1955/// Elements will be prepended to physical beginning of the vector which
1956/// happens to be logical end. Use blocks terminator as statement that specifies
1957/// where lifetime ends.
1958void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1959 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1960 if (!BuildOpts.AddLifetime)
1961 return;
1962 BumpVectorContext &C = cfg->getBumpVectorContext();
1963 CFGBlock::iterator InsertPos =
1964 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1965 for (LocalScope::const_iterator I = B; I != E; ++I)
1966 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1967}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001968
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001969/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
1970/// variables with automatic storage duration to CFGBlock's elements vector.
1971/// Elements will be prepended to physical beginning of the vector which
1972/// happens to be logical end. Use blocks terminator as statement that specifies
1973/// where scope ends.
1974const VarDecl *
1975CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
1976 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1977 if (!BuildOpts.AddScopes)
1978 return nullptr;
1979 BumpVectorContext &C = cfg->getBumpVectorContext();
1980 CFGBlock::iterator InsertPos =
1981 Blk->beginScopeEndInsert(Blk->end(), 1, C);
1982 LocalScope::const_iterator PlaceToInsert = B;
1983 for (LocalScope::const_iterator I = B; I != E; ++I)
1984 PlaceToInsert = I;
1985 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminator());
1986 return *PlaceToInsert;
1987}
1988
Ted Kremenek93668002009-07-17 22:18:43 +00001989/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001990/// blocks for ternary operators, &&, and ||. We also process "," and
1991/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001992CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001993 if (!S) {
1994 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001995 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001996 }
Jordy Rose17347372011-06-10 08:49:37 +00001997
1998 if (Expr *E = dyn_cast<Expr>(S))
1999 S = E->IgnoreParens();
2000
Ted Kremenek93668002009-07-17 22:18:43 +00002001 switch (S->getStmtClass()) {
2002 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002003 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002004
2005 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002006 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002007
John McCallc07a0c72011-02-17 10:25:35 +00002008 case Stmt::BinaryConditionalOperatorClass:
2009 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
2010
Ted Kremenek93668002009-07-17 22:18:43 +00002011 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002012 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002013
Ted Kremenek93668002009-07-17 22:18:43 +00002014 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00002015 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002016
Ted Kremenek93668002009-07-17 22:18:43 +00002017 case Stmt::BreakStmtClass:
2018 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002019
Ted Kremenek93668002009-07-17 22:18:43 +00002020 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00002021 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00002022 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00002023 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002024 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002025
Ted Kremenek93668002009-07-17 22:18:43 +00002026 case Stmt::CaseStmtClass:
2027 return VisitCaseStmt(cast<CaseStmt>(S));
2028
2029 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002030 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002031
Ted Kremenek93668002009-07-17 22:18:43 +00002032 case Stmt::CompoundStmtClass:
2033 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002034
Ted Kremenek93668002009-07-17 22:18:43 +00002035 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002036 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002037
Ted Kremenek93668002009-07-17 22:18:43 +00002038 case Stmt::ContinueStmtClass:
2039 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002040
Ted Kremenekb27378c2010-01-19 20:40:33 +00002041 case Stmt::CXXCatchStmtClass:
2042 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
2043
John McCall5d413782010-12-06 08:20:24 +00002044 case Stmt::ExprWithCleanupsClass:
2045 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00002046
Jordan Rosee5d53932012-08-23 18:10:53 +00002047 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00002048 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00002049 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
2050 // called function's declaration, not by the caller. If we simply add
2051 // this expression to the CFG, we could end up with the same Expr
2052 // appearing multiple times.
2053 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00002054 //
2055 // It's likewise possible for multiple CXXDefaultInitExprs for the same
2056 // expression to be used in the same function (through aggregate
2057 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00002058 return VisitStmt(S, asc);
2059
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002060 case Stmt::CXXBindTemporaryExprClass:
2061 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
2062
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002063 case Stmt::CXXConstructExprClass:
2064 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
2065
Jordan Rosec9176072014-01-13 17:59:19 +00002066 case Stmt::CXXNewExprClass:
2067 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2068
Jordan Rosed2f40792013-09-03 17:00:57 +00002069 case Stmt::CXXDeleteExprClass:
2070 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2071
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002072 case Stmt::CXXFunctionalCastExprClass:
2073 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2074
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002075 case Stmt::CXXTemporaryObjectExprClass:
2076 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2077
Ted Kremenekb27378c2010-01-19 20:40:33 +00002078 case Stmt::CXXThrowExprClass:
2079 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002080
Ted Kremenekb27378c2010-01-19 20:40:33 +00002081 case Stmt::CXXTryStmtClass:
2082 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002083
Richard Smith02e85f32011-04-14 22:09:26 +00002084 case Stmt::CXXForRangeStmtClass:
2085 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2086
Ted Kremenek93668002009-07-17 22:18:43 +00002087 case Stmt::DeclStmtClass:
2088 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002089
Ted Kremenek93668002009-07-17 22:18:43 +00002090 case Stmt::DefaultStmtClass:
2091 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002092
Ted Kremenek93668002009-07-17 22:18:43 +00002093 case Stmt::DoStmtClass:
2094 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002095
Ted Kremenek93668002009-07-17 22:18:43 +00002096 case Stmt::ForStmtClass:
2097 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002098
Ted Kremenek93668002009-07-17 22:18:43 +00002099 case Stmt::GotoStmtClass:
2100 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002101
Ted Kremenek93668002009-07-17 22:18:43 +00002102 case Stmt::IfStmtClass:
2103 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002104
Ted Kremenek8219b822010-12-16 07:46:53 +00002105 case Stmt::ImplicitCastExprClass:
2106 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002107
Bill Wendling8003edc2018-11-09 00:41:36 +00002108 case Stmt::ConstantExprClass:
2109 return VisitConstantExpr(cast<ConstantExpr>(S), asc);
2110
Ted Kremenek93668002009-07-17 22:18:43 +00002111 case Stmt::IndirectGotoStmtClass:
2112 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002113
Ted Kremenek93668002009-07-17 22:18:43 +00002114 case Stmt::LabelStmtClass:
2115 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002116
Ted Kremenekda76a942012-04-12 20:34:52 +00002117 case Stmt::LambdaExprClass:
2118 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2119
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002120 case Stmt::MaterializeTemporaryExprClass:
2121 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2122 asc);
2123
Ted Kremenek5868ec62010-04-11 17:02:10 +00002124 case Stmt::MemberExprClass:
2125 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2126
Ted Kremenek04268232011-11-05 00:10:15 +00002127 case Stmt::NullStmtClass:
2128 return Block;
2129
Ted Kremenek93668002009-07-17 22:18:43 +00002130 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002131 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2132
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002133 case Stmt::ObjCAutoreleasePoolStmtClass:
2134 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2135
Ted Kremenek93668002009-07-17 22:18:43 +00002136 case Stmt::ObjCAtSynchronizedStmtClass:
2137 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002138
Ted Kremenek93668002009-07-17 22:18:43 +00002139 case Stmt::ObjCAtThrowStmtClass:
2140 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002141
Ted Kremenek93668002009-07-17 22:18:43 +00002142 case Stmt::ObjCAtTryStmtClass:
2143 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002144
Ted Kremenek93668002009-07-17 22:18:43 +00002145 case Stmt::ObjCForCollectionStmtClass:
2146 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002147
Artem Dergachevbd880fe2018-07-31 19:39:37 +00002148 case Stmt::ObjCMessageExprClass:
2149 return VisitObjCMessageExpr(cast<ObjCMessageExpr>(S), asc);
2150
Ted Kremenek04268232011-11-05 00:10:15 +00002151 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002152 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002153
John McCallfe96e0b2011-11-06 09:01:30 +00002154 case Stmt::PseudoObjectExprClass:
2155 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2156
Ted Kremenek93668002009-07-17 22:18:43 +00002157 case Stmt::ReturnStmtClass:
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002158 case Stmt::CoreturnStmtClass:
2159 return VisitReturnStmt(S);
Mike Stump11289f42009-09-09 15:08:12 +00002160
Nico Weber699670e2017-08-23 15:33:16 +00002161 case Stmt::SEHExceptStmtClass:
2162 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2163
2164 case Stmt::SEHFinallyStmtClass:
2165 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2166
2167 case Stmt::SEHLeaveStmtClass:
2168 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2169
2170 case Stmt::SEHTryStmtClass:
2171 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2172
Peter Collingbournee190dee2011-03-11 19:24:49 +00002173 case Stmt::UnaryExprOrTypeTraitExprClass:
2174 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2175 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002176
Ted Kremenek93668002009-07-17 22:18:43 +00002177 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002178 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002179
Ted Kremenek93668002009-07-17 22:18:43 +00002180 case Stmt::SwitchStmtClass:
2181 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002182
Zhanyong Wan6dace612010-11-22 08:45:56 +00002183 case Stmt::UnaryOperatorClass:
2184 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2185
Ted Kremenek93668002009-07-17 22:18:43 +00002186 case Stmt::WhileStmtClass:
2187 return VisitWhileStmt(cast<WhileStmt>(S));
2188 }
2189}
Mike Stump11289f42009-09-09 15:08:12 +00002190
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002191CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002192 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002193 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002194 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002195 }
Mike Stump11289f42009-09-09 15:08:12 +00002196
Ted Kremenek93668002009-07-17 22:18:43 +00002197 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002198}
Mike Stump31feda52009-07-17 01:31:16 +00002199
Ted Kremenek93668002009-07-17 22:18:43 +00002200/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002201CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2202 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002203
Ted Kremenek8ae67872013-02-05 22:00:19 +00002204 // Visit the children in their reverse order so that they appear in
2205 // left-to-right (natural) order in the CFG.
2206 reverse_children RChildren(S);
2207 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2208 I != E; ++I) {
2209 if (Stmt *Child = *I)
2210 if (CFGBlock *R = Visit(Child))
2211 B = R;
2212 }
2213 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002214}
Mike Stump11289f42009-09-09 15:08:12 +00002215
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002216CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2217 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002218 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002219
Ted Kremenek7c58d352011-03-10 01:14:11 +00002220 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002221 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002222 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002223 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002224
Ted Kremenek9aae5132007-08-23 21:42:29 +00002225 return Block;
2226}
Mike Stump11289f42009-09-09 15:08:12 +00002227
Zhanyong Wan6dace612010-11-22 08:45:56 +00002228CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002229 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002230 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002231 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002232 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002233 }
2234
Ted Kremenek8219b822010-12-16 07:46:53 +00002235 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002236}
2237
Ted Kremeneka16436f2012-07-14 05:04:06 +00002238CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2239 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2240 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002241
Ted Kremeneka16436f2012-07-14 05:04:06 +00002242 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002243 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002244
Craig Topper25542942014-05-20 04:30:07 +00002245 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2246 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002247}
2248
2249std::pair<CFGBlock*, CFGBlock*>
2250CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2251 Stmt *Term,
2252 CFGBlock *TrueBlock,
2253 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002254 // Introspect the RHS. If it is a nested logical operation, we recursively
2255 // build the CFG using this function. Otherwise, resort to default
2256 // CFG construction behavior.
2257 Expr *RHS = B->getRHS()->IgnoreParens();
2258 CFGBlock *RHSBlock, *ExitBlock;
2259
2260 do {
2261 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2262 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002263 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002264 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2265 break;
2266 }
2267
2268 // The RHS is not a nested logical operation. Don't push the terminator
2269 // down further, but instead visit RHS and construct the respective
2270 // pieces of the CFG, and link up the RHSBlock with the terminator
2271 // we have been provided.
2272 ExitBlock = RHSBlock = createBlock(false);
2273
Richard Trieu6a6af522017-01-04 00:46:30 +00002274 // Even though KnownVal is only used in the else branch of the next
2275 // conditional, tryEvaluateBool performs additional checking on the
2276 // Expr, so it should be called unconditionally.
2277 TryResult KnownVal = tryEvaluateBool(RHS);
2278 if (!KnownVal.isKnown())
2279 KnownVal = tryEvaluateBool(B);
2280
Ted Kremenekb50e7162012-07-14 05:04:10 +00002281 if (!Term) {
2282 assert(TrueBlock == FalseBlock);
2283 addSuccessor(RHSBlock, TrueBlock);
2284 }
2285 else {
2286 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002287 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2288 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002289 }
2290
2291 Block = RHSBlock;
2292 RHSBlock = addStmt(RHS);
2293 }
2294 while (false);
2295
2296 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002297 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002298
2299 // Generate the blocks for evaluating the LHS.
2300 Expr *LHS = B->getLHS()->IgnoreParens();
2301
2302 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2303 if (B_LHS->isLogicalOp()) {
2304 if (B->getOpcode() == BO_LOr)
2305 FalseBlock = RHSBlock;
2306 else
2307 TrueBlock = RHSBlock;
2308
2309 // For the LHS, treat 'B' as the terminator that we want to sink
2310 // into the nested branch. The RHS always gets the top-most
2311 // terminator.
2312 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2313 }
2314
2315 // Create the block evaluating the LHS.
2316 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002317 CFGBlock *LHSBlock = createBlock(false);
2318 LHSBlock->setTerminator(B);
2319
Ted Kremeneka16436f2012-07-14 05:04:06 +00002320 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002321 CFGBlock *EntryLHSBlock = addStmt(LHS);
2322
2323 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002324 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002325
2326 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002327 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002328
2329 // Now link the LHSBlock with RHSBlock.
2330 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002331 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2332 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002333 } else {
2334 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002335 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2336 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002337 }
2338
Ted Kremenekb50e7162012-07-14 05:04:10 +00002339 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002340}
2341
2342CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2343 AddStmtChoice asc) {
2344 // && or ||
2345 if (B->isLogicalOp())
2346 return VisitLogicalOperator(B);
2347
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002348 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002349 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002350 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002351 addStmt(B->getRHS());
2352 return addStmt(B->getLHS());
2353 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002354
2355 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002356 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002357 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002358 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002359 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002360 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002361 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002362 }
Mike Stump11289f42009-09-09 15:08:12 +00002363
Ted Kremenek7c58d352011-03-10 01:14:11 +00002364 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002365 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002366 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002367 }
2368
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002369 CFGBlock *RBlock = Visit(B->getRHS());
2370 CFGBlock *LBlock = Visit(B->getLHS());
2371 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2372 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2373 // return RBlock. Otherwise we'll incorrectly return NULL.
2374 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002375}
2376
Ted Kremeneke2499842012-04-12 20:03:44 +00002377CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002378 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002379 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002380 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002381 }
2382 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002383}
2384
Ted Kremenek93668002009-07-17 22:18:43 +00002385CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2386 // "break" is a control-flow statement. Thus we stop processing the current
2387 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002388 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002389 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002390
Ted Kremenek93668002009-07-17 22:18:43 +00002391 // Now create a new block that ends with the break statement.
2392 Block = createBlock(false);
2393 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002394
Ted Kremenek93668002009-07-17 22:18:43 +00002395 // If there is no target for the break, then we are looking at an incomplete
2396 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002397 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002398 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002399 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002400 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002401 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002402
Ted Kremenek9aae5132007-08-23 21:42:29 +00002403 return Block;
2404}
Mike Stump11289f42009-09-09 15:08:12 +00002405
Sebastian Redl31ad7542011-03-13 17:09:40 +00002406static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002407 QualType Ty = E->getType();
2408 if (Ty->isFunctionPointerType())
2409 Ty = Ty->getAs<PointerType>()->getPointeeType();
2410 else if (Ty->isBlockPointerType())
2411 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002412
Mike Stump04c68512010-01-21 15:20:48 +00002413 const FunctionType *FT = Ty->getAs<FunctionType>();
2414 if (FT) {
2415 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002416 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00002417 Proto->isNothrow())
Mike Stump04c68512010-01-21 15:20:48 +00002418 return false;
2419 }
2420 return true;
2421}
2422
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002423CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002424 // Compute the callee type.
2425 QualType calleeType = C->getCallee()->getType();
2426 if (calleeType == Context->BoundMemberTy) {
2427 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2428
2429 // We should only get a null bound type if processing a dependent
2430 // CFG. Recover by assuming nothing.
2431 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002432 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002433
John McCallc67067f2011-05-11 07:19:11 +00002434 // If this is a call to a no-return function, this stops the block here.
2435 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2436
Mike Stump04c68512010-01-21 15:20:48 +00002437 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002438
2439 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002440 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002441 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002442 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002443 }
2444
Jordan Rose5374c072013-08-19 16:27:28 +00002445 // If this is a call to a builtin function, it might not actually evaluate
2446 // its arguments. Don't add them to the CFG if this is the case.
2447 bool OmitArguments = false;
2448
Mike Stump92244b02010-01-19 22:00:14 +00002449 if (FunctionDecl *FD = C->getDirectCallee()) {
Artem Dergachev594b5412018-08-29 21:50:52 +00002450 // TODO: Support construction contexts for variadic function arguments.
2451 // These are a bit problematic and not very useful because passing
2452 // C++ objects as C-style variadic arguments doesn't work in general
2453 // (see [expr.call]).
2454 if (!FD->isVariadic())
2455 findConstructionContextsForArguments(C);
2456
Nico Weber758fbac2018-02-13 21:31:47 +00002457 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002458 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002459 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002460 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00002461 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
2462 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002463 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002464
Sebastian Redl31ad7542011-03-13 17:09:40 +00002465 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002466 AddEHEdge = false;
2467
Jordan Rose5374c072013-08-19 16:27:28 +00002468 if (OmitArguments) {
2469 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2470 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2471 autoCreateBlock();
2472 appendStmt(Block, C);
2473 return Visit(C->getCallee());
2474 }
2475
2476 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002477 autoCreateBlock();
2478 appendCall(Block, C);
2479
2480 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002481 }
Mike Stump11289f42009-09-09 15:08:12 +00002482
Mike Stump92244b02010-01-19 22:00:14 +00002483 if (Block) {
2484 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002485 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002486 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002487 }
Mike Stump11289f42009-09-09 15:08:12 +00002488
Chandler Carrutha70991b2011-09-13 09:13:49 +00002489 if (NoReturn)
2490 Block = createNoReturnBlock();
2491 else
2492 Block = createBlock();
2493
Artem Dergachev1527dec2018-03-12 23:12:40 +00002494 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002495
Mike Stump04c68512010-01-21 15:20:48 +00002496 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002497 // Add exceptional edges.
2498 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002499 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002500 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002501 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002502 }
Mike Stump11289f42009-09-09 15:08:12 +00002503
Mike Stump8c5d7992009-07-25 21:26:53 +00002504 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002505}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002506
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002507CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2508 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002509 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002510 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002511 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002512 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002513
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002514 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002515 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002516 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002517 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002518 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002519 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002520
Ted Kremenek21822592009-07-17 18:20:32 +00002521 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002522 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002523 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002524 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002525 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002526
Ted Kremenek21822592009-07-17 18:20:32 +00002527 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002528 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002529 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002530 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2531 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002532 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002533 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002534}
Mike Stump11289f42009-09-09 15:08:12 +00002535
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002536CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002537 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002538 addLocalScopeForStmt(C);
2539
Matthias Gehre09a134e2015-11-14 00:36:50 +00002540 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002541 // If the body ends with a ReturnStmt, the dtors will be added in
2542 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002543 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002544 }
2545
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002546 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002547
2548 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2549 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002550 // If we hit a segment of code just containing ';' (NullStmts), we can
2551 // get a null block back. In such cases, just use the LastBlock
2552 if (CFGBlock *newBlock = addStmt(*I))
2553 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002554
Ted Kremenekce499c22009-08-27 23:16:26 +00002555 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002556 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002557 }
Mike Stump92244b02010-01-19 22:00:14 +00002558
Ted Kremenek93668002009-07-17 22:18:43 +00002559 return LastBlock;
2560}
Mike Stump11289f42009-09-09 15:08:12 +00002561
John McCallc07a0c72011-02-17 10:25:35 +00002562CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002563 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002564 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002565 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002566
Ted Kremenek51d40b02009-07-17 18:15:54 +00002567 // Create the confluence block that will "merge" the results of the ternary
2568 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002569 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002570 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002571 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002572 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002573
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002574 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002575
Ted Kremenek51d40b02009-07-17 18:15:54 +00002576 // Create a block for the LHS expression if there is an LHS expression. A
2577 // GCC extension allows LHS to be NULL, causing the condition to be the
2578 // value that is returned instead.
2579 // e.g: x ?: y is shorthand for: x ? x : y;
2580 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002581 Block = nullptr;
2582 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002583 const Expr *trueExpr = C->getTrueExpr();
2584 if (trueExpr != opaqueValue) {
2585 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002586 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002587 return nullptr;
2588 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002589 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002590 else
2591 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002592
Ted Kremenek51d40b02009-07-17 18:15:54 +00002593 // Create the block for the RHS expression.
2594 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002595 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002596 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002597 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002598
Richard Smithf676e452012-07-24 21:02:14 +00002599 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2600 if (BinaryOperator *Cond =
2601 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2602 if (Cond->isLogicalOp())
2603 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2604
Ted Kremenek51d40b02009-07-17 18:15:54 +00002605 // Create the block that will contain the condition.
2606 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002607
Mike Stump773582d2009-07-23 23:25:26 +00002608 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002609 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002610 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2611 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002612 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002613 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002614
Ted Kremenekd8138012011-02-24 03:09:15 +00002615 if (opaqueValue) {
2616 // Run the condition expression if it's not trivially expressed in
2617 // terms of the opaque value (or if there is no opaque value).
2618 if (condExpr != opaqueValue)
2619 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002620
Ted Kremenekd8138012011-02-24 03:09:15 +00002621 // Before that, run the common subexpression if there was one.
2622 // At least one of this or the above will be run.
2623 return addStmt(BCO->getCommon());
2624 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002625
Ted Kremenekd8138012011-02-24 03:09:15 +00002626 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002627}
2628
Ted Kremenek93668002009-07-17 22:18:43 +00002629CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002630 // Check if the Decl is for an __label__. If so, elide it from the
2631 // CFG entirely.
2632 if (isa<LabelDecl>(*DS->decl_begin()))
2633 return Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00002634
Ted Kremenek3a601142011-05-24 20:41:31 +00002635 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002636 if (DS->isSingleDecl())
2637 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002638
Craig Topper25542942014-05-20 04:30:07 +00002639 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002640
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002641 // Build an individual DeclStmt for each decl.
2642 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2643 E = DS->decl_rend();
2644 I != E; ++I) {
Mike Stump11289f42009-09-09 15:08:12 +00002645
Ted Kremenek93668002009-07-17 22:18:43 +00002646 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2647 // automatically freed with the CFG.
2648 DeclGroupRef DG(*I);
2649 Decl *D = *I;
George Karpenkovc1ac8082018-10-02 21:19:01 +00002650 DeclStmt *DSNew = new (Context) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002651 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002652
Ted Kremenek93668002009-07-17 22:18:43 +00002653 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002654 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002655 }
Mike Stump11289f42009-09-09 15:08:12 +00002656
2657 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002658}
Mike Stump11289f42009-09-09 15:08:12 +00002659
Ted Kremenek93668002009-07-17 22:18:43 +00002660/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002661/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002662CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002663 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002664 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002665
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002666 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002667 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2668 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002669 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002670 }
Mike Stump11289f42009-09-09 15:08:12 +00002671
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002672 bool HasTemporaries = false;
2673
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002674 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002675 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002676
2677 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2678 // For static variables, we need to create a branch to track
2679 // whether or not they are initialized.
2680 if (Block) {
2681 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002682 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002683 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002684 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002685 }
2686 blockAfterStaticInit = Succ;
2687 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002688
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002689 // Destructors of temporaries in initialization expression should be called
2690 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002691 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002692 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002693 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002694
Jordan Rose6d671cc2012-09-05 22:55:23 +00002695 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002696 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002697 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002698 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2699 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002700 }
2701 }
2702
2703 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002704 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002705
Artem Dergachev783a4572018-02-23 22:20:39 +00002706 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002707 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002708 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002709
Ted Kremenek213d0532012-03-22 05:57:43 +00002710 // Keep track of the last non-null block, as 'Block' can be nulled out
2711 // if the initializer expression is something like a 'while' in a
2712 // statement-expression.
2713 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002714
Ted Kremenek93668002009-07-17 22:18:43 +00002715 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002716 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002717 // For expression with temporaries go directly to subexpression to omit
2718 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002719 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2720 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2721 LastBlock = newBlock;
2722 }
2723 else {
2724 if (CFGBlock *newBlock = Visit(Init))
2725 LastBlock = newBlock;
2726 }
Ted Kremenek93668002009-07-17 22:18:43 +00002727 }
Mike Stump11289f42009-09-09 15:08:12 +00002728
Ted Kremenek93668002009-07-17 22:18:43 +00002729 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002730 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002731 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002732 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2733 LastBlock = newBlock;
2734 }
Mike Stump11289f42009-09-09 15:08:12 +00002735
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002736 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2737
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002738 // Remove variable from local scope.
2739 if (ScopePos && VD == *ScopePos)
2740 ++ScopePos;
2741
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002742 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002743 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002744 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002745 Block = createBlock(false);
2746 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002747 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002748 addSuccessor(Block, B);
2749 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002750 }
2751
2752 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002753}
2754
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002755CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002756 // We may see an if statement in the middle of a basic block, or it may be the
2757 // first statement we are processing. In either case, we create a new basic
2758 // block. First, we create the blocks for the then...else statements, and
2759 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002760 // middle of a block, we stop processing that block. That block is then the
2761 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002762
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002763 // Save local scope position because in case of condition variable ScopePos
2764 // won't be restored when traversing AST.
2765 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2766
Richard Smitha547eb22016-07-14 00:11:03 +00002767 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002768 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002769 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002770
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002771 // Create local scope for possible condition variable.
2772 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002773 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002774 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002775
Matthias Gehre351c2182017-07-12 07:04:19 +00002776 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002777
Chris Lattner57540c52011-04-15 05:22:18 +00002778 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002779 // block.
2780 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002781 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002782 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002783 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002784 }
Mike Stump31feda52009-07-17 01:31:16 +00002785
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002786 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002787 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002788
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002789 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002790 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002791
Ted Kremenek9aae5132007-08-23 21:42:29 +00002792 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002793 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002794 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002795
2796 // If branch is not a compound statement create implicit scope
2797 // and add destructors.
2798 if (!isa<CompoundStmt>(Else))
2799 addLocalScopeAndDtors(Else);
2800
Ted Kremenek93668002009-07-17 22:18:43 +00002801 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002802
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002803 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2804 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002805 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002806 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002807 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002808 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002809 }
Mike Stump31feda52009-07-17 01:31:16 +00002810
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002811 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002812 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002813 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002814 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002815 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002816 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002817 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002818
2819 // If branch is not a compound statement create implicit scope
2820 // and add destructors.
2821 if (!isa<CompoundStmt>(Then))
2822 addLocalScopeAndDtors(Then);
2823
Ted Kremenek93668002009-07-17 22:18:43 +00002824 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002825
Ted Kremenek1b379512009-04-01 03:52:47 +00002826 if (!ThenBlock) {
2827 // We can reach here if the "then" body has all NullStmts.
2828 // Create an empty block so we can distinguish between true and false
2829 // branches in path-sensitive analyses.
2830 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002831 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002832 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002833 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002834 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002835 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002836 }
2837
Ted Kremenekb50e7162012-07-14 05:04:10 +00002838 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2839 // having these handle the actual control-flow jump. Note that
2840 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2841 // we resort to the old control-flow behavior. This special handling
2842 // removes infeasible paths from the control-flow graph by having the
2843 // control-flow transfer of '&&' or '||' go directly into the then/else
2844 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002845 BinaryOperator *Cond =
2846 I->getConditionVariable()
2847 ? nullptr
2848 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2849 CFGBlock *LastBlock;
2850 if (Cond && Cond->isLogicalOp())
2851 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2852 else {
2853 // Now create a new block containing the if statement.
2854 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002855
Richard Smith509bbd12017-01-13 22:16:41 +00002856 // Set the terminator of the new block to the If statement.
2857 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002858
Richard Smith509bbd12017-01-13 22:16:41 +00002859 // See if this is a known constant.
2860 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002861
Richard Smith509bbd12017-01-13 22:16:41 +00002862 // Add the successors. If we know that specific branches are
2863 // unreachable, inform addSuccessor() of that knowledge.
2864 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2865 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002866
Richard Smith509bbd12017-01-13 22:16:41 +00002867 // Add the condition as the last statement in the new block. This may
2868 // create new blocks as the condition may contain control-flow. Any newly
2869 // created blocks will be pointed to be "Block".
2870 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002871
Richard Smith509bbd12017-01-13 22:16:41 +00002872 // If the IfStmt contains a condition variable, add it and its
2873 // initializer to the CFG.
2874 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2875 autoCreateBlock();
2876 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2877 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002878 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002879
Richard Smitha547eb22016-07-14 00:11:03 +00002880 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2881 if (Stmt *Init = I->getInit()) {
2882 autoCreateBlock();
2883 LastBlock = addStmt(Init);
2884 }
2885
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002886 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002887}
Mike Stump31feda52009-07-17 01:31:16 +00002888
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002889CFGBlock *CFGBuilder::VisitReturnStmt(Stmt *S) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002890 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002891 //
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002892 // NOTE: If a "return" or "co_return" appears in the middle of a block, this
2893 // means that the code afterwards is DEAD (unreachable). We still keep
2894 // a basic block for that code; a simple "mark-and-sweep" from the entry
2895 // block will be able to report such dead blocks.
2896 assert(isa<ReturnStmt>(S) || isa<CoreturnStmt>(S));
Ted Kremenek9aae5132007-08-23 21:42:29 +00002897
2898 // Create the new block.
2899 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002900
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002901 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), S);
Pavel Labath921e7652013-09-06 08:12:48 +00002902
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002903 if (auto *R = dyn_cast<ReturnStmt>(S))
2904 findConstructionContexts(
2905 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
2906 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002907
Pavel Labath921e7652013-09-06 08:12:48 +00002908 // If the one of the destructors does not return, we already have the Exit
2909 // block as a successor.
2910 if (!Block->hasNoReturnElement())
2911 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002912
2913 // Add the return statement to the block. This may create new blocks if R
2914 // contains control-flow (short-circuit operations).
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002915 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002916}
2917
Nico Weber699670e2017-08-23 15:33:16 +00002918CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2919 // SEHExceptStmt are treated like labels, so they are the first statement in a
2920 // block.
2921
2922 // Save local scope position because in case of exception variable ScopePos
2923 // won't be restored when traversing AST.
2924 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2925
2926 addStmt(ES->getBlock());
2927 CFGBlock *SEHExceptBlock = Block;
2928 if (!SEHExceptBlock)
2929 SEHExceptBlock = createBlock();
2930
2931 appendStmt(SEHExceptBlock, ES);
2932
2933 // Also add the SEHExceptBlock as a label, like with regular labels.
2934 SEHExceptBlock->setLabel(ES);
2935
2936 // Bail out if the CFG is bad.
2937 if (badCFG)
2938 return nullptr;
2939
2940 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2941 Block = nullptr;
2942
2943 return SEHExceptBlock;
2944}
2945
2946CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2947 return VisitCompoundStmt(FS->getBlock());
2948}
2949
2950CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2951 // "__leave" is a control-flow statement. Thus we stop processing the current
2952 // block.
2953 if (badCFG)
2954 return nullptr;
2955
2956 // Now create a new block that ends with the __leave statement.
2957 Block = createBlock(false);
2958 Block->setTerminator(LS);
2959
2960 // If there is no target for the __leave, then we are looking at an incomplete
2961 // AST. This means that the CFG cannot be constructed.
2962 if (SEHLeaveJumpTarget.block) {
2963 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2964 addSuccessor(Block, SEHLeaveJumpTarget.block);
2965 } else
2966 badCFG = true;
2967
2968 return Block;
2969}
2970
2971CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2972 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2973 // processing the current block.
2974 CFGBlock *SEHTrySuccessor = nullptr;
2975
2976 if (Block) {
2977 if (badCFG)
2978 return nullptr;
2979 SEHTrySuccessor = Block;
2980 } else SEHTrySuccessor = Succ;
2981
2982 // FIXME: Implement __finally support.
2983 if (Terminator->getFinallyHandler())
2984 return NYS();
2985
2986 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2987
2988 // Create a new block that will contain the __try statement.
2989 CFGBlock *NewTryTerminatedBlock = createBlock(false);
2990
2991 // Add the terminator in the __try block.
2992 NewTryTerminatedBlock->setTerminator(Terminator);
2993
2994 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
2995 // The code after the try is the implicit successor if there's an __except.
2996 Succ = SEHTrySuccessor;
2997 Block = nullptr;
2998 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
2999 if (!ExceptBlock)
3000 return nullptr;
3001 // Add this block to the list of successors for the block with the try
3002 // statement.
3003 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
3004 }
3005 if (PrevSEHTryTerminatedBlock)
3006 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
3007 else
3008 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
3009
3010 // The code after the try is the implicit successor.
3011 Succ = SEHTrySuccessor;
3012
3013 // Save the current "__try" context.
3014 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
3015 NewTryTerminatedBlock);
3016 cfg->addTryDispatchBlock(TryTerminatedBlock);
3017
3018 // Save the current value for the __leave target.
3019 // All __leaves should go to the code following the __try
3020 // (FIXME: or if the __try has a __finally, to the __finally.)
3021 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
3022 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
3023
3024 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
3025 Block = nullptr;
3026 return addStmt(Terminator->getTryBlock());
3027}
3028
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003029CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003030 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00003031 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003032 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003033
Ted Kremenek93668002009-07-17 22:18:43 +00003034 if (!LabelBlock) // This can happen when the body is empty, i.e.
3035 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00003036
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003037 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
3038 "label already in map");
3039 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003040
3041 // Labels partition blocks, so this is the end of the basic block we were
3042 // processing (L is the block's label). Because this is label (and we have
3043 // already processed the substatement) there is no extra control-flow to worry
3044 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00003045 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003046 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003047 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003048
3049 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00003050 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003051
Ted Kremenek9aae5132007-08-23 21:42:29 +00003052 // This block is now the implicit successor of other blocks.
3053 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003054
Ted Kremenek9aae5132007-08-23 21:42:29 +00003055 return LabelBlock;
3056}
3057
Devin Coughlinb6029b72015-11-25 22:35:37 +00003058CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
3059 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3060 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
3061 if (Expr *CopyExpr = CI.getCopyExpr()) {
3062 CFGBlock *Tmp = Visit(CopyExpr);
3063 if (Tmp)
3064 LastBlock = Tmp;
3065 }
3066 }
3067 return LastBlock;
3068}
3069
Ted Kremenekda76a942012-04-12 20:34:52 +00003070CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
3071 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3072 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
3073 et = E->capture_init_end(); it != et; ++it) {
3074 if (Expr *Init = *it) {
3075 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00003076 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00003077 LastBlock = Tmp;
3078 }
3079 }
3080 return LastBlock;
3081}
Fangrui Song6907ce22018-07-30 19:24:48 +00003082
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003083CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003084 // Goto is a control-flow statement. Thus we stop processing the current
3085 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003086
Ted Kremenek9aae5132007-08-23 21:42:29 +00003087 Block = createBlock(false);
3088 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003089
3090 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003091 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003092
Ted Kremenek9aae5132007-08-23 21:42:29 +00003093 if (I == LabelMap.end())
3094 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003095 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3096 else {
3097 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003098 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003099 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003100 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003101
Mike Stump31feda52009-07-17 01:31:16 +00003102 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003103}
3104
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003105CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003106 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003107
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003108 // Save local scope position because in case of condition variable ScopePos
3109 // won't be restored when traversing AST.
3110 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3111
3112 // Create local scope for init statement and possible condition variable.
3113 // Add destructor for init statement and condition variable.
3114 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003115 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003116 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003117 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3118
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003119 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003120 addLocalScopeForVarDecl(VD);
3121 LocalScope::const_iterator ContinueScopePos = ScopePos;
3122
Matthias Gehre351c2182017-07-12 07:04:19 +00003123 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003124
Peter Szecsi999a25f2017-08-19 11:19:16 +00003125 addLoopExit(F);
3126
Mike Stump014b3ea2009-07-21 01:12:51 +00003127 // "for" is a control-flow statement. Thus we stop processing the current
3128 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003129 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003130 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003131 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003132 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003133 } else
3134 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003135
Ted Kremenek304a9532010-05-21 20:30:15 +00003136 // Save the current value for the break targets.
3137 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003138 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003139 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003140
Craig Topper25542942014-05-20 04:30:07 +00003141 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003142
Ted Kremenek9aae5132007-08-23 21:42:29 +00003143 // Now create the loop body.
3144 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003145 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003146
Ted Kremenekb50e7162012-07-14 05:04:10 +00003147 // Save the current values for Block, Succ, continue and break targets.
3148 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3149 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003150
Ted Kremenekb50e7162012-07-14 05:04:10 +00003151 // Create an empty block to represent the transition block for looping back
3152 // to the head of the loop. If we have increment code, it will
3153 // go in this block as well.
3154 Block = Succ = TransitionBlock = createBlock(false);
3155 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003156
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003157 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003158 // Generate increment code in its own basic block. This is the target of
3159 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003160 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003161 }
Mike Stump31feda52009-07-17 01:31:16 +00003162
Ted Kremenek902393b2009-04-28 00:51:56 +00003163 // Finish up the increment (or empty) block if it hasn't been already.
3164 if (Block) {
3165 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003166 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003167 return nullptr;
3168 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003169 }
Mike Stump31feda52009-07-17 01:31:16 +00003170
Ted Kremenekb50e7162012-07-14 05:04:10 +00003171 // The starting block for the loop increment is the block that should
3172 // represent the 'loop target' for looping back to the start of the loop.
3173 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3174 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003175
Ted Kremenekb50e7162012-07-14 05:04:10 +00003176 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003177 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003178
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003179 // If body is not a compound statement create implicit scope
3180 // and add destructors.
3181 if (!isa<CompoundStmt>(F->getBody()))
3182 addLocalScopeAndDtors(F->getBody());
3183
Mike Stump31feda52009-07-17 01:31:16 +00003184 // Now populate the body block, and in the process create new blocks as we
3185 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003186 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003187
Ted Kremenekb50e7162012-07-14 05:04:10 +00003188 if (!BodyBlock) {
3189 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3190 // Use the continue jump target as the proxy for the body.
3191 BodyBlock = ContinueJumpTarget.block;
3192 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003193 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003194 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003195 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003196
Ted Kremenekb50e7162012-07-14 05:04:10 +00003197 // Because of short-circuit evaluation, the condition of the loop can span
3198 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3199 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003200 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003201
Ted Kremenekb50e7162012-07-14 05:04:10 +00003202 do {
3203 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003204 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003205
3206 // Specially handle logical operators, which have a slightly
3207 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003208 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003209 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003210 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003211 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003212 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3213 break;
3214 }
3215
3216 // The default case when not handling logical operators.
3217 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3218 ExitConditionBlock->setTerminator(F);
3219
3220 // See if this is a known constant.
3221 TryResult KnownVal(true);
3222
3223 if (C) {
3224 // Now add the actual condition to the condition block.
3225 // Because the condition itself may contain control-flow, new blocks may
3226 // be created. Thus we update "Succ" after adding the condition.
3227 Block = ExitConditionBlock;
3228 EntryConditionBlock = addStmt(C);
3229
3230 // If this block contains a condition variable, add both the condition
3231 // variable and initializer to the CFG.
3232 if (VarDecl *VD = F->getConditionVariable()) {
3233 if (Expr *Init = VD->getInit()) {
3234 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003235 const DeclStmt *DS = F->getConditionVariableDeclStmt();
3236 assert(DS->isSingleDecl());
3237 findConstructionContexts(
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00003238 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003239 Init);
3240 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003241 EntryConditionBlock = addStmt(Init);
3242 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003243 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003244 }
3245 }
3246
3247 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003248 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003249
3250 KnownVal = tryEvaluateBool(C);
3251 }
3252
3253 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003254 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003255 // Link up the condition block with the code that follows the loop. (the
3256 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003257 addSuccessor(ExitConditionBlock,
3258 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003259 } while (false);
3260
3261 // Link up the loop-back block to the entry condition block.
3262 addSuccessor(TransitionBlock, EntryConditionBlock);
Fangrui Song6907ce22018-07-30 19:24:48 +00003263
Ted Kremenekb50e7162012-07-14 05:04:10 +00003264 // The condition block is the implicit successor for any code above the loop.
3265 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003266
Ted Kremenek9aae5132007-08-23 21:42:29 +00003267 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003268 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003269 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003270 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3271 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003272 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003273 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003274 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003275
3276 // There is no loop initialization. We are thus basically a while loop.
3277 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003278 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003279 Succ = EntryConditionBlock;
3280 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003281}
3282
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003283CFGBlock *
3284CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3285 AddStmtChoice asc) {
3286 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003287 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003288 MTE->getTemporary());
3289
3290 return VisitStmt(MTE, asc);
3291}
3292
Ted Kremenek5868ec62010-04-11 17:02:10 +00003293CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003294 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003295 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003296 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003297 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003298 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003299}
3300
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003301CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003302 // Objective-C fast enumeration 'for' statements:
3303 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3304 //
3305 // for ( Type newVariable in collection_expression ) { statements }
3306 //
3307 // becomes:
3308 //
3309 // prologue:
3310 // 1. collection_expression
3311 // T. jump to loop_entry
3312 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003313 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003314 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3315 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3316 // TB:
3317 // statements
3318 // T. jump to loop_entry
3319 // FB:
3320 // what comes after
3321 //
3322 // and
3323 //
3324 // Type existingItem;
3325 // for ( existingItem in expression ) { statements }
3326 //
3327 // becomes:
3328 //
Mike Stump31feda52009-07-17 01:31:16 +00003329 // the same with newVariable replaced with existingItem; the binding works
3330 // the same except that for one ObjCForCollectionStmt::getElement() returns
3331 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003332
Craig Topper25542942014-05-20 04:30:07 +00003333 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003334
Ted Kremenek9d56e642008-11-11 17:10:00 +00003335 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003336 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003337 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003338 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003339 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003340 } else
3341 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003342
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003343 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003344 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003345
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003346 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003347 ExitConditionBlock->setTerminator(S);
3348
3349 // The last statement in the block should be the ObjCForCollectionStmt, which
3350 // performs the actual binding to 'element' and determines if there are any
3351 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003352 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003353 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003354
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003355 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003356 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003357 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003358 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3359 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003360 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003361 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003362 return nullptr;
3363 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003364 }
Mike Stump31feda52009-07-17 01:31:16 +00003365
3366 // The condition block is the implicit successor for the loop body as well as
3367 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003368 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003369
Ted Kremenek9d56e642008-11-11 17:10:00 +00003370 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003371 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003372 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003373 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003374 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003375 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003376
Anna Zaks56b49752013-06-22 00:23:20 +00003377 // Add an intermediate block between the BodyBlock and the
3378 // EntryConditionBlock to represent the "loop back" transition, for looping
3379 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003380 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003381 Succ = LoopBackBlock = createBlock();
3382 LoopBackBlock->setLoopTarget(S);
Fangrui Song6907ce22018-07-30 19:24:48 +00003383
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003384 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003385 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003386
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003387 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003388
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003389 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003390 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003391 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003392 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003393 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003394 }
Mike Stump31feda52009-07-17 01:31:16 +00003395
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003396 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003397 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003398 }
Mike Stump31feda52009-07-17 01:31:16 +00003399
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003400 // Link up the condition block with the code that follows the loop.
3401 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003402 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003403
Ted Kremenek9d56e642008-11-11 17:10:00 +00003404 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003405 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003406 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003407}
3408
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003409CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3410 // Inline the body.
3411 return addStmt(S->getSubStmt());
3412 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3413}
3414
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003415CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003416 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003417
Ted Kremenek49805452009-05-02 01:49:13 +00003418 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003419 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003420
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003421 // The sync body starts its own basic block. This makes it a little easier
3422 // for diagnostic clients.
3423 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003424 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003425 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003426
Craig Topper25542942014-05-20 04:30:07 +00003427 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003428 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003429 }
Mike Stump31feda52009-07-17 01:31:16 +00003430
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003431 // Add the @synchronized to the CFG.
3432 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003433 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003434
Ted Kremenek49805452009-05-02 01:49:13 +00003435 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003436 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003437}
Mike Stump31feda52009-07-17 01:31:16 +00003438
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003439CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003440 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003441 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003442}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003443
John McCallfe96e0b2011-11-06 09:01:30 +00003444CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3445 autoCreateBlock();
3446
3447 // Add the PseudoObject as the last thing.
3448 appendStmt(Block, E);
3449
Fangrui Song6907ce22018-07-30 19:24:48 +00003450 CFGBlock *lastBlock = Block;
John McCallfe96e0b2011-11-06 09:01:30 +00003451
3452 // Before that, evaluate all of the semantics in order. In
3453 // CFG-land, that means appending them in reverse order.
3454 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3455 Expr *Semantic = E->getSemanticExpr(--i);
3456
3457 // If the semantic is an opaque value, we're being asked to bind
3458 // it to its source expression.
3459 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3460 Semantic = OVE->getSourceExpr();
3461
3462 if (CFGBlock *B = Visit(Semantic))
3463 lastBlock = B;
3464 }
3465
3466 return lastBlock;
3467}
3468
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003469CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003470 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003471
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003472 // Save local scope position because in case of condition variable ScopePos
3473 // won't be restored when traversing AST.
3474 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3475
3476 // Create local scope for possible condition variable.
3477 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003478 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003479 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003480 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003481 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003482 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003483 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003484
Mike Stump014b3ea2009-07-21 01:12:51 +00003485 // "while" is a control-flow statement. Thus we stop processing the current
3486 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003487 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003488 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003489 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003490 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003491 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003492 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003493 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003494 }
Mike Stump31feda52009-07-17 01:31:16 +00003495
Craig Topper25542942014-05-20 04:30:07 +00003496 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003497
Ted Kremenek9aae5132007-08-23 21:42:29 +00003498 // Process the loop body.
3499 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003500 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003501
Ted Kremenekb50e7162012-07-14 05:04:10 +00003502 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003503 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3504 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003505 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003506
Mike Stump31feda52009-07-17 01:31:16 +00003507 // Create an empty block to represent the transition block for looping back
3508 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003509 Succ = TransitionBlock = createBlock(false);
3510 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003511 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003512
Ted Kremenek9aae5132007-08-23 21:42:29 +00003513 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003514 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003515
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003516 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003517 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003518
3519 // If body is not a compound statement create implicit scope
3520 // and add destructors.
3521 if (!isa<CompoundStmt>(W->getBody()))
3522 addLocalScopeAndDtors(W->getBody());
3523
Ted Kremenek9aae5132007-08-23 21:42:29 +00003524 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003525 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003526
Ted Kremeneke9610502007-08-30 18:39:40 +00003527 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003528 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003529 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003530 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003531 }
3532
3533 // Because of short-circuit evaluation, the condition of the loop can span
3534 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3535 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003536 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003537
3538 do {
3539 Expr *C = W->getCond();
3540
3541 // Specially handle logical operators, which have a slightly
3542 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003543 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003544 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003545 std::tie(EntryConditionBlock, ExitConditionBlock) =
3546 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003547 break;
3548 }
3549
3550 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003551 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003552 ExitConditionBlock->setTerminator(W);
3553
3554 // Now add the actual condition to the condition block.
3555 // Because the condition itself may contain control-flow, new blocks may
3556 // be created. Thus we update "Succ" after adding the condition.
3557 Block = ExitConditionBlock;
3558 Block = EntryConditionBlock = addStmt(C);
3559
3560 // If this block contains a condition variable, add both the condition
3561 // variable and initializer to the CFG.
3562 if (VarDecl *VD = W->getConditionVariable()) {
3563 if (Expr *Init = VD->getInit()) {
3564 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003565 const DeclStmt *DS = W->getConditionVariableDeclStmt();
3566 assert(DS->isSingleDecl());
3567 findConstructionContexts(
3568 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3569 const_cast<DeclStmt *>(DS)),
3570 Init);
3571 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003572 EntryConditionBlock = addStmt(Init);
3573 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003574 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003575 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003576 }
Mike Stump31feda52009-07-17 01:31:16 +00003577
Ted Kremenekb50e7162012-07-14 05:04:10 +00003578 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003579 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003580
3581 // See if this is a known constant.
3582 const TryResult& KnownVal = tryEvaluateBool(C);
3583
Ted Kremenek30754282009-07-24 04:47:11 +00003584 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003585 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003586 // Link up the condition block with the code that follows the loop. (the
3587 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003588 addSuccessor(ExitConditionBlock,
3589 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003590 } while(false);
3591
3592 // Link up the loop-back block to the entry condition block.
3593 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003594
3595 // There can be no more statements in the condition block since we loop back
3596 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003597 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003598
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003599 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003600 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003601 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003602}
Mike Stump11289f42009-09-09 15:08:12 +00003603
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003604CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003605 // FIXME: For now we pretend that @catch and the code it contains does not
3606 // exit.
3607 return Block;
3608}
Mike Stump31feda52009-07-17 01:31:16 +00003609
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003610CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003611 // FIXME: This isn't complete. We basically treat @throw like a return
3612 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003613
Ted Kremenek0868eea2009-09-24 18:45:41 +00003614 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003615 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003616 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003617
Ted Kremenek93041ba2008-12-09 20:20:09 +00003618 // Create the new block.
3619 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003620
Ted Kremenek93041ba2008-12-09 20:20:09 +00003621 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003622 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003623
3624 // Add the statement to the block. This may create new blocks if S contains
3625 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003626 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003627}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003628
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003629CFGBlock *CFGBuilder::VisitObjCMessageExpr(ObjCMessageExpr *ME,
3630 AddStmtChoice asc) {
3631 findConstructionContextsForArguments(ME);
3632
3633 autoCreateBlock();
Artem Dergacheve1f30622018-07-31 19:46:14 +00003634 appendObjCMessage(Block, ME);
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003635
3636 return VisitChildren(ME);
3637}
3638
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003639CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003640 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003641 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003642 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003643
3644 // Create the new block.
3645 Block = createBlock(false);
3646
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003647 if (TryTerminatedBlock)
3648 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003649 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003650 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003651 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003652 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003653
3654 // Add the statement to the block. This may create new blocks if S contains
3655 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003656 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003657}
3658
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003659CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003660 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003661
Peter Szecsi999a25f2017-08-19 11:19:16 +00003662 addLoopExit(D);
3663
Mike Stump8d50b6a2009-07-21 01:27:50 +00003664 // "do...while" is a control-flow statement. Thus we stop processing the
3665 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003666 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003667 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003668 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003669 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003670 } else
3671 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003672
3673 // Because of short-circuit evaluation, the condition of the loop can span
3674 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3675 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003676 CFGBlock *ExitConditionBlock = createBlock(false);
3677 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003678
Ted Kremenek81e14852007-08-27 19:46:09 +00003679 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003680 ExitConditionBlock->setTerminator(D);
3681
3682 // Now add the actual condition to the condition block. Because the condition
3683 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003684 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003685 Block = ExitConditionBlock;
3686 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003687 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003688 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003689 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003690 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003691 }
Mike Stump31feda52009-07-17 01:31:16 +00003692
Ted Kremeneka1523a32008-02-27 07:20:00 +00003693 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003694 Succ = EntryConditionBlock;
3695
Mike Stump773582d2009-07-23 23:25:26 +00003696 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003697 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003698
Ted Kremenek9aae5132007-08-23 21:42:29 +00003699 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003700 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003701 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003702 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003703
Ted Kremenek9aae5132007-08-23 21:42:29 +00003704 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003705 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3706 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3707 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003708
Ted Kremenek9aae5132007-08-23 21:42:29 +00003709 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003710 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003711
Ted Kremenek9aae5132007-08-23 21:42:29 +00003712 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003713 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003714
Ted Kremenek9aae5132007-08-23 21:42:29 +00003715 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003716 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003717
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003718 // If body is not a compound statement create implicit scope
3719 // and add destructors.
3720 if (!isa<CompoundStmt>(D->getBody()))
3721 addLocalScopeAndDtors(D->getBody());
3722
Ted Kremenek9aae5132007-08-23 21:42:29 +00003723 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003724 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003725
Ted Kremeneke9610502007-08-30 18:39:40 +00003726 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003727 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003728 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003729 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003730 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003731 }
Mike Stump31feda52009-07-17 01:31:16 +00003732
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003733 // Add an intermediate block between the BodyBlock and the
3734 // ExitConditionBlock to represent the "loop back" transition. Create an
3735 // empty block to represent the transition block for looping back to the
3736 // head of the loop.
3737 // FIXME: Can we do this more efficiently without adding another block?
3738 Block = nullptr;
3739 Succ = BodyBlock;
3740 CFGBlock *LoopBackBlock = createBlock();
3741 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003742
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003743 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003744 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003745 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003746 else
Craig Topper25542942014-05-20 04:30:07 +00003747 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003748 }
Mike Stump31feda52009-07-17 01:31:16 +00003749
Ted Kremenek30754282009-07-24 04:47:11 +00003750 // Link up the condition block with the code that follows the loop.
3751 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003752 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003753
3754 // There can be no more statements in the body block(s) since we loop back to
3755 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003756 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003757
Ted Kremenek9aae5132007-08-23 21:42:29 +00003758 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003759 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003760 return BodyBlock;
3761}
3762
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003763CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003764 // "continue" is a control-flow statement. Thus we stop processing the
3765 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003766 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003767 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003768
Ted Kremenek9aae5132007-08-23 21:42:29 +00003769 // Now create a new block that ends with the continue statement.
3770 Block = createBlock(false);
3771 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003772
Ted Kremenek9aae5132007-08-23 21:42:29 +00003773 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003774 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003775 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003776 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003777 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003778 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003779 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003780
Ted Kremenek9aae5132007-08-23 21:42:29 +00003781 return Block;
3782}
Mike Stump11289f42009-09-09 15:08:12 +00003783
Peter Collingbournee190dee2011-03-11 19:24:49 +00003784CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3785 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003786 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003787 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003788 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003789 }
Mike Stump11289f42009-09-09 15:08:12 +00003790
Ted Kremenek93668002009-07-17 22:18:43 +00003791 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003792 CFGBlock *lastBlock = Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00003793
Ted Kremenek93668002009-07-17 22:18:43 +00003794 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003795 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003796 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003797 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003798 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003799 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003800}
Mike Stump11289f42009-09-09 15:08:12 +00003801
Ted Kremenek93668002009-07-17 22:18:43 +00003802/// VisitStmtExpr - Utility method to handle (nested) statement
3803/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003804CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003805 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003806 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003807 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003808 }
Ted Kremenek93668002009-07-17 22:18:43 +00003809 return VisitCompoundStmt(SE->getSubStmt());
3810}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003811
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003812CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003813 // "switch" is a control-flow statement. Thus we stop processing the current
3814 // block.
Craig Topper25542942014-05-20 04:30:07 +00003815 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003816
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003817 // Save local scope position because in case of condition variable ScopePos
3818 // won't be restored when traversing AST.
3819 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3820
Richard Smitha547eb22016-07-14 00:11:03 +00003821 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003822 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003823 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003824
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003825 // Create local scope for possible condition variable.
3826 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003827 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003828 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003829
Matthias Gehre351c2182017-07-12 07:04:19 +00003830 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003831
Ted Kremenek9aae5132007-08-23 21:42:29 +00003832 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003833 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003834 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003835 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003836 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003837
3838 // Save the current "switch" context.
3839 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003840 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003841 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003842
Mike Stump31feda52009-07-17 01:31:16 +00003843 // Set the "default" case to be the block after the switch statement. If the
3844 // switch statement contains a "default:", this value will be overwritten with
3845 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003846 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003847
Ted Kremenek9aae5132007-08-23 21:42:29 +00003848 // Create a new block that will contain the switch statement.
3849 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003850
Ted Kremenek9aae5132007-08-23 21:42:29 +00003851 // Now process the switch body. The code after the switch is the implicit
3852 // successor.
3853 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003854 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003855
3856 // When visiting the body, the case statements should automatically get linked
3857 // up to the switch. We also don't keep a pointer to the body, since all
3858 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003859 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003860 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003861
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003862 // For pruning unreachable case statements, save the current state
3863 // for tracking the condition value.
3864 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3865 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003866
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003867 // Determine if the switch condition can be explicitly evaluated.
3868 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003869 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003870 bool b = tryEvaluate(Terminator->getCond(), result);
3871 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003872 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003873
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003874 // If body is not a compound statement create implicit scope
3875 // and add destructors.
3876 if (!isa<CompoundStmt>(Terminator->getBody()))
3877 addLocalScopeAndDtors(Terminator->getBody());
3878
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003879 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003880 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003881 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003882 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003883 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003884
Mike Stump31feda52009-07-17 01:31:16 +00003885 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003886 // following the switch body. Moreover, take into account if all the
3887 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003888 //
3889 // Note: We add a successor to a switch that is considered covered yet has no
3890 // case statements if the enumeration has no enumerators.
3891 bool SwitchAlwaysHasSuccessor = false;
3892 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3893 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3894 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003895 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3896 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003897
Ted Kremenek81e14852007-08-27 19:46:09 +00003898 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003899 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003900 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003901 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003902
Richard Smitha547eb22016-07-14 00:11:03 +00003903 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003904 // SwitchStmt and the condition variable initialization to the CFG.
3905 if (VarDecl *VD = Terminator->getConditionVariable()) {
3906 if (Expr *Init = VD->getInit()) {
3907 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003908 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003909 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003910 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003911 }
3912 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003913
Richard Smitha547eb22016-07-14 00:11:03 +00003914 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3915 if (Stmt *Init = Terminator->getInit()) {
3916 autoCreateBlock();
3917 LastBlock = addStmt(Init);
3918 }
3919
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003920 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003921}
Fangrui Song6907ce22018-07-30 19:24:48 +00003922
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003923static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003924 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003925 const CaseStmt *CS,
3926 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003927 if (!switchCond)
3928 return true;
3929
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003930 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003931
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003932 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003933 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003934 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003935 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003936 const llvm::APSInt &condInt = switchCond->Val.getInt();
Fangrui Song6907ce22018-07-30 19:24:48 +00003937
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003938 if (condInt == lhsInt) {
3939 addCase = true;
3940 switchExclusivelyCovered = true;
3941 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003942 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003943 if (const Expr *RHS = CS->getRHS()) {
3944 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003945 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003946 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003947 addCase = true;
3948 switchExclusivelyCovered = true;
3949 }
3950 }
3951 }
3952 }
3953 else
3954 addCase = true;
3955 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003956 return addCase;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003957}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003958
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003959CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003960 // CaseStmts are essentially labels, so they are the first statement in a
3961 // block.
Craig Topper25542942014-05-20 04:30:07 +00003962 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003963
Ted Kremenek60fa6572010-08-04 23:54:30 +00003964 if (Stmt *Sub = CS->getSubStmt()) {
3965 // For deeply nested chains of CaseStmts, instead of doing a recursion
3966 // (which can blow out the stack), manually unroll and create blocks
3967 // along the way.
3968 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003969 CFGBlock *currentBlock = createBlock(false);
3970 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003971
Ted Kremenek60fa6572010-08-04 23:54:30 +00003972 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003973 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003974 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003975 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003976
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003977 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003978 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003979 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003980 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003981
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003982 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003983 CS = cast<CaseStmt>(Sub);
3984 Sub = CS->getSubStmt();
3985 }
3986
3987 addStmt(Sub);
3988 }
Mike Stump11289f42009-09-09 15:08:12 +00003989
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003990 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003991 if (!CaseBlock)
3992 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003993
3994 // Cases statements partition blocks, so this is the top of the basic block we
3995 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003996 CaseBlock->setLabel(CS);
3997
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003998 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003999 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004000
4001 // Add this block to the list of successors for the block with the switch
4002 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00004003 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004004 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00004005 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004006 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00004007
Ted Kremenek9aae5132007-08-23 21:42:29 +00004008 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004009 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004010
Ted Kremenek60fa6572010-08-04 23:54:30 +00004011 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004012 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004013 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004014 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00004015 // This block is now the implicit successor of other blocks.
4016 Succ = CaseBlock;
4017 }
Mike Stump31feda52009-07-17 01:31:16 +00004018
Ted Kremenek60fa6572010-08-04 23:54:30 +00004019 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00004020}
Mike Stump31feda52009-07-17 01:31:16 +00004021
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004022CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00004023 if (Terminator->getSubStmt())
4024 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00004025
Ted Kremenek654c78f2008-02-13 22:05:39 +00004026 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004027
4028 if (!DefaultCaseBlock)
4029 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004030
4031 // Default statements partition blocks, so this is the top of the basic block
4032 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004033 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00004034
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004035 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004036 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00004037
Mike Stump31feda52009-07-17 01:31:16 +00004038 // Unlike case statements, we don't add the default block to the successors
4039 // for the switch statement immediately. This is done when we finish
4040 // processing the switch statement. This allows for the default case
4041 // (including a fall-through to the code after the switch statement) to always
4042 // be the last successor of a switch-terminated block.
4043
Ted Kremenek654c78f2008-02-13 22:05:39 +00004044 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004045 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004046
Ted Kremenek654c78f2008-02-13 22:05:39 +00004047 // This block is now the implicit successor of other blocks.
4048 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00004049
4050 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00004051}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004052
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004053CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
4054 // "try"/"catch" is a control-flow statement. Thus we stop processing the
4055 // current block.
Craig Topper25542942014-05-20 04:30:07 +00004056 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004057
4058 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004059 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004060 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004061 TrySuccessor = Block;
4062 } else TrySuccessor = Succ;
4063
Mike Stump0bdba6c2010-01-20 01:15:34 +00004064 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004065
4066 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00004067 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004068 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00004069 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004070
Mike Stump0bdba6c2010-01-20 01:15:34 +00004071 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004072 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
4073 // The code after the try is the implicit successor.
4074 Succ = TrySuccessor;
4075 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00004076 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00004077 HasCatchAll = true;
4078 }
Craig Topper25542942014-05-20 04:30:07 +00004079 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004080 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00004081 if (!CatchBlock)
4082 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004083 // Add this block to the list of successors for the block with the try
4084 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004085 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004086 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00004087 if (!HasCatchAll) {
4088 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004089 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00004090 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004091 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00004092 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004093
4094 // The code after the try is the implicit successor.
4095 Succ = TrySuccessor;
4096
Mike Stump845384a2010-01-20 01:30:58 +00004097 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00004098 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
4099 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00004100
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004101 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004102 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004103 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004104}
4105
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004106CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004107 // CXXCatchStmt are treated like labels, so they are the first statement in a
4108 // block.
4109
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004110 // Save local scope position because in case of exception variable ScopePos
4111 // won't be restored when traversing AST.
4112 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4113
4114 // Create local scope for possible exception variable.
4115 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004116 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004117 LocalScope::const_iterator BeginScopePos = ScopePos;
4118 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004119 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004120 }
4121
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004122 if (CS->getHandlerBlock())
4123 addStmt(CS->getHandlerBlock());
4124
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004125 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004126 if (!CatchBlock)
4127 CatchBlock = createBlock();
Fangrui Song6907ce22018-07-30 19:24:48 +00004128
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004129 // CXXCatchStmt is more than just a label. They have semantic meaning
4130 // as well, as they implicitly "initialize" the catch variable. Add
4131 // it to the CFG as a CFGElement so that the control-flow of these
4132 // semantics gets captured.
4133 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004134
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004135 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4136 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004137 CatchBlock->setLabel(CS);
4138
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004139 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004140 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004141 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004142
4143 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004144 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004145
4146 return CatchBlock;
4147}
4148
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004149CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004150 // C++0x for-range statements are specified as [stmt.ranged]:
4151 //
4152 // {
4153 // auto && __range = range-init;
4154 // for ( auto __begin = begin-expr,
4155 // __end = end-expr;
4156 // __begin != __end;
4157 // ++__begin ) {
4158 // for-range-declaration = *__begin;
4159 // statement
4160 // }
4161 // }
4162
4163 // Save local scope position before the addition of the implicit variables.
4164 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4165
4166 // Create local scopes and destructors for range, begin and end variables.
4167 if (Stmt *Range = S->getRangeStmt())
4168 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004169 if (Stmt *Begin = S->getBeginStmt())
4170 addLocalScopeForStmt(Begin);
4171 if (Stmt *End = S->getEndStmt())
4172 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004173 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004174
4175 LocalScope::const_iterator ContinueScopePos = ScopePos;
4176
4177 // "for" is a control-flow statement. Thus we stop processing the current
4178 // block.
Craig Topper25542942014-05-20 04:30:07 +00004179 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004180 if (Block) {
4181 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004182 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004183 LoopSuccessor = Block;
4184 } else
4185 LoopSuccessor = Succ;
4186
4187 // Save the current value for the break targets.
4188 // All breaks should go to the code following the loop.
4189 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4190 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4191
4192 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004193 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004194 ConditionBlock->setTerminator(S);
4195
4196 // Now add the actual condition to the condition block.
4197 if (Expr *C = S->getCond()) {
4198 Block = ConditionBlock;
4199 CFGBlock *BeginConditionBlock = addStmt(C);
4200 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004201 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004202 assert(BeginConditionBlock == ConditionBlock &&
4203 "condition block in for-range was unexpectedly complex");
4204 (void)BeginConditionBlock;
4205 }
4206
4207 // The condition block is the implicit successor for the loop body as well as
4208 // any code above the loop.
4209 Succ = ConditionBlock;
4210
4211 // See if this is a known constant.
4212 TryResult KnownVal(true);
4213
4214 if (S->getCond())
4215 KnownVal = tryEvaluateBool(S->getCond());
4216
4217 // Now create the loop body.
4218 {
4219 assert(S->getBody());
4220
4221 // Save the current values for Block, Succ, and continue targets.
4222 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4223 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4224
4225 // Generate increment code in its own basic block. This is the target of
4226 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004227 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004228 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004229 if (badCFG)
4230 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004231 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4232
4233 // The starting block for the loop increment is the block that should
4234 // represent the 'loop target' for looping back to the start of the loop.
4235 ContinueJumpTarget.block->setLoopTarget(S);
4236
4237 // Finish up the increment block and prepare to start the loop body.
4238 assert(Block);
4239 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004240 return nullptr;
4241 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004242
4243 // Add implicit scope and dtors for loop variable.
4244 addLocalScopeAndDtors(S->getLoopVarStmt());
4245
4246 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004247 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004248 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004249 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004250 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004251 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004252 return nullptr;
4253
Richard Smith02e85f32011-04-14 22:09:26 +00004254 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004255 addSuccessor(ConditionBlock,
4256 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004257 }
4258
4259 // Link up the condition block with the code that follows the loop (the
4260 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004261 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004262
4263 // Add the initialization statements.
4264 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004265 addStmt(S->getBeginStmt());
4266 addStmt(S->getEndStmt());
Richard Smith8baa5002018-09-28 18:44:09 +00004267 CFGBlock *Head = addStmt(S->getRangeStmt());
4268 if (S->getInit())
4269 Head = addStmt(S->getInit());
4270 return Head;
Richard Smith02e85f32011-04-14 22:09:26 +00004271}
4272
John McCall5d413782010-12-06 08:20:24 +00004273CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004274 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004275 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004276 // If adding implicit destructors visit the full expression for adding
4277 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004278 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004279 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004280
4281 // Full expression has to be added as CFGStmt so it will be sequenced
4282 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004283 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004284 }
4285 return Visit(E->getSubExpr(), asc);
4286}
4287
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004288CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4289 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004290 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004291 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004292 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004293
Artem Dergachev783a4572018-02-23 22:20:39 +00004294 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004295 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004296 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004297
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004298 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004299 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004300 }
4301 return Visit(E->getSubExpr(), asc);
4302}
4303
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004304CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4305 AddStmtChoice asc) {
Artem Dergachevbd880fe2018-07-31 19:39:37 +00004306 // If the constructor takes objects as arguments by value, we need to properly
4307 // construct these objects. Construction contexts we find here aren't for the
4308 // constructor C, they're for its arguments only.
4309 findConstructionContextsForArguments(C);
4310
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004311 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004312 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004313
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004314 return VisitChildren(C);
4315}
4316
Jordan Rosec9176072014-01-13 17:59:19 +00004317CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4318 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004319 autoCreateBlock();
4320 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004321
Artem Dergachev783a4572018-02-23 22:20:39 +00004322 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004323 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004324 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004325
Jordan Rosec9176072014-01-13 17:59:19 +00004326 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004327 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004328
Jordan Rosec9176072014-01-13 17:59:19 +00004329 if (BuildOpts.AddCXXNewAllocator)
4330 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004331
Jordan Rosec9176072014-01-13 17:59:19 +00004332 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004333 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004334
Jordan Rosec9176072014-01-13 17:59:19 +00004335 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4336 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004337 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004338
Jordan Rosec9176072014-01-13 17:59:19 +00004339 return Block;
4340}
Jordan Rosed2f40792013-09-03 17:00:57 +00004341
4342CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4343 AddStmtChoice asc) {
4344 autoCreateBlock();
4345 appendStmt(Block, DE);
4346 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004347 if (!DTy.isNull()) {
4348 DTy = DTy.getNonReferenceType();
4349 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4350 if (RD) {
4351 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4352 appendDeleteDtor(Block, RD, DE);
4353 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004354 }
4355
4356 return VisitChildren(DE);
4357}
4358
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004359CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4360 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004361 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004362 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004363 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004364 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004365 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004366 }
4367 return Visit(E->getSubExpr(), asc);
4368}
4369
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004370CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4371 AddStmtChoice asc) {
Artem Dergachevc531d542018-08-14 21:10:46 +00004372 // If the constructor takes objects as arguments by value, we need to properly
4373 // construct these objects. Construction contexts we find here aren't for the
4374 // constructor C, they're for its arguments only.
4375 findConstructionContextsForArguments(C);
4376
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004377 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004378 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004379 return VisitChildren(C);
4380}
4381
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004382CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4383 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004384 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004385 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004386 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004387 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004388 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004389}
4390
Bill Wendling8003edc2018-11-09 00:41:36 +00004391CFGBlock *CFGBuilder::VisitConstantExpr(ConstantExpr *E, AddStmtChoice asc) {
4392 return Visit(E->getSubExpr(), AddStmtChoice());
4393}
4394
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004395CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004396 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004397 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004398
Ted Kremenekeda180e22007-08-28 19:26:49 +00004399 if (!IBlock) {
4400 IBlock = createBlock(false);
4401 cfg->setIndirectGotoBlock(IBlock);
4402 }
Mike Stump31feda52009-07-17 01:31:16 +00004403
Ted Kremenekeda180e22007-08-28 19:26:49 +00004404 // IndirectGoto is a control-flow statement. Thus we stop processing the
4405 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004406 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004407 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004408
Ted Kremenekeda180e22007-08-28 19:26:49 +00004409 Block = createBlock(false);
4410 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004411 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004412 return addStmt(I->getTarget());
4413}
4414
Manuel Klimekb5616c92014-08-07 10:42:17 +00004415CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4416 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004417 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4418
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004419tryAgain:
4420 if (!E) {
4421 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004422 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004423 }
4424 switch (E->getStmtClass()) {
4425 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004426 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004427
4428 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004429 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4430 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004431
4432 case Stmt::CXXBindTemporaryExprClass:
4433 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004434 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004435
John McCallc07a0c72011-02-17 10:25:35 +00004436 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004437 case Stmt::ConditionalOperatorClass:
4438 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004439 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004440
4441 case Stmt::ImplicitCastExprClass:
4442 // For implicit cast we want BindToTemporary to be passed further.
4443 E = cast<CastExpr>(E)->getSubExpr();
4444 goto tryAgain;
4445
Manuel Klimekb0042c42014-07-30 08:34:42 +00004446 case Stmt::CXXFunctionalCastExprClass:
4447 // For functional cast we want BindToTemporary to be passed further.
4448 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4449 goto tryAgain;
4450
Bill Wendling8003edc2018-11-09 00:41:36 +00004451 case Stmt::ConstantExprClass:
4452 E = cast<ConstantExpr>(E)->getSubExpr();
4453 goto tryAgain;
4454
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004455 case Stmt::ParenExprClass:
4456 E = cast<ParenExpr>(E)->getSubExpr();
4457 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004458
Manuel Klimekb0042c42014-07-30 08:34:42 +00004459 case Stmt::MaterializeTemporaryExprClass: {
4460 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4461 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4462 SmallVector<const Expr *, 2> CommaLHSs;
4463 SmallVector<SubobjectAdjustment, 2> Adjustments;
4464 // Find the expression whose lifetime needs to be extended.
4465 E = const_cast<Expr *>(
4466 cast<MaterializeTemporaryExpr>(E)
4467 ->GetTemporaryExpr()
4468 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4469 // Visit the skipped comma operator left-hand sides for other temporaries.
4470 for (const Expr *CommaLHS : CommaLHSs) {
4471 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004472 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004473 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004474 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004475 }
Richard Smith4137af22014-07-27 05:12:49 +00004476
4477 case Stmt::BlockExprClass:
4478 // Don't recurse into blocks; their subexpressions don't get evaluated
4479 // here.
4480 return Block;
4481
4482 case Stmt::LambdaExprClass: {
4483 // For lambda expressions, only recurse into the capture initializers,
4484 // and not the body.
4485 auto *LE = cast<LambdaExpr>(E);
4486 CFGBlock *B = Block;
4487 for (Expr *Init : LE->capture_inits()) {
Richard Smith7ed5fb22018-07-27 17:13:18 +00004488 if (Init) {
4489 if (CFGBlock *R = VisitForTemporaryDtors(
4490 Init, /*BindToTemporary=*/false, Context))
4491 B = R;
4492 }
Richard Smith4137af22014-07-27 05:12:49 +00004493 }
4494 return B;
4495 }
4496
4497 case Stmt::CXXDefaultArgExprClass:
4498 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4499 goto tryAgain;
4500
4501 case Stmt::CXXDefaultInitExprClass:
4502 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4503 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004504 }
4505}
4506
Manuel Klimekb5616c92014-08-07 10:42:17 +00004507CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4508 TempDtorContext &Context) {
4509 if (isa<LambdaExpr>(E)) {
4510 // Do not visit the children of lambdas; they have their own CFGs.
4511 return Block;
4512 }
4513
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004514 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004515 // order that they will appear in the CFG. Because the CFG is built
4516 // bottom-up, this means we visit them in their natural order, which
4517 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004518 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004519 for (Stmt *Child : E->children())
4520 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004521 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004522 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004523
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004524 return B;
4525}
4526
Manuel Klimekb5616c92014-08-07 10:42:17 +00004527CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4528 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004529 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004530 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004531 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4532 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4533 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004534
Manuel Klimekedf925b92014-08-07 18:44:19 +00004535 // We do not know at CFG-construction time whether the right-hand-side was
4536 // executed, thus we add a branch node that depends on the temporary
4537 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004538 TempDtorContext RHSContext(
4539 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004540 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004541 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004542
Manuel Klimekb5616c92014-08-07 10:42:17 +00004543 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004544 }
4545
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004546 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004547 // For assignment operator (=) LHS expression is visited
4548 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004549 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4550 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004551 return LHSBlock ? LHSBlock : RHSBlock;
4552 }
4553
4554 // For any other binary operator RHS expression is visited before
4555 // LHS expression (order of children). For destructors visit them in reverse
4556 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004557 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4558 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004559 return RHSBlock ? RHSBlock : LHSBlock;
4560}
4561
4562CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004563 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004564 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004565 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004566 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004567 // If lifetime of temporary is not prolonged (by assigning to constant
4568 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004569
Chandler Carruthad747252011-09-13 06:09:01 +00004570 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004571
Richard Trieu95a192a2015-05-28 00:14:02 +00004572 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004573 // If the destructor is marked as a no-return destructor, we need to
4574 // create a new block for the destructor which does not have as a
4575 // successor anything built thus far. Control won't flow out of this
4576 // block.
4577 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004578 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004579 } else if (Context.needsTempDtorBranch()) {
4580 // If we need to introduce a branch, we add a new block that we will hook
4581 // up to a decision block later.
4582 if (B) Succ = B;
4583 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004584 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004585 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004586 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004587 if (Context.needsTempDtorBranch()) {
4588 Context.setDecisionPoint(Succ, E);
4589 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004590 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004591
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004592 B = Block;
4593 }
4594 return B;
4595}
4596
Manuel Klimekb5616c92014-08-07 10:42:17 +00004597void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4598 CFGBlock *FalseSucc) {
4599 if (!Context.TerminatorExpr) {
4600 // If no temporary was found, we do not need to insert a decision point.
4601 return;
4602 }
4603 assert(Context.TerminatorExpr);
4604 CFGBlock *Decision = createBlock(false);
4605 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004606 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004607 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004608 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004609 Block = Decision;
4610}
4611
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004612CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004613 AbstractConditionalOperator *E, bool BindToTemporary,
4614 TempDtorContext &Context) {
4615 VisitForTemporaryDtors(E->getCond(), false, Context);
4616 CFGBlock *ConditionBlock = Block;
4617 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004618 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004619 TryResult NegatedVal = ConditionVal;
4620 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004621
Manuel Klimekdeb02622014-08-08 07:37:13 +00004622 TempDtorContext TrueContext(
4623 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004624 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004625 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004626
Manuel Klimekb5616c92014-08-07 10:42:17 +00004627 Block = ConditionBlock;
4628 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004629 TempDtorContext FalseContext(
4630 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004631 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004632
Manuel Klimekb5616c92014-08-07 10:42:17 +00004633 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004634 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004635 } else if (TrueContext.TerminatorExpr) {
4636 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004637 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004638 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004639 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004640 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004641 return Block;
4642}
4643
Mike Stump31feda52009-07-17 01:31:16 +00004644/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4645/// no successors or predecessors. If this is the first block created in the
4646/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004647CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004648 bool first_block = begin() == end();
4649
4650 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004651 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004652 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004653 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004654
4655 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004656 if (first_block)
4657 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004658
4659 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004660 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004661}
4662
David Blaikiee90195c2014-08-29 18:53:26 +00004663/// buildCFG - Constructs a CFG from an AST.
4664std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4665 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004666 CFGBuilder Builder(C, BO);
4667 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004668}
4669
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004670const CXXDestructorDecl *
4671CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004672 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004673 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004674 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004675 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004676 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004677 case CFGElement::Statement:
4678 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004679 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004680 case CFGElement::ScopeBegin:
4681 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004682 llvm_unreachable("getDestructorDecl should only be used with "
4683 "ImplicitDtors");
4684 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004685 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004686 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004687
4688 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4689 //
4690 // Lifetime-extending constructs are handled here. This works for a single
4691 // temporary in an initializer expression.
4692 if (ty->isReferenceType()) {
4693 if (const Expr *Init = var->getInit()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00004694 ty = getReferenceInitTemporaryType(Init);
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004695 }
4696 }
4697
Ted Kremeneke7d78882012-03-19 23:48:41 +00004698 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004699 ty = arrayType->getElementType();
4700 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004701 const RecordType *recordType = ty->getAs<RecordType>();
4702 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004703 cast<CXXRecordDecl>(recordType->getDecl());
Fangrui Song6907ce22018-07-30 19:24:48 +00004704 return classDecl->getDestructor();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004705 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004706 case CFGElement::DeleteDtor: {
4707 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4708 QualType DTy = DE->getDestroyedType();
4709 DTy = DTy.getNonReferenceType();
4710 const CXXRecordDecl *classDecl =
4711 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4712 return classDecl->getDestructor();
4713 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004714 case CFGElement::TemporaryDtor: {
4715 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004716 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004717 const CXXTemporary *temp = bindExpr->getTemporary();
4718 return temp->getDestructor();
4719 }
4720 case CFGElement::BaseDtor:
4721 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004722 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004723 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004724 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004725 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004726}
4727
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004728bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004729 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4730 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004731 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004732}
4733
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004734//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004735// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004736//===----------------------------------------------------------------------===//
4737
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004738CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004739 : ReachableBlock(IsReachable ? B : nullptr),
4740 UnreachableBlock(!IsReachable ? B : nullptr,
4741 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004742
4743CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004744 : ReachableBlock(B),
4745 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4746 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004747
4748void CFGBlock::addSuccessor(AdjacentBlock Succ,
4749 BumpVectorContext &C) {
4750 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004751 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004752
4753 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004754 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004755
4756 Succs.push_back(Succ, C);
4757}
4758
Ted Kremenekb0371852010-09-09 00:06:04 +00004759bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004760 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004761 if (F.IgnoreNullPredecessors && !From)
4762 return true;
4763
4764 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004765 // If the 'To' has no label or is labeled but the label isn't a
4766 // CaseStmt then filter this edge.
4767 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004768 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004769 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004770 const Stmt *L = To->getLabel();
4771 if (!L || !isa<CaseStmt>(L))
4772 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004773 }
4774 }
4775 }
4776
4777 return false;
4778}
4779
4780//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004781// CFG pretty printing
4782//===----------------------------------------------------------------------===//
4783
Ted Kremenek7e776b12007-08-22 18:22:34 +00004784namespace {
4785
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004786class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004787 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4788 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4789
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004790 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004791 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004792 signed currentBlock = 0;
4793 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004794 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004795
Eugene Zelenko38c70522017-12-07 21:55:09 +00004796public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004797 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004798 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004799 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4800 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004801 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Fangrui Song6907ce22018-07-30 19:24:48 +00004802 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004803 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4804 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004805 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004806 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004807
Ted Kremenek96a7a592011-03-01 03:15:10 +00004808 switch (stmt->getStmtClass()) {
4809 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004810 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4811 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004812 case Stmt::IfStmtClass: {
4813 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4814 if (var)
4815 DeclMap[var] = P;
4816 break;
4817 }
4818 case Stmt::ForStmtClass: {
4819 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4820 if (var)
4821 DeclMap[var] = P;
4822 break;
4823 }
4824 case Stmt::WhileStmtClass: {
4825 const VarDecl *var =
4826 cast<WhileStmt>(stmt)->getConditionVariable();
4827 if (var)
4828 DeclMap[var] = P;
4829 break;
4830 }
4831 case Stmt::SwitchStmtClass: {
4832 const VarDecl *var =
4833 cast<SwitchStmt>(stmt)->getConditionVariable();
4834 if (var)
4835 DeclMap[var] = P;
4836 break;
4837 }
4838 case Stmt::CXXCatchStmtClass: {
4839 const VarDecl *var =
4840 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4841 if (var)
4842 DeclMap[var] = P;
4843 break;
4844 }
4845 default:
4846 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004847 }
4848 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004849 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004850 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004851 }
Mike Stump31feda52009-07-17 01:31:16 +00004852
Eugene Zelenko38c70522017-12-07 21:55:09 +00004853 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004854
Chris Lattnerc61089a2009-06-30 01:26:17 +00004855 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004856 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004857 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004858
Craig Topperb45acb82014-03-14 06:02:07 +00004859 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004860 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004861
4862 if (I == StmtMap.end())
4863 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004864
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004865 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004866 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004867 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004868 }
Mike Stump31feda52009-07-17 01:31:16 +00004869
Ted Kremenek60983dc2010-01-19 20:52:05 +00004870 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004871 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004872 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004873
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004874 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004875 DeclMapTy::iterator I = DeclMap.find(D);
4876
4877 if (I == DeclMap.end())
4878 return false;
4879
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004880 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004881 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004882 return false;
4883 }
4884
4885 OS << "[B" << I->second.first << "." << I->second.second << "]";
4886 return true;
4887 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004888};
4889
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004890class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004891 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004892 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004893 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004894 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004895
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004896public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004897 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004898 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004899 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004900 this->Policy.IncludeNewlines = false;
4901 }
Mike Stump31feda52009-07-17 01:31:16 +00004902
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004903 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004904 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004905 if (Stmt *C = I->getCond())
4906 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004907 }
Mike Stump31feda52009-07-17 01:31:16 +00004908
Ted Kremenek9aae5132007-08-23 21:42:29 +00004909 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004910 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004911 Terminator->printPretty(OS, Helper, Policy);
4912 }
4913
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004914 void VisitDeclStmt(DeclStmt *DS) {
4915 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4916 OS << "static init " << VD->getName();
4917 }
4918
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004919 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004920 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004921 if (F->getInit())
4922 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004923 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004924 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004925 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004926 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004927 if (F->getInc())
4928 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004929 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004930 }
Mike Stump31feda52009-07-17 01:31:16 +00004931
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004932 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004933 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004934 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004935 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004936 }
Mike Stump31feda52009-07-17 01:31:16 +00004937
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004938 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004939 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004940 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004941 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004942 }
Mike Stump31feda52009-07-17 01:31:16 +00004943
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004944 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004945 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004946 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004947 }
Mike Stump31feda52009-07-17 01:31:16 +00004948
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004949 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004950 OS << "try ...";
4951 }
4952
Nico Weber699670e2017-08-23 15:33:16 +00004953 void VisitSEHTryStmt(SEHTryStmt *CS) {
4954 OS << "__try ...";
4955 }
4956
John McCallc07a0c72011-02-17 10:25:35 +00004957 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004958 if (Stmt *Cond = C->getCond())
4959 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004960 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004961 }
Mike Stump31feda52009-07-17 01:31:16 +00004962
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004963 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004964 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004965 if (Stmt *Cond = C->getCond())
4966 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004967 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004968 }
Mike Stump31feda52009-07-17 01:31:16 +00004969
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004970 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004971 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004972 if (Stmt *T = I->getTarget())
4973 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004974 }
Mike Stump31feda52009-07-17 01:31:16 +00004975
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004976 void VisitBinaryOperator(BinaryOperator* B) {
4977 if (!B->isLogicalOp()) {
4978 VisitExpr(B);
4979 return;
4980 }
Mike Stump31feda52009-07-17 01:31:16 +00004981
Richard Trieuddd01ce2014-06-09 22:53:25 +00004982 if (B->getLHS())
4983 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004984
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004985 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004986 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004987 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004988 return;
John McCalle3027922010-08-25 11:45:40 +00004989 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004990 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004991 return;
4992 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004993 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004994 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004995 }
Mike Stump31feda52009-07-17 01:31:16 +00004996
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004997 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004998 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004999 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00005000
5001public:
5002 void print(CFGTerminator T) {
5003 if (T.isTemporaryDtorsBranch())
5004 OS << "(Temp Dtor) ";
5005 Visit(T.getStmt());
5006 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00005007};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005008
5009} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00005010
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005011static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
5012 const CXXCtorInitializer *I) {
5013 if (I->isBaseInitializer())
5014 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
5015 else if (I->isDelegatingInitializer())
5016 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
5017 else
5018 OS << I->getAnyMember()->getName();
5019 OS << "(";
5020 if (Expr *IE = I->getInit())
5021 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
5022 OS << ")";
5023
5024 if (I->isBaseInitializer())
5025 OS << " (Base initializer)";
5026 else if (I->isDelegatingInitializer())
5027 OS << " (Delegating initializer)";
5028 else
5029 OS << " (Member initializer)";
5030}
5031
Artem Dergachev1527dec2018-03-12 23:12:40 +00005032static void print_construction_context(raw_ostream &OS,
5033 StmtPrinterHelper &Helper,
5034 const ConstructionContext *CC) {
Artem Dergachevff267df2018-06-28 00:04:54 +00005035 SmallVector<const Stmt *, 3> Stmts;
Artem Dergachev1527dec2018-03-12 23:12:40 +00005036 switch (CC->getKind()) {
Artem Dergachev922455f2018-03-22 22:02:38 +00005037 case ConstructionContext::SimpleConstructorInitializerKind: {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005038 OS << ", ";
Artem Dergachev922455f2018-03-22 22:02:38 +00005039 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC);
5040 print_initializer(OS, Helper, SICC->getCXXCtorInitializer());
Artem Dergacheva657a322018-07-31 20:45:53 +00005041 return;
Artem Dergachev922455f2018-03-22 22:02:38 +00005042 }
5043 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: {
5044 OS << ", ";
5045 const auto *CICC =
5046 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC);
5047 print_initializer(OS, Helper, CICC->getCXXCtorInitializer());
Artem Dergachevff267df2018-06-28 00:04:54 +00005048 Stmts.push_back(CICC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005049 break;
5050 }
5051 case ConstructionContext::SimpleVariableKind: {
Artem Dergachev317291e2018-03-22 21:37:39 +00005052 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005053 Stmts.push_back(SDSCC->getDeclStmt());
Artem Dergachev317291e2018-03-22 21:37:39 +00005054 break;
5055 }
5056 case ConstructionContext::CXX17ElidedCopyVariableKind: {
5057 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005058 Stmts.push_back(CDSCC->getDeclStmt());
5059 Stmts.push_back(CDSCC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005060 break;
5061 }
5062 case ConstructionContext::NewAllocatedObjectKind: {
5063 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005064 Stmts.push_back(NECC->getCXXNewExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005065 break;
5066 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005067 case ConstructionContext::SimpleReturnedValueKind: {
5068 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005069 Stmts.push_back(RSCC->getReturnStmt());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005070 break;
5071 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005072 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: {
5073 const auto *RSCC =
5074 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005075 Stmts.push_back(RSCC->getReturnStmt());
5076 Stmts.push_back(RSCC->getCXXBindTemporaryExpr());
Artem Dergachev317291e2018-03-22 21:37:39 +00005077 break;
5078 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005079 case ConstructionContext::SimpleTemporaryObjectKind: {
5080 const auto *TOCC = cast<SimpleTemporaryObjectConstructionContext>(CC);
5081 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5082 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5083 break;
5084 }
5085 case ConstructionContext::ElidedTemporaryObjectKind: {
5086 const auto *TOCC = cast<ElidedTemporaryObjectConstructionContext>(CC);
5087 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5088 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5089 Stmts.push_back(TOCC->getConstructorAfterElision());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005090 break;
5091 }
Artem Dergacheva657a322018-07-31 20:45:53 +00005092 case ConstructionContext::ArgumentKind: {
5093 const auto *ACC = cast<ArgumentConstructionContext>(CC);
5094 if (const Stmt *BTE = ACC->getCXXBindTemporaryExpr()) {
5095 OS << ", ";
5096 Helper.handledStmt(const_cast<Stmt *>(BTE), OS);
5097 }
5098 OS << ", ";
5099 Helper.handledStmt(const_cast<Expr *>(ACC->getCallLikeExpr()), OS);
5100 OS << "+" << ACC->getIndex();
5101 return;
5102 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005103 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005104 for (auto I: Stmts)
5105 if (I) {
5106 OS << ", ";
5107 Helper.handledStmt(const_cast<Stmt *>(I), OS);
5108 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005109}
5110
Aaron Ballmanff924b02013-11-18 20:11:50 +00005111static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00005112 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00005113 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
5114 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00005115 assert(S != nullptr && "Expecting non-null Stmt");
5116
Aaron Ballmanff924b02013-11-18 20:11:50 +00005117 // special printing for statement-expressions.
5118 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
5119 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00005120
Benjamin Kramer5733e352015-07-18 17:09:36 +00005121 auto Children = Sub->children();
5122 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005123 OS << "({ ... ; ";
5124 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
5125 OS << " })\n";
5126 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005127 }
5128 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00005129 // special printing for comma expressions.
5130 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
5131 if (B->getOpcode() == BO_Comma) {
5132 OS << "... , ";
5133 Helper.handledStmt(B->getRHS(),OS);
5134 OS << '\n';
5135 return;
5136 }
5137 }
5138 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00005139
Artem Dergachev1527dec2018-03-12 23:12:40 +00005140 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
5141 if (isa<CXXOperatorCallExpr>(S))
5142 OS << " (OperatorCall)";
5143 OS << " (CXXRecordTypedCall";
5144 print_construction_context(OS, Helper, VTC->getConstructionContext());
5145 OS << ")";
5146 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005147 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005148 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005149 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005150 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005151 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005152 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005153 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00005154 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005155 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005156 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00005157 OS << " (" << CE->getStmtClassName() << ", "
5158 << CE->getCastKindName()
5159 << ", " << CE->getType().getAsString()
5160 << ")";
5161 }
Mike Stump31feda52009-07-17 01:31:16 +00005162
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005163 // Expressions need a newline.
5164 if (isa<Expr>(S))
5165 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005166 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005167 print_initializer(OS, Helper, IE->getInitializer());
5168 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005169 } else if (Optional<CFGAutomaticObjDtor> DE =
5170 E.getAs<CFGAutomaticObjDtor>()) {
5171 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005172 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005173
Artem Dergacheva25809f2018-06-04 18:56:25 +00005174 ASTContext &ACtx = VD->getASTContext();
5175 QualType T = VD->getType();
5176 if (T->isReferenceType())
5177 T = getReferenceInitTemporaryType(VD->getInit(), nullptr);
5178 if (const ArrayType *AT = ACtx.getAsArrayType(T))
5179 T = ACtx.getBaseElementType(AT);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005180
5181 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
5182 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00005183 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
5184 const VarDecl *VD = DE->getVarDecl();
5185 Helper.handleDecl(VD, OS);
5186
5187 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00005188 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
5189 const Stmt *LoopStmt = LE->getLoopStmt();
5190 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005191 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
5192 OS << "CFGScopeBegin(";
5193 if (const VarDecl *VD = SB->getVarDecl())
5194 OS << VD->getQualifiedNameAsString();
5195 OS << ")\n";
5196 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
5197 OS << "CFGScopeEnd(";
5198 if (const VarDecl *VD = SE->getVarDecl())
5199 OS << VD->getQualifiedNameAsString();
5200 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00005201 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
5202 OS << "CFGNewAllocator(";
5203 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
5204 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5205 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00005206 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
5207 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
5208 if (!RD)
5209 return;
5210 CXXDeleteExpr *DelExpr =
5211 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005212 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005213 OS << "->~" << RD->getName().str() << "()";
5214 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005215 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5216 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005217 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005218 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005219 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5220 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005221 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005222 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005223 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005224 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005225 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5226 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005227 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005228 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005229 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005230 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005231}
Mike Stump31feda52009-07-17 01:31:16 +00005232
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005233static void print_block(raw_ostream &OS, const CFG* cfg,
5234 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005235 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005236 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005237 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005238
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005239 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005240 if (ShowColors)
5241 OS.changeColor(raw_ostream::YELLOW, true);
Fangrui Song6907ce22018-07-30 19:24:48 +00005242
Ted Kremenek72be32a2011-12-22 23:33:52 +00005243 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005244
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005245 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005246 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005247 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005248 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005249 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005250 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005251 else if (B.hasNoReturnElement())
5252 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005253 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005254 OS << "]\n";
Fangrui Song6907ce22018-07-30 19:24:48 +00005255
Ted Kremenek72be32a2011-12-22 23:33:52 +00005256 if (ShowColors)
5257 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005258
Ted Kremenek71eca012007-08-29 23:20:49 +00005259 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005260 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005261 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005262 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005263
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005264 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005265 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005266 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005267 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005268 if (C->getLHS())
5269 C->getLHS()->printPretty(OS, &Helper,
5270 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005271 if (C->getRHS()) {
5272 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005273 C->getRHS()->printPretty(OS, &Helper,
5274 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005275 }
Mike Stump92244b02010-01-19 22:00:14 +00005276 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005277 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005278 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005279 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005280 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005281 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005282 0);
5283 else
5284 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005285 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005286 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5287 OS << "__except (";
5288 ES->getFilterExpr()->printPretty(OS, &Helper,
5289 PrintingPolicy(Helper.getLangOpts()), 0);
5290 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005291 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005292 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005293
Ted Kremenek71eca012007-08-29 23:20:49 +00005294 OS << ":\n";
5295 }
Mike Stump31feda52009-07-17 01:31:16 +00005296
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005297 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005298 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005299
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005300 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5301 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005302 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005303 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005304 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005305
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005306 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005307
Aaron Ballmanff924b02013-11-18 20:11:50 +00005308 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005309
Ted Kremenek72be32a2011-12-22 23:33:52 +00005310 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005311 }
Mike Stump31feda52009-07-17 01:31:16 +00005312
Ted Kremenek71eca012007-08-29 23:20:49 +00005313 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005314 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005315 if (ShowColors)
5316 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005317
Ted Kremenek72be32a2011-12-22 23:33:52 +00005318 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005319
Aaron Ballmanff924b02013-11-18 20:11:50 +00005320 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005321
Aaron Ballmanff924b02013-11-18 20:11:50 +00005322 PrintingPolicy PP(Helper.getLangOpts());
5323 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005324 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005325 OS << '\n';
Fangrui Song6907ce22018-07-30 19:24:48 +00005326
Ted Kremenek72be32a2011-12-22 23:33:52 +00005327 if (ShowColors)
5328 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005329 }
Mike Stump31feda52009-07-17 01:31:16 +00005330
Ted Kremenek71eca012007-08-29 23:20:49 +00005331 if (print_edges) {
5332 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005333 if (!B.pred_empty()) {
5334 const raw_ostream::Colors Color = raw_ostream::BLUE;
5335 if (ShowColors)
5336 OS.changeColor(Color);
5337 OS << " Preds " ;
5338 if (ShowColors)
5339 OS.resetColor();
5340 OS << '(' << B.pred_size() << "):";
5341 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005342
Ted Kremenek72be32a2011-12-22 23:33:52 +00005343 if (ShowColors)
5344 OS.changeColor(Color);
Fangrui Song6907ce22018-07-30 19:24:48 +00005345
Ted Kremenek72be32a2011-12-22 23:33:52 +00005346 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5347 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005348 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005349 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005350
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005351 CFGBlock *B = *I;
5352 bool Reachable = true;
5353 if (!B) {
5354 Reachable = false;
5355 B = I->getPossiblyUnreachableBlock();
5356 }
5357
5358 OS << " B" << B->getBlockID();
5359 if (!Reachable)
5360 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005361 }
Fangrui Song6907ce22018-07-30 19:24:48 +00005362
Ted Kremenek72be32a2011-12-22 23:33:52 +00005363 if (ShowColors)
5364 OS.resetColor();
5365
5366 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005367 }
Mike Stump31feda52009-07-17 01:31:16 +00005368
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005369 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005370 if (!B.succ_empty()) {
5371 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5372 if (ShowColors)
5373 OS.changeColor(Color);
5374 OS << " Succs ";
5375 if (ShowColors)
5376 OS.resetColor();
5377 OS << '(' << B.succ_size() << "):";
5378 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005379
Ted Kremenek72be32a2011-12-22 23:33:52 +00005380 if (ShowColors)
5381 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005382
Ted Kremenek72be32a2011-12-22 23:33:52 +00005383 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5384 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005385 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005386 OS << "\n ";
5387
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005388 CFGBlock *B = *I;
5389
5390 bool Reachable = true;
5391 if (!B) {
5392 Reachable = false;
5393 B = I->getPossiblyUnreachableBlock();
5394 }
5395
5396 if (B) {
5397 OS << " B" << B->getBlockID();
5398 if (!Reachable)
5399 OS << "(Unreachable)";
5400 }
5401 else {
5402 OS << " NULL";
5403 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005404 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005405
Ted Kremenek72be32a2011-12-22 23:33:52 +00005406 if (ShowColors)
5407 OS.resetColor();
5408 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005409 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005410 }
Mike Stump31feda52009-07-17 01:31:16 +00005411}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005412
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005413/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005414void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5415 print(llvm::errs(), LO, ShowColors);
5416}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005417
5418/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005419void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005420 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005421
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005422 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005423 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005424
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005425 // Iterate through the CFGBlocks and print them one by one.
5426 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5427 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005428 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005429 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005430
Aaron Ballmanff924b02013-11-18 20:11:50 +00005431 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005432 }
Mike Stump31feda52009-07-17 01:31:16 +00005433
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005434 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005435 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005436 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005437 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005438}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005439
5440/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005441void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5442 bool ShowColors) const {
5443 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005444}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005445
Yaron Kerencdae9412016-01-29 19:38:18 +00005446LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005447 dump(getParent(), LangOptions(), false);
5448}
5449
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005450/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5451/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005452void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005453 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005454 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005455 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005456 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005457}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005458
Ted Kremenek15647632008-01-30 23:02:42 +00005459/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005460void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005461 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005462 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005463 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005464}
5465
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005466Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00005467 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005468 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005469 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005470
Craig Topper25542942014-05-20 04:30:07 +00005471 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005472
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005473 switch (Terminator->getStmtClass()) {
5474 default:
5475 break;
Mike Stump31feda52009-07-17 01:31:16 +00005476
Jordan Rosecf10ea82013-06-06 21:53:45 +00005477 case Stmt::CXXForRangeStmtClass:
5478 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5479 break;
5480
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005481 case Stmt::ForStmtClass:
5482 E = cast<ForStmt>(Terminator)->getCond();
5483 break;
Mike Stump31feda52009-07-17 01:31:16 +00005484
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005485 case Stmt::WhileStmtClass:
5486 E = cast<WhileStmt>(Terminator)->getCond();
5487 break;
Mike Stump31feda52009-07-17 01:31:16 +00005488
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005489 case Stmt::DoStmtClass:
5490 E = cast<DoStmt>(Terminator)->getCond();
5491 break;
Mike Stump31feda52009-07-17 01:31:16 +00005492
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005493 case Stmt::IfStmtClass:
5494 E = cast<IfStmt>(Terminator)->getCond();
5495 break;
Mike Stump31feda52009-07-17 01:31:16 +00005496
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005497 case Stmt::ChooseExprClass:
5498 E = cast<ChooseExpr>(Terminator)->getCond();
5499 break;
Mike Stump31feda52009-07-17 01:31:16 +00005500
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005501 case Stmt::IndirectGotoStmtClass:
5502 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5503 break;
Mike Stump31feda52009-07-17 01:31:16 +00005504
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005505 case Stmt::SwitchStmtClass:
5506 E = cast<SwitchStmt>(Terminator)->getCond();
5507 break;
Mike Stump31feda52009-07-17 01:31:16 +00005508
John McCallc07a0c72011-02-17 10:25:35 +00005509 case Stmt::BinaryConditionalOperatorClass:
5510 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5511 break;
5512
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005513 case Stmt::ConditionalOperatorClass:
5514 E = cast<ConditionalOperator>(Terminator)->getCond();
5515 break;
Mike Stump31feda52009-07-17 01:31:16 +00005516
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005517 case Stmt::BinaryOperatorClass: // '&&' and '||'
5518 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005519 break;
Mike Stump31feda52009-07-17 01:31:16 +00005520
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005521 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005522 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005523 }
Mike Stump31feda52009-07-17 01:31:16 +00005524
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005525 if (!StripParens)
5526 return E;
5527
Craig Topper25542942014-05-20 04:30:07 +00005528 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005529}
5530
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005531//===----------------------------------------------------------------------===//
5532// CFG Graphviz Visualization
5533//===----------------------------------------------------------------------===//
5534
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005535#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005536static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005537#endif
5538
Chris Lattnerc61089a2009-06-30 01:26:17 +00005539void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005540#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005541 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005542 GraphHelper = &H;
5543 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005544 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005545#endif
5546}
5547
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005548namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005549
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005550template<>
5551struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005552 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005553
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005554 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005555#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005556 std::string OutSStr;
5557 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005558 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005559 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005560
5561 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5562
5563 // Process string output to make it nicer...
5564 for (unsigned i = 0; i != OutStr.length(); ++i)
5565 if (OutStr[i] == '\n') { // Left justify
5566 OutStr[i] = '\\';
5567 OutStr.insert(OutStr.begin()+i+1, 'l');
5568 }
Mike Stump31feda52009-07-17 01:31:16 +00005569
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005570 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005571#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005572 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005573#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005574 }
5575};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005576
5577} // namespace llvm