blob: d8081d018986d9bd196054fa37bec9242923c494 [file] [log] [blame]
Eugene Zelenko38c70522017-12-07 21:55:09 +00001//===- CFG.cpp - Classes for representing and building CFGs ---------------===//
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the CFG and CFGBuilder classes for representing and
11// building Control-Flow Graphs (CFGs) from ASTs.
12//
13//===----------------------------------------------------------------------===//
14
Ted Kremenek6796fbd2009-07-16 18:13:04 +000015#include "clang/Analysis/CFG.h"
Benjamin Kramer1ea8e092012-07-04 17:04:04 +000016#include "clang/AST/ASTContext.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000017#include "clang/AST/Attr.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000018#include "clang/AST/Decl.h"
19#include "clang/AST/DeclBase.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000020#include "clang/AST/DeclCXX.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000021#include "clang/AST/DeclGroup.h"
22#include "clang/AST/Expr.h"
23#include "clang/AST/ExprCXX.h"
24#include "clang/AST/OperationKinds.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000025#include "clang/AST/PrettyPrinter.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000026#include "clang/AST/Stmt.h"
27#include "clang/AST/StmtCXX.h"
28#include "clang/AST/StmtObjC.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000029#include "clang/AST/StmtVisitor.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000030#include "clang/AST/Type.h"
31#include "clang/Analysis/Support/BumpVector.h"
Artem Dergachev40684812018-02-27 20:03:35 +000032#include "clang/Analysis/ConstructionContext.h"
Jordan Rose5374c072013-08-19 16:27:28 +000033#include "clang/Basic/Builtins.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000034#include "clang/Basic/ExceptionSpecificationType.h"
35#include "clang/Basic/LLVM.h"
36#include "clang/Basic/LangOptions.h"
37#include "clang/Basic/SourceLocation.h"
38#include "clang/Basic/Specifiers.h"
39#include "llvm/ADT/APInt.h"
40#include "llvm/ADT/APSInt.h"
41#include "llvm/ADT/ArrayRef.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000042#include "llvm/ADT/DenseMap.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000043#include "llvm/ADT/Optional.h"
44#include "llvm/ADT/STLExtras.h"
45#include "llvm/ADT/SetVector.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000046#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000047#include "llvm/ADT/SmallVector.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000048#include "llvm/Support/Allocator.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000049#include "llvm/Support/Casting.h"
50#include "llvm/Support/Compiler.h"
51#include "llvm/Support/DOTGraphTraits.h"
52#include "llvm/Support/ErrorHandling.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000053#include "llvm/Support/Format.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000054#include "llvm/Support/GraphWriter.h"
55#include "llvm/Support/SaveAndRestore.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000056#include "llvm/Support/raw_ostream.h"
57#include <cassert>
58#include <memory>
59#include <string>
60#include <tuple>
61#include <utility>
62#include <vector>
Ted Kremeneke5ccf9a2008-01-11 00:40:29 +000063
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +000064using namespace clang;
65
Ted Kremenek5ef32db2011-08-12 23:37:29 +000066static SourceLocation GetEndLoc(Decl *D) {
67 if (VarDecl *VD = dyn_cast<VarDecl>(D))
68 if (Expr *Ex = VD->getInit())
Ted Kremenek8889bb32008-08-06 23:20:50 +000069 return Ex->getSourceRange().getEnd();
Mike Stump31feda52009-07-17 01:31:16 +000070 return D->getLocation();
Ted Kremenek8889bb32008-08-06 23:20:50 +000071}
Ted Kremenekdc03bd02010-08-02 23:46:59 +000072
George Burgess IVced56e62015-10-01 18:47:52 +000073/// Helper for tryNormalizeBinaryOperator. Attempts to extract an IntegerLiteral
74/// or EnumConstantDecl from the given Expr. If it fails, returns nullptr.
Eugene Zelenko38c70522017-12-07 21:55:09 +000075static const Expr *tryTransformToIntOrEnumConstant(const Expr *E) {
George Burgess IVced56e62015-10-01 18:47:52 +000076 E = E->IgnoreParens();
77 if (isa<IntegerLiteral>(E))
78 return E;
79 if (auto *DR = dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
80 return isa<EnumConstantDecl>(DR->getDecl()) ? DR : nullptr;
81 return nullptr;
82}
83
84/// Tries to interpret a binary operator into `Decl Op Expr` form, if Expr is
85/// an integer literal or an enum constant.
86///
87/// If this fails, at least one of the returned DeclRefExpr or Expr will be
88/// null.
89static std::tuple<const DeclRefExpr *, BinaryOperatorKind, const Expr *>
90tryNormalizeBinaryOperator(const BinaryOperator *B) {
91 BinaryOperatorKind Op = B->getOpcode();
92
93 const Expr *MaybeDecl = B->getLHS();
94 const Expr *Constant = tryTransformToIntOrEnumConstant(B->getRHS());
95 // Expr looked like `0 == Foo` instead of `Foo == 0`
96 if (Constant == nullptr) {
97 // Flip the operator
98 if (Op == BO_GT)
99 Op = BO_LT;
100 else if (Op == BO_GE)
101 Op = BO_LE;
102 else if (Op == BO_LT)
103 Op = BO_GT;
104 else if (Op == BO_LE)
105 Op = BO_GE;
106
107 MaybeDecl = B->getRHS();
108 Constant = tryTransformToIntOrEnumConstant(B->getLHS());
109 }
110
111 auto *D = dyn_cast<DeclRefExpr>(MaybeDecl->IgnoreParenImpCasts());
112 return std::make_tuple(D, Op, Constant);
113}
114
115/// For an expression `x == Foo && x == Bar`, this determines whether the
116/// `Foo` and `Bar` are either of the same enumeration type, or both integer
117/// literals.
118///
119/// It's an error to pass this arguments that are not either IntegerLiterals
120/// or DeclRefExprs (that have decls of type EnumConstantDecl)
121static bool areExprTypesCompatible(const Expr *E1, const Expr *E2) {
122 // User intent isn't clear if they're mixing int literals with enum
123 // constants.
124 if (isa<IntegerLiteral>(E1) != isa<IntegerLiteral>(E2))
125 return false;
126
127 // Integer literal comparisons, regardless of literal type, are acceptable.
128 if (isa<IntegerLiteral>(E1))
129 return true;
130
131 // IntegerLiterals are handled above and only EnumConstantDecls are expected
132 // beyond this point
133 assert(isa<DeclRefExpr>(E1) && isa<DeclRefExpr>(E2));
134 auto *Decl1 = cast<DeclRefExpr>(E1)->getDecl();
135 auto *Decl2 = cast<DeclRefExpr>(E2)->getDecl();
136
137 assert(isa<EnumConstantDecl>(Decl1) && isa<EnumConstantDecl>(Decl2));
138 const DeclContext *DC1 = Decl1->getDeclContext();
139 const DeclContext *DC2 = Decl2->getDeclContext();
140
141 assert(isa<EnumDecl>(DC1) && isa<EnumDecl>(DC2));
142 return DC1 == DC2;
143}
144
Eugene Zelenko38c70522017-12-07 21:55:09 +0000145namespace {
146
Ted Kremenek7c58d352011-03-10 01:14:11 +0000147class CFGBuilder;
Fangrui Song6907ce22018-07-30 19:24:48 +0000148
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000149/// The CFG builder uses a recursive algorithm to build the CFG. When
150/// we process an expression, sometimes we know that we must add the
151/// subexpressions as block-level expressions. For example:
152///
153/// exp1 || exp2
154///
155/// When processing the '||' expression, we know that exp1 and exp2
156/// need to be added as block-level expressions, even though they
157/// might not normally need to be. AddStmtChoice records this
158/// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then
159/// the builder has an option not to add a subexpression as a
160/// block-level expression.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000161class AddStmtChoice {
162public:
Ted Kremenek8219b822010-12-16 07:46:53 +0000163 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 };
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000164
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000165 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000166
Ted Kremenek7c58d352011-03-10 01:14:11 +0000167 bool alwaysAdd(CFGBuilder &builder,
168 const Stmt *stmt) const;
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000169
170 /// Return a copy of this object, except with the 'always-add' bit
171 /// set as specified.
172 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const {
Ted Kremenek7c58d352011-03-10 01:14:11 +0000173 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000174 }
175
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000176private:
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000177 Kind kind;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000178};
Mike Stump31feda52009-07-17 01:31:16 +0000179
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000180/// LocalScope - Node in tree of local scopes created for C++ implicit
181/// destructor calls generation. It contains list of automatic variables
182/// declared in the scope and link to position in previous scope this scope
183/// began in.
184///
185/// The process of creating local scopes is as follows:
186/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
187/// - Before processing statements in scope (e.g. CompoundStmt) create
188/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
189/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000190/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000191/// at this VarDecl,
192/// - For every normal (without jump) end of scope add to CFGBlock destructors
193/// for objects in the current scope,
194/// - For every jump add to CFGBlock destructors for objects
195/// between CFGBuilder::ScopePos and local scope position saved for jump
196/// target. Thanks to C++ restrictions on goto jumps we can be sure that
197/// jump target position will be on the path to root from CFGBuilder::ScopePos
198/// (adding any variable that doesn't need constructor to be called to
199/// LocalScope can break this assumption),
200///
201class LocalScope {
202public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000203 friend class const_iterator;
204
205 using AutomaticVarsTy = BumpVector<VarDecl *>;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000206
207 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000208 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000209 class const_iterator {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000210 const LocalScope* Scope = nullptr;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000211
212 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
213 /// Invalid iterator (with null Scope) has VarIter equal to 0.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000214 unsigned VarIter = 0;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000215
216 public:
217 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
218 /// Incrementing invalid iterator is allowed and will result in invalid
219 /// iterator.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000220 const_iterator() = default;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000221
222 /// Create valid iterator. In case when S.Prev is an invalid iterator and
223 /// I is equal to 0, this will create invalid iterator.
224 const_iterator(const LocalScope& S, unsigned I)
225 : Scope(&S), VarIter(I) {
226 // Iterator to "end" of scope is not allowed. Handle it by going up
227 // in scopes tree possibly up to invalid iterator in the root.
228 if (VarIter == 0 && Scope)
229 *this = Scope->Prev;
230 }
231
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000232 VarDecl *const* operator->() const {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000233 assert(Scope && "Dereferencing invalid iterator is not allowed");
234 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000235 return &Scope->Vars[VarIter - 1];
236 }
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000237
238 const VarDecl *getFirstVarInScope() const {
239 assert(Scope && "Dereferencing invalid iterator is not allowed");
240 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
241 return Scope->Vars[0];
242 }
243
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000244 VarDecl *operator*() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000245 return *this->operator->();
246 }
247
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000248 const_iterator &operator++() {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000249 if (!Scope)
250 return *this;
251
Eugene Zelenko38c70522017-12-07 21:55:09 +0000252 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000253 --VarIter;
254 if (VarIter == 0)
255 *this = Scope->Prev;
256 return *this;
257 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000258 const_iterator operator++(int) {
259 const_iterator P = *this;
260 ++*this;
261 return P;
262 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000263
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000264 bool operator==(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000265 return Scope == rhs.Scope && VarIter == rhs.VarIter;
266 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000267 bool operator!=(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000268 return !(*this == rhs);
269 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000270
Aaron Ballman67347662015-02-15 22:00:28 +0000271 explicit operator bool() const {
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000272 return *this != const_iterator();
273 }
274
275 int distance(const_iterator L);
Matthias Gehre351c2182017-07-12 07:04:19 +0000276 const_iterator shared_parent(const_iterator L);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000277 bool pointsToFirstDeclaredVar() { return VarIter == 1; }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000278 };
279
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000280private:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000281 BumpVectorContext ctx;
Fangrui Song6907ce22018-07-30 19:24:48 +0000282
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000283 /// Automatic variables in order of declaration.
284 AutomaticVarsTy Vars;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000285
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000286 /// Iterator to variable in previous scope that was declared just before
287 /// begin of this scope.
288 const_iterator Prev;
289
290public:
291 /// Constructs empty scope linked to previous scope in specified place.
David Blaikiec1334cc2015-08-13 22:12:21 +0000292 LocalScope(BumpVectorContext ctx, const_iterator P)
293 : ctx(std::move(ctx)), Vars(this->ctx, 4), Prev(P) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000294
295 /// Begin of scope in direction of CFG building (backwards).
296 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000297
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000298 void addVar(VarDecl *VD) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000299 Vars.push_back(VD, ctx);
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000300 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000301};
302
Eugene Zelenko38c70522017-12-07 21:55:09 +0000303} // namespace
304
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000305/// distance - Calculates distance from this to L. L must be reachable from this
306/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
307/// number of scopes between this and L.
308int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
309 int D = 0;
310 const_iterator F = *this;
311 while (F.Scope != L.Scope) {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000312 assert(F != const_iterator() &&
313 "L iterator is not reachable from F iterator.");
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000314 D += F.VarIter;
315 F = F.Scope->Prev;
316 }
317 D += F.VarIter - L.VarIter;
318 return D;
319}
320
Matthias Gehre351c2182017-07-12 07:04:19 +0000321/// Calculates the closest parent of this iterator
322/// that is in a scope reachable through the parents of L.
323/// I.e. when using 'goto' from this to L, the lifetime of all variables
324/// between this and shared_parent(L) end.
325LocalScope::const_iterator
326LocalScope::const_iterator::shared_parent(LocalScope::const_iterator L) {
327 llvm::SmallPtrSet<const LocalScope *, 4> ScopesOfL;
328 while (true) {
329 ScopesOfL.insert(L.Scope);
330 if (L == const_iterator())
331 break;
332 L = L.Scope->Prev;
333 }
334
335 const_iterator F = *this;
336 while (true) {
337 if (ScopesOfL.count(F.Scope))
338 return F;
339 assert(F != const_iterator() &&
340 "L iterator is not reachable from F iterator.");
341 F = F.Scope->Prev;
342 }
343}
344
Eugene Zelenko38c70522017-12-07 21:55:09 +0000345namespace {
346
Jonathan Roelofs99bdd982015-05-19 18:51:56 +0000347/// Structure for specifying position in CFG during its build process. It
348/// consists of CFGBlock that specifies position in CFG and
349/// LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000350struct BlockScopePosPair {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000351 CFGBlock *block = nullptr;
352 LocalScope::const_iterator scopePosition;
353
354 BlockScopePosPair() = default;
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000355 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos)
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000356 : block(b), scopePosition(scopePos) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000357};
358
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000359/// TryResult - a class representing a variant over the values
360/// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool,
361/// and is used by the CFGBuilder to decide if a branch condition
362/// can be decided up front during CFG construction.
363class TryResult {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000364 int X = -1;
365
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000366public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000367 TryResult() = default;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000368 TryResult(bool b) : X(b ? 1 : 0) {}
Fangrui Song6907ce22018-07-30 19:24:48 +0000369
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000370 bool isTrue() const { return X == 1; }
371 bool isFalse() const { return X == 0; }
372 bool isKnown() const { return X >= 0; }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000373
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000374 void negate() {
375 assert(isKnown());
376 X ^= 0x1;
377 }
378};
379
Eugene Zelenko38c70522017-12-07 21:55:09 +0000380} // namespace
381
382static TryResult bothKnownTrue(TryResult R1, TryResult R2) {
Manuel Klimekdeb02622014-08-08 07:37:13 +0000383 if (!R1.isKnown() || !R2.isKnown())
384 return TryResult();
385 return TryResult(R1.isTrue() && R2.isTrue());
386}
387
Eugene Zelenko38c70522017-12-07 21:55:09 +0000388namespace {
389
Ted Kremenek8ae67872013-02-05 22:00:19 +0000390class reverse_children {
391 llvm::SmallVector<Stmt *, 12> childrenBuf;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000392 ArrayRef<Stmt *> children;
393
Ted Kremenek8ae67872013-02-05 22:00:19 +0000394public:
395 reverse_children(Stmt *S);
396
Eugene Zelenko38c70522017-12-07 21:55:09 +0000397 using iterator = ArrayRef<Stmt *>::reverse_iterator;
398
Ted Kremenek8ae67872013-02-05 22:00:19 +0000399 iterator begin() const { return children.rbegin(); }
400 iterator end() const { return children.rend(); }
401};
402
Eugene Zelenko38c70522017-12-07 21:55:09 +0000403} // namespace
Ted Kremenek8ae67872013-02-05 22:00:19 +0000404
405reverse_children::reverse_children(Stmt *S) {
406 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
407 children = CE->getRawSubExprs();
408 return;
409 }
410 switch (S->getStmtClass()) {
Ted Kremenek7d86b9c2013-02-05 22:03:14 +0000411 // Note: Fill in this switch with more cases we want to optimize.
Ted Kremenek8ae67872013-02-05 22:00:19 +0000412 case Stmt::InitListExprClass: {
413 InitListExpr *IE = cast<InitListExpr>(S);
414 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()),
415 IE->getNumInits());
416 return;
417 }
418 default:
419 break;
420 }
421
422 // Default case for all other statements.
Benjamin Kramer642f1732015-07-02 21:03:14 +0000423 for (Stmt *SubStmt : S->children())
424 childrenBuf.push_back(SubStmt);
Ted Kremenek8ae67872013-02-05 22:00:19 +0000425
426 // This needs to be done *after* childrenBuf has been populated.
427 children = childrenBuf;
428}
429
Eugene Zelenko38c70522017-12-07 21:55:09 +0000430namespace {
431
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000432/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000433/// The builder is stateful: an instance of the builder should be used to only
434/// construct a single CFG.
435///
436/// Example usage:
437///
438/// CFGBuilder builder;
Jonathan Roelofsab046c52015-07-27 16:05:36 +0000439/// std::unique_ptr<CFG> cfg = builder.buildCFG(decl, stmt1);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000440///
Mike Stump31feda52009-07-17 01:31:16 +0000441/// CFG construction is done via a recursive walk of an AST. We actually parse
442/// the AST in reverse order so that the successor of a basic block is
443/// constructed prior to its predecessor. This allows us to nicely capture
444/// implicit fall-throughs without extra basic blocks.
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000445class CFGBuilder {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000446 using JumpTarget = BlockScopePosPair;
447 using JumpSource = BlockScopePosPair;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000448
Mike Stump0d76d072009-07-20 23:24:15 +0000449 ASTContext *Context;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000450 std::unique_ptr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000451
Eugene Zelenko38c70522017-12-07 21:55:09 +0000452 // Current block.
453 CFGBlock *Block = nullptr;
454
455 // Block after the current block.
456 CFGBlock *Succ = nullptr;
457
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000458 JumpTarget ContinueJumpTarget;
459 JumpTarget BreakJumpTarget;
Nico Weber699670e2017-08-23 15:33:16 +0000460 JumpTarget SEHLeaveJumpTarget;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000461 CFGBlock *SwitchTerminatedBlock = nullptr;
462 CFGBlock *DefaultCaseBlock = nullptr;
Nico Weber699670e2017-08-23 15:33:16 +0000463
464 // This can point either to a try or a __try block. The frontend forbids
465 // mixing both kinds in one function, so having one for both is enough.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000466 CFGBlock *TryTerminatedBlock = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000467
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000468 // Current position in local scope.
469 LocalScope::const_iterator ScopePos;
470
471 // LabelMap records the mapping from Label expressions to their jump targets.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000472 using LabelMapTy = llvm::DenseMap<LabelDecl *, JumpTarget>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000473 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000474
475 // A list of blocks that end with a "goto" that must be backpatched to their
476 // resolved targets upon completion of CFG construction.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000477 using BackpatchBlocksTy = std::vector<JumpSource>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000478 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000479
Ted Kremenekeda180e22007-08-28 19:26:49 +0000480 // A list of labels whose address has been taken (for indirect gotos).
Eugene Zelenko38c70522017-12-07 21:55:09 +0000481 using LabelSetTy = llvm::SmallSetVector<LabelDecl *, 8>;
Ted Kremenekeda180e22007-08-28 19:26:49 +0000482 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000483
Artem Dergachev41ffb302018-02-08 22:58:15 +0000484 // Information about the currently visited C++ object construction site.
485 // This is set in the construction trigger and read when the constructor
Artem Dergachev1527dec2018-03-12 23:12:40 +0000486 // or a function that returns an object by value is being visited.
487 llvm::DenseMap<Expr *, const ConstructionContextLayer *>
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000488 ConstructionContextMap;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000489
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000490 using DeclsWithEndedScopeSetTy = llvm::SmallSetVector<VarDecl *, 16>;
491 DeclsWithEndedScopeSetTy DeclsWithEndedScope;
492
Eugene Zelenko38c70522017-12-07 21:55:09 +0000493 bool badCFG = false;
Ted Kremenekf9d82902011-03-10 01:14:05 +0000494 const CFG::BuildOptions &BuildOpts;
Fangrui Song6907ce22018-07-30 19:24:48 +0000495
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000496 // State to track for building switch statements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000497 bool switchExclusivelyCovered = false;
498 Expr::EvalResult *switchCond = nullptr;
Fangrui Song6907ce22018-07-30 19:24:48 +0000499
Eugene Zelenko38c70522017-12-07 21:55:09 +0000500 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry = nullptr;
501 const Stmt *lastLookup = nullptr;
Zhongxing Xud38fb842010-09-16 03:28:18 +0000502
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000503 // Caches boolean evaluations of expressions to avoid multiple re-evaluations
504 // during construction of branches for chained logical operators.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000505 using CachedBoolEvalsTy = llvm::DenseMap<Expr *, TryResult>;
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000506 CachedBoolEvalsTy CachedBoolEvals;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000507
Mike Stump31feda52009-07-17 01:31:16 +0000508public:
Ted Kremenekf9d82902011-03-10 01:14:05 +0000509 explicit CFGBuilder(ASTContext *astContext,
Nico Weber699670e2017-08-23 15:33:16 +0000510 const CFG::BuildOptions &buildOpts)
511 : Context(astContext), cfg(new CFG()), // crew a new CFG
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000512 ConstructionContextMap(), BuildOpts(buildOpts) {}
513
Mike Stump31feda52009-07-17 01:31:16 +0000514
Ted Kremenek9aae5132007-08-23 21:42:29 +0000515 // buildCFG - Used by external clients to construct the CFG.
David Blaikiee90195c2014-08-29 18:53:26 +0000516 std::unique_ptr<CFG> buildCFG(const Decl *D, Stmt *Statement);
Mike Stump31feda52009-07-17 01:31:16 +0000517
Ted Kremeneka099c592011-03-10 03:50:34 +0000518 bool alwaysAdd(const Stmt *stmt);
Fangrui Song6907ce22018-07-30 19:24:48 +0000519
Ted Kremenek93668002009-07-17 22:18:43 +0000520private:
521 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000522 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
523 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000524 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000525 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000526 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000527 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000528 CFGBlock *VisitCompoundStmt(CompoundStmt *C);
John McCallc07a0c72011-02-17 10:25:35 +0000529 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C,
530 AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000531 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek6f400242012-07-14 05:04:01 +0000532 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
533 AddStmtChoice asc);
534 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
535 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc);
Jordan Rosec9176072014-01-13 17:59:19 +0000536 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc);
Jordan Rosed2f40792013-09-03 17:00:57 +0000537 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000538 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S);
539 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
540 AddStmtChoice asc);
541 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
542 AddStmtChoice asc);
543 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
544 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000545 CFGBlock *VisitDeclStmt(DeclStmt *DS);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000546 CFGBlock *VisitDeclSubExpr(DeclStmt *DS);
Ted Kremenek21822592009-07-17 18:20:32 +0000547 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
548 CFGBlock *VisitDoStmt(DoStmt *D);
Ted Kremenek6f400242012-07-14 05:04:01 +0000549 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000550 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000551 CFGBlock *VisitGotoStmt(GotoStmt *G);
Ted Kremenek93668002009-07-17 22:18:43 +0000552 CFGBlock *VisitIfStmt(IfStmt *I);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +0000553 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *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);
Ted Kremenek6f400242012-07-14 05:04:01 +0000574 CFGBlock *VisitReturnStmt(ReturnStmt *R);
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 Dergacheva657a322018-07-31 20:45:53 +0000700 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E, i),
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000701 Arg);
Artem Dergacheva657a322018-07-31 20:45:53 +0000702 }
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000703 }
704
Artem Dergachev41ffb302018-02-08 22:58:15 +0000705 // Unset the construction context after consuming it. This is done immediately
Artem Dergachev1527dec2018-03-12 23:12:40 +0000706 // after adding the CFGConstructor or CFGCXXRecordTypedCall element, so
707 // there's no need to do this manually in every Visit... function.
708 void cleanupConstructionContext(Expr *E);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000709
Ted Kremenek93668002009-07-17 22:18:43 +0000710 void autoCreateBlock() { if (!Block) Block = createBlock(); }
711 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000712 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000713
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000714 CFGBlock *addStmt(Stmt *S) {
715 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000716 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000717
Alexis Hunt1d792652011-01-08 20:30:50 +0000718 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000719 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000720 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000721 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000722 void addLifetimeEnds(LocalScope::const_iterator B,
723 LocalScope::const_iterator E, Stmt *S);
724 void addAutomaticObjHandling(LocalScope::const_iterator B,
725 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000726 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000727 void addScopesEnd(LocalScope::const_iterator B, LocalScope::const_iterator E,
728 Stmt *S);
729
730 void getDeclsWithEndedScope(LocalScope::const_iterator B,
731 LocalScope::const_iterator E, Stmt *S);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000732
Marcin Swiderski5e415732010-09-30 23:05:00 +0000733 // Local scopes creation.
734 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
735
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000736 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000737 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
738 LocalScope* Scope = nullptr);
739 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000740
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000741 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000742
Artem Dergacheve1f30622018-07-31 19:46:14 +0000743 const ConstructionContext *retrieveAndCleanupConstructionContext(Expr *E) {
744 if (!BuildOpts.AddRichCXXConstructors)
745 return nullptr;
746
747 const ConstructionContextLayer *Layer = ConstructionContextMap.lookup(E);
748 if (!Layer)
749 return nullptr;
750
751 cleanupConstructionContext(E);
752 return ConstructionContext::createFromLayers(cfg->getBumpVectorContext(),
753 Layer);
754 }
755
Marcin Swiderski5e415732010-09-30 23:05:00 +0000756 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000757
Ted Kremenek37881932011-04-04 23:29:12 +0000758 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000759 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000760 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000761
Jordy Rose17347372011-06-10 08:49:37 +0000762 // All block-level expressions should have already been IgnoreParens()ed.
763 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000764 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000765 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000766
Artem Dergachev41ffb302018-02-08 22:58:15 +0000767 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
Artem Dergacheve1f30622018-07-31 19:46:14 +0000768 if (const ConstructionContext *CC =
769 retrieveAndCleanupConstructionContext(CE)) {
770 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
771 return;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000772 }
773
774 // No valid construction context found. Fall back to statement.
775 B->appendStmt(CE, cfg->getBumpVectorContext());
776 }
777
Artem Dergachev1527dec2018-03-12 23:12:40 +0000778 void appendCall(CFGBlock *B, CallExpr *CE) {
Richard Trieuf4a0e9a2018-03-15 00:09:26 +0000779 if (alwaysAdd(CE) && cachedEntry)
780 cachedEntry->second = B;
781
Artem Dergacheve1f30622018-07-31 19:46:14 +0000782 if (const ConstructionContext *CC =
783 retrieveAndCleanupConstructionContext(CE)) {
784 B->appendCXXRecordTypedCall(CE, CC, cfg->getBumpVectorContext());
785 return;
Artem Dergachev1527dec2018-03-12 23:12:40 +0000786 }
787
788 // No valid construction context found. Fall back to statement.
789 B->appendStmt(CE, cfg->getBumpVectorContext());
790 }
791
Alexis Hunt1d792652011-01-08 20:30:50 +0000792 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000793 B->appendInitializer(I, cfg->getBumpVectorContext());
794 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000795
Jordan Rosec9176072014-01-13 17:59:19 +0000796 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
797 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
798 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000799
Marcin Swiderski20b88732010-10-05 05:37:00 +0000800 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
801 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
802 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000803
Marcin Swiderski20b88732010-10-05 05:37:00 +0000804 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
805 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
806 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000807
Artem Dergacheve1f30622018-07-31 19:46:14 +0000808 void appendObjCMessage(CFGBlock *B, ObjCMessageExpr *ME) {
809 if (alwaysAdd(ME) && cachedEntry)
810 cachedEntry->second = B;
811
812 if (const ConstructionContext *CC =
813 retrieveAndCleanupConstructionContext(ME)) {
814 B->appendCXXRecordTypedCall(ME, CC, cfg->getBumpVectorContext());
815 return;
816 }
817
818 B->appendStmt(const_cast<ObjCMessageExpr *>(ME),
819 cfg->getBumpVectorContext());
820 }
821
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000822 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
823 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
824 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000825
Chandler Carruthad747252011-09-13 06:09:01 +0000826 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
827 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
828 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000829
Matthias Gehre351c2182017-07-12 07:04:19 +0000830 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
831 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
832 }
833
Peter Szecsi999a25f2017-08-19 11:19:16 +0000834 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
835 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
836 }
837
Jordan Rosed2f40792013-09-03 17:00:57 +0000838 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
839 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
840 }
841
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000842 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000843 LocalScope::const_iterator B, LocalScope::const_iterator E);
844
Matthias Gehre351c2182017-07-12 07:04:19 +0000845 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
846 LocalScope::const_iterator B,
847 LocalScope::const_iterator E);
848
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000849 const VarDecl *
850 prependAutomaticObjScopeEndWithTerminator(CFGBlock *Blk,
851 LocalScope::const_iterator B,
852 LocalScope::const_iterator E);
853
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000854 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
855 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
856 cfg->getBumpVectorContext());
857 }
858
859 /// Add a reachable successor to a block, with the alternate variant that is
860 /// unreachable.
861 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
862 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
863 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000864 }
Mike Stump11289f42009-09-09 15:08:12 +0000865
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000866 void appendScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
867 if (BuildOpts.AddScopes)
868 B->appendScopeBegin(VD, S, cfg->getBumpVectorContext());
869 }
870
871 void prependScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
872 if (BuildOpts.AddScopes)
873 B->prependScopeBegin(VD, S, cfg->getBumpVectorContext());
874 }
875
876 void appendScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
877 if (BuildOpts.AddScopes)
878 B->appendScopeEnd(VD, S, cfg->getBumpVectorContext());
879 }
880
881 void prependScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
882 if (BuildOpts.AddScopes)
883 B->prependScopeEnd(VD, S, cfg->getBumpVectorContext());
884 }
885
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000886 /// Find a relational comparison with an expression evaluating to a
Richard Trieuf935b562014-04-05 05:17:01 +0000887 /// boolean and a constant other than 0 and 1.
888 /// e.g. if ((x < y) == 10)
889 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
890 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
891 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
892
893 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
894 const Expr *BoolExpr = RHSExpr;
895 bool IntFirst = true;
896 if (!IntLiteral) {
897 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
898 BoolExpr = LHSExpr;
899 IntFirst = false;
900 }
901
902 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
903 return TryResult();
904
905 llvm::APInt IntValue = IntLiteral->getValue();
906 if ((IntValue == 1) || (IntValue == 0))
907 return TryResult();
908
909 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
910 !IntValue.isNegative();
911
912 BinaryOperatorKind Bok = B->getOpcode();
913 if (Bok == BO_GT || Bok == BO_GE) {
914 // Always true for 10 > bool and bool > -1
915 // Always false for -1 > bool and bool > 10
916 return TryResult(IntFirst == IntLarger);
917 } else {
918 // Always true for -1 < bool and bool < 10
919 // Always false for 10 < bool and bool < -1
920 return TryResult(IntFirst != IntLarger);
921 }
922 }
923
Jordan Rose7afd71e2014-05-20 17:31:11 +0000924 /// Find an incorrect equality comparison. Either with an expression
925 /// evaluating to a boolean and a constant other than 0 and 1.
926 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
927 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000928 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
929 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
930 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
931
932 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
933 const Expr *BoolExpr = RHSExpr;
934
935 if (!IntLiteral) {
936 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
937 BoolExpr = LHSExpr;
938 }
939
Jordan Rose7afd71e2014-05-20 17:31:11 +0000940 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000941 return TryResult();
942
Jordan Rose7afd71e2014-05-20 17:31:11 +0000943 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
944 if (BitOp && (BitOp->getOpcode() == BO_And ||
945 BitOp->getOpcode() == BO_Or)) {
946 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
947 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
948
949 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
950
951 if (!IntLiteral2)
952 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
953
954 if (!IntLiteral2)
955 return TryResult();
956
957 llvm::APInt L1 = IntLiteral->getValue();
958 llvm::APInt L2 = IntLiteral2->getValue();
959 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
960 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
961 if (BuildOpts.Observer)
962 BuildOpts.Observer->compareBitwiseEquality(B,
963 B->getOpcode() != BO_EQ);
964 TryResult(B->getOpcode() != BO_EQ);
965 }
966 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
967 llvm::APInt IntValue = IntLiteral->getValue();
968 if ((IntValue == 1) || (IntValue == 0)) {
969 return TryResult();
970 }
971 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000972 }
973
Jordan Rose7afd71e2014-05-20 17:31:11 +0000974 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000975 }
976
977 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
978 const llvm::APSInt &Value1,
979 const llvm::APSInt &Value2) {
980 assert(Value1.isSigned() == Value2.isSigned());
981 switch (Relation) {
982 default:
983 return TryResult();
984 case BO_EQ:
985 return TryResult(Value1 == Value2);
986 case BO_NE:
987 return TryResult(Value1 != Value2);
988 case BO_LT:
989 return TryResult(Value1 < Value2);
990 case BO_LE:
991 return TryResult(Value1 <= Value2);
992 case BO_GT:
993 return TryResult(Value1 > Value2);
994 case BO_GE:
995 return TryResult(Value1 >= Value2);
996 }
997 }
998
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000999 /// Find a pair of comparison expressions with or without parentheses
Richard Trieuf935b562014-04-05 05:17:01 +00001000 /// with a shared variable and constants and a logical operator between them
1001 /// that always evaluates to either true or false.
1002 /// e.g. if (x != 3 || x != 4)
1003 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
1004 assert(B->isLogicalOp());
1005 const BinaryOperator *LHS =
1006 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
1007 const BinaryOperator *RHS =
1008 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
1009 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001010 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001011
1012 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001013 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001014
George Burgess IVced56e62015-10-01 18:47:52 +00001015 const DeclRefExpr *Decl1;
1016 const Expr *Expr1;
1017 BinaryOperatorKind BO1;
1018 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001019
George Burgess IVced56e62015-10-01 18:47:52 +00001020 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001021 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001022
George Burgess IVced56e62015-10-01 18:47:52 +00001023 const DeclRefExpr *Decl2;
1024 const Expr *Expr2;
1025 BinaryOperatorKind BO2;
1026 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001027
George Burgess IVced56e62015-10-01 18:47:52 +00001028 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001029 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001030
1031 // Check that it is the same variable on both sides.
1032 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001033 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001034
George Burgess IVced56e62015-10-01 18:47:52 +00001035 // Make sure the user's intent is clear (e.g. they're comparing against two
1036 // int literals, or two things from the same enum)
1037 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001038 return {};
George Burgess IVced56e62015-10-01 18:47:52 +00001039
Richard Trieuf935b562014-04-05 05:17:01 +00001040 llvm::APSInt L1, L2;
1041
George Burgess IVced56e62015-10-01 18:47:52 +00001042 if (!Expr1->EvaluateAsInt(L1, *Context) ||
1043 !Expr2->EvaluateAsInt(L2, *Context))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001044 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001045
1046 // Can't compare signed with unsigned or with different bit width.
1047 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001048 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001049
1050 // Values that will be used to determine if result of logical
1051 // operator is always true/false
1052 const llvm::APSInt Values[] = {
1053 // Value less than both Value1 and Value2
1054 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
1055 // L1
1056 L1,
1057 // Value between Value1 and Value2
1058 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
1059 L1.isUnsigned()),
1060 // L2
1061 L2,
1062 // Value greater than both Value1 and Value2
1063 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
1064 };
1065
1066 // Check whether expression is always true/false by evaluating the following
1067 // * variable x is less than the smallest literal.
1068 // * variable x is equal to the smallest literal.
1069 // * Variable x is between smallest and largest literal.
1070 // * Variable x is equal to the largest literal.
1071 // * Variable x is greater than largest literal.
1072 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001073 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +00001074 TryResult Res1, Res2;
1075 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
1076 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
1077
1078 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001079 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001080
1081 if (B->getOpcode() == BO_LAnd) {
1082 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
1083 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
1084 } else {
1085 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
1086 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
1087 }
1088 }
1089
1090 if (AlwaysTrue || AlwaysFalse) {
1091 if (BuildOpts.Observer)
1092 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
1093 return TryResult(AlwaysTrue);
1094 }
Eugene Zelenko38c70522017-12-07 21:55:09 +00001095 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001096 }
1097
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001098 /// Try and evaluate an expression to an integer constant.
1099 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
1100 if (!BuildOpts.PruneTriviallyFalseEdges)
1101 return false;
Fangrui Song6907ce22018-07-30 19:24:48 +00001102 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001103 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001104 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001105 }
Mike Stump11289f42009-09-09 15:08:12 +00001106
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001107 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001108 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001109 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001110 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001111 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001112 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001113
1114 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1115 if (Bop->isLogicalOp()) {
1116 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001117 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1118 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001119 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001120
1121 // Retrieve result at first, or the map might be updated.
1122 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1123 CachedBoolEvals[S] = Result; // update or insert
1124 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001125 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001126 else {
1127 switch (Bop->getOpcode()) {
1128 default: break;
1129 // For 'x & 0' and 'x * 0', we can determine that
1130 // the value is always false.
1131 case BO_Mul:
1132 case BO_And: {
1133 // If either operand is zero, we know the value
1134 // must be false.
1135 llvm::APSInt IntVal;
1136 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001137 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001138 return TryResult(false);
1139 }
1140 }
1141 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001142 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001143 return TryResult(false);
1144 }
1145 }
1146 }
1147 break;
1148 }
1149 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001150 }
1151
1152 return evaluateAsBooleanConditionNoCache(S);
1153 }
1154
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001155 /// Evaluate as boolean \param E without using the cache.
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001156 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1157 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1158 if (Bop->isLogicalOp()) {
1159 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1160 if (LHS.isKnown()) {
1161 // We were able to evaluate the LHS, see if we can get away with not
1162 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1163 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1164 return LHS.isTrue();
1165
1166 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1167 if (RHS.isKnown()) {
1168 if (Bop->getOpcode() == BO_LOr)
1169 return LHS.isTrue() || RHS.isTrue();
1170 else
1171 return LHS.isTrue() && RHS.isTrue();
1172 }
1173 } else {
1174 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1175 if (RHS.isKnown()) {
1176 // We can't evaluate the LHS; however, sometimes the result
1177 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1178 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1179 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001180 } else {
1181 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1182 if (BopRes.isKnown())
1183 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001184 }
1185 }
1186
Eugene Zelenko38c70522017-12-07 21:55:09 +00001187 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001188 } else if (Bop->isEqualityOp()) {
1189 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1190 if (BopRes.isKnown())
1191 return BopRes.isTrue();
1192 } else if (Bop->isRelationalOp()) {
1193 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1194 if (BopRes.isKnown())
1195 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001196 }
1197 }
1198
1199 bool Result;
1200 if (E->EvaluateAsBooleanCondition(Result, *Context))
1201 return Result;
1202
Eugene Zelenko38c70522017-12-07 21:55:09 +00001203 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001204 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001205
1206 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001207};
Mike Stump31feda52009-07-17 01:31:16 +00001208
Eugene Zelenko38c70522017-12-07 21:55:09 +00001209} // namespace
1210
Ted Kremeneka099c592011-03-10 03:50:34 +00001211inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1212 const Stmt *stmt) const {
1213 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1214}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001215
Ted Kremeneka099c592011-03-10 03:50:34 +00001216bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001217 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
Fangrui Song6907ce22018-07-30 19:24:48 +00001218
Ted Kremeneka099c592011-03-10 03:50:34 +00001219 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001220 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001221
Fangrui Song6907ce22018-07-30 19:24:48 +00001222 if (lastLookup == stmt) {
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001223 if (cachedEntry) {
1224 assert(cachedEntry->first == stmt);
1225 return true;
1226 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001227 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001228 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001229
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001230 lastLookup = stmt;
1231
1232 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001233 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1234
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001235 if (!fb) {
1236 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001237 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001238 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001239 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001240
1241 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001242 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001243 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001244 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001245 }
1246
Ted Kremeneka099c592011-03-10 03:50:34 +00001247 cachedEntry = &*itr;
1248 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001249}
Fangrui Song6907ce22018-07-30 19:24:48 +00001250
Douglas Gregor4619e432008-12-05 23:32:09 +00001251// FIXME: Add support for dependent-sized array types in C++?
1252// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001253static const VariableArrayType *FindVA(const Type *t) {
1254 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1255 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001256 if (vat->getSizeExpr())
1257 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001258
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001259 t = vt->getElementType().getTypePtr();
1260 }
Mike Stump31feda52009-07-17 01:31:16 +00001261
Craig Topper25542942014-05-20 04:30:07 +00001262 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001263}
Mike Stump31feda52009-07-17 01:31:16 +00001264
Artem Dergachev40684812018-02-27 20:03:35 +00001265void CFGBuilder::consumeConstructionContext(
Artem Dergachev1527dec2018-03-12 23:12:40 +00001266 const ConstructionContextLayer *Layer, Expr *E) {
Artem Dergacheve1f30622018-07-31 19:46:14 +00001267 assert((isa<CXXConstructExpr>(E) || isa<CallExpr>(E) ||
1268 isa<ObjCMessageExpr>(E)) && "Expression cannot construct an object!");
Artem Dergachev40684812018-02-27 20:03:35 +00001269 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachev1527dec2018-03-12 23:12:40 +00001270 ConstructionContextMap.lookup(E)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001271 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001272 // We might have visited this child when we were finding construction
1273 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001274 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001275 "Already within a different construction context!");
1276 } else {
Artem Dergachev1527dec2018-03-12 23:12:40 +00001277 ConstructionContextMap[E] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001278 }
1279}
1280
Artem Dergachev783a4572018-02-23 22:20:39 +00001281void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001282 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001283 if (!BuildOpts.AddRichCXXConstructors)
1284 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001285
Artem Dergachev41ffb302018-02-08 22:58:15 +00001286 if (!Child)
1287 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001288
Artem Dergacheva657a322018-07-31 20:45:53 +00001289 auto withExtraLayer = [this, Layer](Stmt *S, unsigned Index = 0) {
Artem Dergachevff267df2018-06-28 00:04:54 +00001290 return ConstructionContextLayer::create(cfg->getBumpVectorContext(), S,
Artem Dergacheva657a322018-07-31 20:45:53 +00001291 Index, Layer);
Artem Dergachevff267df2018-06-28 00:04:54 +00001292 };
1293
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001294 switch(Child->getStmtClass()) {
1295 case Stmt::CXXConstructExprClass:
1296 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachevff267df2018-06-28 00:04:54 +00001297 // Support pre-C++17 copy elision AST.
1298 auto *CE = cast<CXXConstructExpr>(Child);
1299 if (BuildOpts.MarkElidedCXXConstructors && CE->isElidable()) {
Artem Dergachevff267df2018-06-28 00:04:54 +00001300 findConstructionContexts(withExtraLayer(CE), CE->getArg(0));
1301 }
1302
1303 consumeConstructionContext(Layer, CE);
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001304 break;
1305 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00001306 // FIXME: This, like the main visit, doesn't support CUDAKernelCallExpr.
1307 // FIXME: An isa<> would look much better but this whole switch is a
1308 // workaround for an internal compiler error in MSVC 2015 (see r326021).
1309 case Stmt::CallExprClass:
1310 case Stmt::CXXMemberCallExprClass:
1311 case Stmt::CXXOperatorCallExprClass:
Artem Dergacheve1f30622018-07-31 19:46:14 +00001312 case Stmt::UserDefinedLiteralClass:
1313 case Stmt::ObjCMessageExprClass: {
1314 auto *E = cast<Expr>(Child);
1315 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(E))
1316 consumeConstructionContext(Layer, E);
Artem Dergachev1527dec2018-03-12 23:12:40 +00001317 break;
1318 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001319 case Stmt::ExprWithCleanupsClass: {
1320 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001321 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001322 break;
1323 }
1324 case Stmt::CXXFunctionalCastExprClass: {
1325 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001326 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001327 break;
1328 }
1329 case Stmt::ImplicitCastExprClass: {
1330 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev317291e2018-03-22 21:37:39 +00001331 // Should we support other implicit cast kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001332 switch (Cast->getCastKind()) {
1333 case CK_NoOp:
1334 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001335 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev13f96642018-03-09 01:39:59 +00001336 default:
1337 break;
1338 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001339 break;
1340 }
1341 case Stmt::CXXBindTemporaryExprClass: {
1342 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachevff267df2018-06-28 00:04:54 +00001343 findConstructionContexts(withExtraLayer(BTE), BTE->getSubExpr());
1344 break;
1345 }
1346 case Stmt::MaterializeTemporaryExprClass: {
1347 // Normally we don't want to search in MaterializeTemporaryExpr because
1348 // it indicates the beginning of a temporary object construction context,
1349 // so it shouldn't be found in the middle. However, if it is the beginning
1350 // of an elidable copy or move construction context, we need to include it.
1351 if (const auto *CE =
1352 dyn_cast_or_null<CXXConstructExpr>(Layer->getTriggerStmt())) {
1353 if (CE->isElidable()) {
1354 auto *MTE = cast<MaterializeTemporaryExpr>(Child);
1355 findConstructionContexts(withExtraLayer(MTE), MTE->GetTemporaryExpr());
1356 }
1357 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001358 break;
1359 }
1360 case Stmt::ConditionalOperatorClass: {
1361 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev9d3a7d82018-03-30 19:21:18 +00001362 if (!dyn_cast_or_null<MaterializeTemporaryExpr>(Layer->getTriggerStmt())) {
1363 // If the object returned by the conditional operator is not going to be a
1364 // temporary object that needs to be immediately materialized, then
1365 // it must be C++17 with its mandatory copy elision. Do not yet promise
1366 // to support this case.
1367 assert(!CO->getType()->getAsCXXRecordDecl() || CO->isGLValue() ||
1368 Context->getLangOpts().CPlusPlus17);
1369 break;
1370 }
Artem Dergachev40684812018-02-27 20:03:35 +00001371 findConstructionContexts(Layer, CO->getLHS());
1372 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001373 break;
1374 }
1375 default:
1376 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001377 }
1378}
1379
Artem Dergachev1527dec2018-03-12 23:12:40 +00001380void CFGBuilder::cleanupConstructionContext(Expr *E) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001381 assert(BuildOpts.AddRichCXXConstructors &&
1382 "We should not be managing construction contexts!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001383 assert(ConstructionContextMap.count(E) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001384 "Cannot exit construction context without the context!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001385 ConstructionContextMap.erase(E);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001386}
1387
1388
Mike Stump31feda52009-07-17 01:31:16 +00001389/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1390/// arbitrary statement. Examples include a single expression or a function
1391/// body (compound statement). The ownership of the returned CFG is
1392/// transferred to the caller. If CFG construction fails, this method returns
1393/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001394std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001395 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001396 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001397 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001398
Mike Stump31feda52009-07-17 01:31:16 +00001399 // Create an empty block that will serve as the exit block for the CFG. Since
1400 // this is the first block added to the CFG, it will be implicitly registered
1401 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001402 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001403 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001404 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001405
Matthias Gehre351c2182017-07-12 07:04:19 +00001406 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1407 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1408
Marcin Swiderski20b88732010-10-05 05:37:00 +00001409 if (BuildOpts.AddImplicitDtors)
1410 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1411 addImplicitDtorsForDestructor(DD);
1412
Ted Kremenek9aae5132007-08-23 21:42:29 +00001413 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001414 CFGBlock *B = addStmt(Statement);
1415
1416 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001417 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001418
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001419 // For C++ constructor add initializers to CFG.
1420 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001421 for (auto *I : llvm::reverse(CD->inits())) {
1422 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001423 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001424 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001425 }
1426 }
1427
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001428 if (B)
1429 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001430
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001431 // Backpatch the gotos whose label -> block mappings we didn't know when we
1432 // encountered them.
1433 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1434 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001435
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001436 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001437 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001438 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001439
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001440 // If there is no target for the goto, then we are looking at an
1441 // incomplete AST. Handle this by not registering a successor.
1442 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001443
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001444 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001445 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1446 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001447 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1448 JT.scopePosition);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001449 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1450 B, I->scopePosition, JT.scopePosition);
1451 appendScopeBegin(JT.block, VD, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001452 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001453 }
1454
1455 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001456 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001457 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1458 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001459 // Lookup the target block.
1460 LabelMapTy::iterator LI = LabelMap.find(*I);
1461
1462 // If there is no target block that contains label, then we are looking
1463 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001464 if (LI == LabelMap.end()) continue;
Fangrui Song6907ce22018-07-30 19:24:48 +00001465
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001466 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001467 }
Mike Stump31feda52009-07-17 01:31:16 +00001468
Mike Stump31feda52009-07-17 01:31:16 +00001469 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001470 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001471
Artem Dergachev783a4572018-02-23 22:20:39 +00001472 if (BuildOpts.AddRichCXXConstructors)
1473 assert(ConstructionContextMap.empty() &&
1474 "Not all construction contexts were cleaned up!");
1475
David Blaikiee90195c2014-08-29 18:53:26 +00001476 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001477}
Mike Stump31feda52009-07-17 01:31:16 +00001478
Ted Kremenek9aae5132007-08-23 21:42:29 +00001479/// createBlock - Used to lazily create blocks that are connected
1480/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001481CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1482 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001483 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001484 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001485 return B;
1486}
Mike Stump31feda52009-07-17 01:31:16 +00001487
Chandler Carrutha70991b2011-09-13 09:13:49 +00001488/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1489/// CFG. It is *not* connected to the current (global) successor, and instead
1490/// directly tied to the exit block in order to be reachable.
1491CFGBlock *CFGBuilder::createNoReturnBlock() {
1492 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001493 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001494 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001495 return B;
1496}
1497
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001498/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001499CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001500 if (!BuildOpts.AddInitializers)
1501 return Block;
1502
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001503 bool HasTemporaries = false;
1504
1505 // Destructors of temporaries in initialization expression should be called
1506 // after initialization finishes.
1507 Expr *Init = I->getInit();
1508 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001509 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001510
Jordan Rose6d671cc2012-09-05 22:55:23 +00001511 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001512 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001513 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001514 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1515 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001516 }
1517 }
1518
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001519 autoCreateBlock();
1520 appendInitializer(Block, I);
1521
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001522 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001523 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001524 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001525 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001526
Ted Kremenek8219b822010-12-16 07:46:53 +00001527 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001528 // For expression with temporaries go directly to subexpression to omit
1529 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001530 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1531 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001532 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1533 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1534 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1535 // may cause the same Expr to appear more than once in the CFG. Doing it
1536 // here is safe because there's only one initializer per field.
1537 autoCreateBlock();
1538 appendStmt(Block, Default);
1539 if (Stmt *Child = Default->getExpr())
1540 if (CFGBlock *R = Visit(Child))
1541 Block = R;
1542 return Block;
1543 }
1544 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001545 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001546 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001547
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001548 return Block;
1549}
1550
Fangrui Song6907ce22018-07-30 19:24:48 +00001551/// Retrieve the type of the temporary object whose lifetime was
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001552/// extended by a local reference with the given initializer.
Artem Dergacheva25809f2018-06-04 18:56:25 +00001553static QualType getReferenceInitTemporaryType(const Expr *Init,
Richard Smithb8c0f552016-12-09 18:49:13 +00001554 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001555 while (true) {
1556 // Skip parentheses.
1557 Init = Init->IgnoreParens();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001558
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001559 // Skip through cleanups.
1560 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1561 Init = EWC->getSubExpr();
1562 continue;
1563 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001564
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001565 // Skip through the temporary-materialization expression.
1566 if (const MaterializeTemporaryExpr *MTE
1567 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1568 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001569 if (FoundMTE)
1570 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001571 continue;
1572 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001573
1574 // Skip sub-object accesses into rvalues.
1575 SmallVector<const Expr *, 2> CommaLHSs;
1576 SmallVector<SubobjectAdjustment, 2> Adjustments;
1577 const Expr *SkippedInit =
1578 Init->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments);
1579 if (SkippedInit != Init) {
1580 Init = SkippedInit;
1581 continue;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001582 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001583
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001584 break;
1585 }
1586
1587 return Init->getType();
1588}
Matthias Gehre351c2182017-07-12 07:04:19 +00001589
Peter Szecsi999a25f2017-08-19 11:19:16 +00001590// TODO: Support adding LoopExit element to the CFG in case where the loop is
1591// ended by ReturnStmt, GotoStmt or ThrowExpr.
1592void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1593 if(!BuildOpts.AddLoopExit)
1594 return;
1595 autoCreateBlock();
1596 appendLoopExit(Block, LoopStmt);
1597}
1598
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001599void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1600 LocalScope::const_iterator E, Stmt *S) {
1601 if (!BuildOpts.AddScopes)
1602 return;
1603
1604 if (B == E)
1605 return;
1606
1607 // To go from B to E, one first goes up the scopes from B to P
1608 // then sideways in one scope from P to P' and then down
1609 // the scopes from P' to E.
1610 // The lifetime of all objects between B and P end.
1611 LocalScope::const_iterator P = B.shared_parent(E);
1612 int Dist = B.distance(P);
1613 if (Dist <= 0)
1614 return;
1615
1616 for (LocalScope::const_iterator I = B; I != P; ++I)
1617 if (I.pointsToFirstDeclaredVar())
1618 DeclsWithEndedScope.insert(*I);
1619}
1620
Matthias Gehre351c2182017-07-12 07:04:19 +00001621void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1622 LocalScope::const_iterator E,
1623 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001624 getDeclsWithEndedScope(B, E, S);
1625 if (BuildOpts.AddScopes)
1626 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001627 if (BuildOpts.AddImplicitDtors)
1628 addAutomaticObjDtors(B, E, S);
1629 if (BuildOpts.AddLifetime)
1630 addLifetimeEnds(B, E, S);
1631}
1632
1633/// Add to current block automatic objects that leave the scope.
1634void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1635 LocalScope::const_iterator E, Stmt *S) {
1636 if (!BuildOpts.AddLifetime)
1637 return;
1638
1639 if (B == E)
1640 return;
1641
1642 // To go from B to E, one first goes up the scopes from B to P
1643 // then sideways in one scope from P to P' and then down
1644 // the scopes from P' to E.
1645 // The lifetime of all objects between B and P end.
1646 LocalScope::const_iterator P = B.shared_parent(E);
1647 int dist = B.distance(P);
1648 if (dist <= 0)
1649 return;
1650
1651 // We need to perform the scope leaving in reverse order
1652 SmallVector<VarDecl *, 10> DeclsTrivial;
1653 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1654 DeclsTrivial.reserve(dist);
1655 DeclsNonTrivial.reserve(dist);
1656
1657 for (LocalScope::const_iterator I = B; I != P; ++I)
1658 if (hasTrivialDestructor(*I))
1659 DeclsTrivial.push_back(*I);
1660 else
1661 DeclsNonTrivial.push_back(*I);
1662
1663 autoCreateBlock();
1664 // object with trivial destructor end their lifetime last (when storage
1665 // duration ends)
1666 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1667 E = DeclsTrivial.rend();
1668 I != E; ++I)
1669 appendLifetimeEnds(Block, *I, S);
1670
1671 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1672 I = DeclsNonTrivial.rbegin(),
1673 E = DeclsNonTrivial.rend();
1674 I != E; ++I)
1675 appendLifetimeEnds(Block, *I, S);
1676}
1677
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001678/// Add to current block markers for ending scopes.
1679void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1680 LocalScope::const_iterator E, Stmt *S) {
1681 // If implicit destructors are enabled, we'll add scope ends in
1682 // addAutomaticObjDtors.
1683 if (BuildOpts.AddImplicitDtors)
1684 return;
1685
1686 autoCreateBlock();
1687
1688 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1689 I != E; ++I)
1690 appendScopeEnd(Block, *I, S);
1691
1692 return;
1693}
1694
Marcin Swiderski5e415732010-09-30 23:05:00 +00001695/// addAutomaticObjDtors - Add to current block automatic objects destructors
1696/// for objects in range of local scope positions. Use S as trigger statement
1697/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001698void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001699 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001700 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001701 return;
1702
Marcin Swiderski5e415732010-09-30 23:05:00 +00001703 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001704 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001705
Chandler Carruthad747252011-09-13 06:09:01 +00001706 // We need to append the destructors in reverse order, but any one of them
1707 // may be a no-return destructor which changes the CFG. As a result, buffer
1708 // this sequence up and replay them in reverse order when appending onto the
1709 // CFGBlock(s).
1710 SmallVector<VarDecl*, 10> Decls;
1711 Decls.reserve(B.distance(E));
1712 for (LocalScope::const_iterator I = B; I != E; ++I)
1713 Decls.push_back(*I);
1714
1715 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1716 E = Decls.rend();
1717 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001718 if (hasTrivialDestructor(*I)) {
1719 // If AddScopes is enabled and *I is a first variable in a scope, add a
1720 // ScopeEnd marker in a Block.
1721 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1722 autoCreateBlock();
1723 appendScopeEnd(Block, *I, S);
1724 }
1725 continue;
1726 }
Chandler Carruthad747252011-09-13 06:09:01 +00001727 // If this destructor is marked as a no-return destructor, we need to
1728 // create a new block for the destructor which does not have as a successor
1729 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001730 QualType Ty = (*I)->getType();
1731 if (Ty->isReferenceType()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00001732 Ty = getReferenceInitTemporaryType((*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001733 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001734 Ty = Context->getBaseElementType(Ty);
1735
Richard Trieu95a192a2015-05-28 00:14:02 +00001736 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001737 Block = createNoReturnBlock();
1738 else
Chandler Carruthad747252011-09-13 06:09:01 +00001739 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001740
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001741 // Add ScopeEnd just after automatic obj destructor.
1742 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1743 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001744 appendAutomaticObjDtor(Block, *I, S);
1745 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001746}
1747
Marcin Swiderski20b88732010-10-05 05:37:00 +00001748/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1749/// base and member objects in destructor.
1750void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001751 assert(BuildOpts.AddImplicitDtors &&
1752 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001753 const CXXRecordDecl *RD = DD->getParent();
1754
1755 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001756 for (const auto &VI : RD->vbases()) {
1757 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001758 if (!CD->hasTrivialDestructor()) {
1759 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001760 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001761 }
1762 }
1763
1764 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001765 for (const auto &BI : RD->bases()) {
1766 if (!BI.isVirtual()) {
1767 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001768 if (!CD->hasTrivialDestructor()) {
1769 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001770 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001771 }
1772 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001773 }
1774
1775 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001776 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001777 // Check for constant size array. Set type to array element type.
1778 QualType QT = FI->getType();
1779 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1780 if (AT->getSize() == 0)
1781 continue;
1782 QT = AT->getElementType();
1783 }
1784
1785 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001786 if (!CD->hasTrivialDestructor()) {
1787 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001788 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001789 }
1790 }
1791}
1792
Marcin Swiderski5e415732010-09-30 23:05:00 +00001793/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1794/// way return valid LocalScope object.
1795LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001796 if (Scope)
1797 return Scope;
1798 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1799 return new (alloc.Allocate<LocalScope>())
1800 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001801}
1802
1803/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Fangrui Song6907ce22018-07-30 19:24:48 +00001804/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001805void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001806 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1807 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001808 return;
1809
Craig Topper25542942014-05-20 04:30:07 +00001810 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001811
1812 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001813 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001814 for (auto *BI : CS->body()) {
1815 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001816 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001817 Scope = addLocalScopeForDeclStmt(DS, Scope);
1818 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001819 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001820 }
1821
1822 // For any other statement scope will be implicit and as such will be
1823 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001824 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001825 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001826}
1827
1828/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1829/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001830LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001831 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001832 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1833 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001834 return Scope;
1835
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001836 for (auto *DI : DS->decls())
1837 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001838 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001839 return Scope;
1840}
1841
Matthias Gehre351c2182017-07-12 07:04:19 +00001842bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1843 // Check for const references bound to temporary. Set type to pointee.
1844 QualType QT = VD->getType();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001845 if (QT->isReferenceType()) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001846 // Attempt to determine whether this declaration lifetime-extends a
1847 // temporary.
1848 //
1849 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1850 // temporaries, and a single declaration can extend multiple temporaries.
1851 // We should look at the storage duration on each nested
1852 // MaterializeTemporaryExpr instead.
1853
1854 const Expr *Init = VD->getInit();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001855 if (!Init) {
1856 // Probably an exception catch-by-reference variable.
1857 // FIXME: It doesn't really mean that the object has a trivial destructor.
1858 // Also are there other cases?
Matthias Gehre351c2182017-07-12 07:04:19 +00001859 return true;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001860 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001861
Artem Dergacheva25809f2018-06-04 18:56:25 +00001862 // Lifetime-extending a temporary?
Matthias Gehre351c2182017-07-12 07:04:19 +00001863 bool FoundMTE = false;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001864 QT = getReferenceInitTemporaryType(Init, &FoundMTE);
Matthias Gehre351c2182017-07-12 07:04:19 +00001865 if (!FoundMTE)
1866 return true;
1867 }
1868
1869 // Check for constant size array. Set type to array element type.
1870 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1871 if (AT->getSize() == 0)
1872 return true;
1873 QT = AT->getElementType();
1874 }
1875
1876 // Check if type is a C++ class with non-trivial destructor.
1877 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1878 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1879 return true;
1880}
1881
Marcin Swiderski5e415732010-09-30 23:05:00 +00001882/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1883/// create add scope for automatic objects and temporary objects bound to
1884/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001885LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001886 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001887 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1888 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001889 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1890 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001891 return Scope;
1892
1893 // Check if variable is local.
1894 switch (VD->getStorageClass()) {
1895 case SC_None:
1896 case SC_Auto:
1897 case SC_Register:
1898 break;
1899 default: return Scope;
1900 }
1901
Matthias Gehre351c2182017-07-12 07:04:19 +00001902 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001903 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001904 // Add the variable to scope
1905 Scope = createOrReuseLocalScope(Scope);
1906 Scope->addVar(VD);
1907 ScopePos = Scope->begin();
1908 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001909 return Scope;
1910 }
1911
1912 assert(BuildOpts.AddLifetime);
1913 // Add the variable to scope
1914 Scope = createOrReuseLocalScope(Scope);
1915 Scope->addVar(VD);
1916 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001917 return Scope;
1918}
1919
1920/// addLocalScopeAndDtors - For given statement add local scope for it and
1921/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001922void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001923 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001924 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001925 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001926}
1927
Marcin Swiderski321a7072010-09-30 22:54:37 +00001928/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1929/// variables with automatic storage duration to CFGBlock's elements vector.
1930/// Elements will be prepended to physical beginning of the vector which
1931/// happens to be logical end. Use blocks terminator as statement that specifies
1932/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001933/// FIXME: This mechanism for adding automatic destructors doesn't handle
1934/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001935void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001936 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001937 if (!BuildOpts.AddImplicitDtors)
1938 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001939 BumpVectorContext &C = cfg->getBumpVectorContext();
1940 CFGBlock::iterator InsertPos
1941 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1942 for (LocalScope::const_iterator I = B; I != E; ++I)
1943 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1944 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001945}
1946
Matthias Gehre351c2182017-07-12 07:04:19 +00001947/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1948/// variables with automatic storage duration to CFGBlock's elements vector.
1949/// Elements will be prepended to physical beginning of the vector which
1950/// happens to be logical end. Use blocks terminator as statement that specifies
1951/// where lifetime ends.
1952void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1953 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1954 if (!BuildOpts.AddLifetime)
1955 return;
1956 BumpVectorContext &C = cfg->getBumpVectorContext();
1957 CFGBlock::iterator InsertPos =
1958 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1959 for (LocalScope::const_iterator I = B; I != E; ++I)
1960 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1961}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001962
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001963/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
1964/// variables with automatic storage duration to CFGBlock's elements vector.
1965/// Elements will be prepended to physical beginning of the vector which
1966/// happens to be logical end. Use blocks terminator as statement that specifies
1967/// where scope ends.
1968const VarDecl *
1969CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
1970 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1971 if (!BuildOpts.AddScopes)
1972 return nullptr;
1973 BumpVectorContext &C = cfg->getBumpVectorContext();
1974 CFGBlock::iterator InsertPos =
1975 Blk->beginScopeEndInsert(Blk->end(), 1, C);
1976 LocalScope::const_iterator PlaceToInsert = B;
1977 for (LocalScope::const_iterator I = B; I != E; ++I)
1978 PlaceToInsert = I;
1979 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminator());
1980 return *PlaceToInsert;
1981}
1982
Ted Kremenek93668002009-07-17 22:18:43 +00001983/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001984/// blocks for ternary operators, &&, and ||. We also process "," and
1985/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001986CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001987 if (!S) {
1988 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001989 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001990 }
Jordy Rose17347372011-06-10 08:49:37 +00001991
1992 if (Expr *E = dyn_cast<Expr>(S))
1993 S = E->IgnoreParens();
1994
Ted Kremenek93668002009-07-17 22:18:43 +00001995 switch (S->getStmtClass()) {
1996 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001997 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001998
1999 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002000 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002001
John McCallc07a0c72011-02-17 10:25:35 +00002002 case Stmt::BinaryConditionalOperatorClass:
2003 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
2004
Ted Kremenek93668002009-07-17 22:18:43 +00002005 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002006 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002007
Ted Kremenek93668002009-07-17 22:18:43 +00002008 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00002009 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002010
Ted Kremenek93668002009-07-17 22:18:43 +00002011 case Stmt::BreakStmtClass:
2012 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002013
Ted Kremenek93668002009-07-17 22:18:43 +00002014 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00002015 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00002016 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00002017 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002018 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002019
Ted Kremenek93668002009-07-17 22:18:43 +00002020 case Stmt::CaseStmtClass:
2021 return VisitCaseStmt(cast<CaseStmt>(S));
2022
2023 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002024 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002025
Ted Kremenek93668002009-07-17 22:18:43 +00002026 case Stmt::CompoundStmtClass:
2027 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002028
Ted Kremenek93668002009-07-17 22:18:43 +00002029 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002030 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002031
Ted Kremenek93668002009-07-17 22:18:43 +00002032 case Stmt::ContinueStmtClass:
2033 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002034
Ted Kremenekb27378c2010-01-19 20:40:33 +00002035 case Stmt::CXXCatchStmtClass:
2036 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
2037
John McCall5d413782010-12-06 08:20:24 +00002038 case Stmt::ExprWithCleanupsClass:
2039 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00002040
Jordan Rosee5d53932012-08-23 18:10:53 +00002041 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00002042 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00002043 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
2044 // called function's declaration, not by the caller. If we simply add
2045 // this expression to the CFG, we could end up with the same Expr
2046 // appearing multiple times.
2047 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00002048 //
2049 // It's likewise possible for multiple CXXDefaultInitExprs for the same
2050 // expression to be used in the same function (through aggregate
2051 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00002052 return VisitStmt(S, asc);
2053
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002054 case Stmt::CXXBindTemporaryExprClass:
2055 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
2056
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002057 case Stmt::CXXConstructExprClass:
2058 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
2059
Jordan Rosec9176072014-01-13 17:59:19 +00002060 case Stmt::CXXNewExprClass:
2061 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2062
Jordan Rosed2f40792013-09-03 17:00:57 +00002063 case Stmt::CXXDeleteExprClass:
2064 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2065
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002066 case Stmt::CXXFunctionalCastExprClass:
2067 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2068
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002069 case Stmt::CXXTemporaryObjectExprClass:
2070 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2071
Ted Kremenekb27378c2010-01-19 20:40:33 +00002072 case Stmt::CXXThrowExprClass:
2073 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002074
Ted Kremenekb27378c2010-01-19 20:40:33 +00002075 case Stmt::CXXTryStmtClass:
2076 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002077
Richard Smith02e85f32011-04-14 22:09:26 +00002078 case Stmt::CXXForRangeStmtClass:
2079 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2080
Ted Kremenek93668002009-07-17 22:18:43 +00002081 case Stmt::DeclStmtClass:
2082 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002083
Ted Kremenek93668002009-07-17 22:18:43 +00002084 case Stmt::DefaultStmtClass:
2085 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002086
Ted Kremenek93668002009-07-17 22:18:43 +00002087 case Stmt::DoStmtClass:
2088 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002089
Ted Kremenek93668002009-07-17 22:18:43 +00002090 case Stmt::ForStmtClass:
2091 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002092
Ted Kremenek93668002009-07-17 22:18:43 +00002093 case Stmt::GotoStmtClass:
2094 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002095
Ted Kremenek93668002009-07-17 22:18:43 +00002096 case Stmt::IfStmtClass:
2097 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002098
Ted Kremenek8219b822010-12-16 07:46:53 +00002099 case Stmt::ImplicitCastExprClass:
2100 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002101
Ted Kremenek93668002009-07-17 22:18:43 +00002102 case Stmt::IndirectGotoStmtClass:
2103 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002104
Ted Kremenek93668002009-07-17 22:18:43 +00002105 case Stmt::LabelStmtClass:
2106 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002107
Ted Kremenekda76a942012-04-12 20:34:52 +00002108 case Stmt::LambdaExprClass:
2109 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2110
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002111 case Stmt::MaterializeTemporaryExprClass:
2112 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2113 asc);
2114
Ted Kremenek5868ec62010-04-11 17:02:10 +00002115 case Stmt::MemberExprClass:
2116 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2117
Ted Kremenek04268232011-11-05 00:10:15 +00002118 case Stmt::NullStmtClass:
2119 return Block;
2120
Ted Kremenek93668002009-07-17 22:18:43 +00002121 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002122 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2123
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002124 case Stmt::ObjCAutoreleasePoolStmtClass:
2125 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2126
Ted Kremenek93668002009-07-17 22:18:43 +00002127 case Stmt::ObjCAtSynchronizedStmtClass:
2128 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002129
Ted Kremenek93668002009-07-17 22:18:43 +00002130 case Stmt::ObjCAtThrowStmtClass:
2131 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002132
Ted Kremenek93668002009-07-17 22:18:43 +00002133 case Stmt::ObjCAtTryStmtClass:
2134 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002135
Ted Kremenek93668002009-07-17 22:18:43 +00002136 case Stmt::ObjCForCollectionStmtClass:
2137 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002138
Artem Dergachevbd880fe2018-07-31 19:39:37 +00002139 case Stmt::ObjCMessageExprClass:
2140 return VisitObjCMessageExpr(cast<ObjCMessageExpr>(S), asc);
2141
Ted Kremenek04268232011-11-05 00:10:15 +00002142 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002143 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002144
John McCallfe96e0b2011-11-06 09:01:30 +00002145 case Stmt::PseudoObjectExprClass:
2146 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2147
Ted Kremenek93668002009-07-17 22:18:43 +00002148 case Stmt::ReturnStmtClass:
2149 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002150
Nico Weber699670e2017-08-23 15:33:16 +00002151 case Stmt::SEHExceptStmtClass:
2152 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2153
2154 case Stmt::SEHFinallyStmtClass:
2155 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2156
2157 case Stmt::SEHLeaveStmtClass:
2158 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2159
2160 case Stmt::SEHTryStmtClass:
2161 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2162
Peter Collingbournee190dee2011-03-11 19:24:49 +00002163 case Stmt::UnaryExprOrTypeTraitExprClass:
2164 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2165 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002166
Ted Kremenek93668002009-07-17 22:18:43 +00002167 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002168 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002169
Ted Kremenek93668002009-07-17 22:18:43 +00002170 case Stmt::SwitchStmtClass:
2171 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002172
Zhanyong Wan6dace612010-11-22 08:45:56 +00002173 case Stmt::UnaryOperatorClass:
2174 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2175
Ted Kremenek93668002009-07-17 22:18:43 +00002176 case Stmt::WhileStmtClass:
2177 return VisitWhileStmt(cast<WhileStmt>(S));
2178 }
2179}
Mike Stump11289f42009-09-09 15:08:12 +00002180
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002181CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002182 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002183 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002184 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002185 }
Mike Stump11289f42009-09-09 15:08:12 +00002186
Ted Kremenek93668002009-07-17 22:18:43 +00002187 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002188}
Mike Stump31feda52009-07-17 01:31:16 +00002189
Ted Kremenek93668002009-07-17 22:18:43 +00002190/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002191CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2192 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002193
Ted Kremenek8ae67872013-02-05 22:00:19 +00002194 // Visit the children in their reverse order so that they appear in
2195 // left-to-right (natural) order in the CFG.
2196 reverse_children RChildren(S);
2197 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2198 I != E; ++I) {
2199 if (Stmt *Child = *I)
2200 if (CFGBlock *R = Visit(Child))
2201 B = R;
2202 }
2203 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002204}
Mike Stump11289f42009-09-09 15:08:12 +00002205
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002206CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2207 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002208 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002209
Ted Kremenek7c58d352011-03-10 01:14:11 +00002210 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002211 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002212 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002213 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002214
Ted Kremenek9aae5132007-08-23 21:42:29 +00002215 return Block;
2216}
Mike Stump11289f42009-09-09 15:08:12 +00002217
Zhanyong Wan6dace612010-11-22 08:45:56 +00002218CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002219 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002220 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002221 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002222 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002223 }
2224
Ted Kremenek8219b822010-12-16 07:46:53 +00002225 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002226}
2227
Ted Kremeneka16436f2012-07-14 05:04:06 +00002228CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2229 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2230 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002231
Ted Kremeneka16436f2012-07-14 05:04:06 +00002232 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002233 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002234
Craig Topper25542942014-05-20 04:30:07 +00002235 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2236 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002237}
2238
2239std::pair<CFGBlock*, CFGBlock*>
2240CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2241 Stmt *Term,
2242 CFGBlock *TrueBlock,
2243 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002244 // Introspect the RHS. If it is a nested logical operation, we recursively
2245 // build the CFG using this function. Otherwise, resort to default
2246 // CFG construction behavior.
2247 Expr *RHS = B->getRHS()->IgnoreParens();
2248 CFGBlock *RHSBlock, *ExitBlock;
2249
2250 do {
2251 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2252 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002253 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002254 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2255 break;
2256 }
2257
2258 // The RHS is not a nested logical operation. Don't push the terminator
2259 // down further, but instead visit RHS and construct the respective
2260 // pieces of the CFG, and link up the RHSBlock with the terminator
2261 // we have been provided.
2262 ExitBlock = RHSBlock = createBlock(false);
2263
Richard Trieu6a6af522017-01-04 00:46:30 +00002264 // Even though KnownVal is only used in the else branch of the next
2265 // conditional, tryEvaluateBool performs additional checking on the
2266 // Expr, so it should be called unconditionally.
2267 TryResult KnownVal = tryEvaluateBool(RHS);
2268 if (!KnownVal.isKnown())
2269 KnownVal = tryEvaluateBool(B);
2270
Ted Kremenekb50e7162012-07-14 05:04:10 +00002271 if (!Term) {
2272 assert(TrueBlock == FalseBlock);
2273 addSuccessor(RHSBlock, TrueBlock);
2274 }
2275 else {
2276 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002277 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2278 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002279 }
2280
2281 Block = RHSBlock;
2282 RHSBlock = addStmt(RHS);
2283 }
2284 while (false);
2285
2286 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002287 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002288
2289 // Generate the blocks for evaluating the LHS.
2290 Expr *LHS = B->getLHS()->IgnoreParens();
2291
2292 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2293 if (B_LHS->isLogicalOp()) {
2294 if (B->getOpcode() == BO_LOr)
2295 FalseBlock = RHSBlock;
2296 else
2297 TrueBlock = RHSBlock;
2298
2299 // For the LHS, treat 'B' as the terminator that we want to sink
2300 // into the nested branch. The RHS always gets the top-most
2301 // terminator.
2302 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2303 }
2304
2305 // Create the block evaluating the LHS.
2306 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002307 CFGBlock *LHSBlock = createBlock(false);
2308 LHSBlock->setTerminator(B);
2309
Ted Kremeneka16436f2012-07-14 05:04:06 +00002310 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002311 CFGBlock *EntryLHSBlock = addStmt(LHS);
2312
2313 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002314 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002315
2316 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002317 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002318
2319 // Now link the LHSBlock with RHSBlock.
2320 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002321 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2322 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002323 } else {
2324 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002325 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2326 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002327 }
2328
Ted Kremenekb50e7162012-07-14 05:04:10 +00002329 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002330}
2331
2332CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2333 AddStmtChoice asc) {
2334 // && or ||
2335 if (B->isLogicalOp())
2336 return VisitLogicalOperator(B);
2337
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002338 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002339 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002340 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002341 addStmt(B->getRHS());
2342 return addStmt(B->getLHS());
2343 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002344
2345 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002346 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002347 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002348 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002349 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002350 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002351 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002352 }
Mike Stump11289f42009-09-09 15:08:12 +00002353
Ted Kremenek7c58d352011-03-10 01:14:11 +00002354 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002355 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002356 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002357 }
2358
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002359 CFGBlock *RBlock = Visit(B->getRHS());
2360 CFGBlock *LBlock = Visit(B->getLHS());
2361 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2362 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2363 // return RBlock. Otherwise we'll incorrectly return NULL.
2364 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002365}
2366
Ted Kremeneke2499842012-04-12 20:03:44 +00002367CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002368 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002369 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002370 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002371 }
2372 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002373}
2374
Ted Kremenek93668002009-07-17 22:18:43 +00002375CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2376 // "break" is a control-flow statement. Thus we stop processing the current
2377 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002378 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002379 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002380
Ted Kremenek93668002009-07-17 22:18:43 +00002381 // Now create a new block that ends with the break statement.
2382 Block = createBlock(false);
2383 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002384
Ted Kremenek93668002009-07-17 22:18:43 +00002385 // If there is no target for the break, then we are looking at an incomplete
2386 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002387 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002388 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002389 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002390 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002391 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002392
Ted Kremenek9aae5132007-08-23 21:42:29 +00002393 return Block;
2394}
Mike Stump11289f42009-09-09 15:08:12 +00002395
Sebastian Redl31ad7542011-03-13 17:09:40 +00002396static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002397 QualType Ty = E->getType();
2398 if (Ty->isFunctionPointerType())
2399 Ty = Ty->getAs<PointerType>()->getPointeeType();
2400 else if (Ty->isBlockPointerType())
2401 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002402
Mike Stump04c68512010-01-21 15:20:48 +00002403 const FunctionType *FT = Ty->getAs<FunctionType>();
2404 if (FT) {
2405 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002406 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00002407 Proto->isNothrow())
Mike Stump04c68512010-01-21 15:20:48 +00002408 return false;
2409 }
2410 return true;
2411}
2412
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002413CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002414 // Compute the callee type.
2415 QualType calleeType = C->getCallee()->getType();
2416 if (calleeType == Context->BoundMemberTy) {
2417 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2418
2419 // We should only get a null bound type if processing a dependent
2420 // CFG. Recover by assuming nothing.
2421 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002422 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002423
Artem Dergachevbd880fe2018-07-31 19:39:37 +00002424 findConstructionContextsForArguments(C);
Artem Dergachev72da02f2018-04-19 23:09:22 +00002425
John McCallc67067f2011-05-11 07:19:11 +00002426 // If this is a call to a no-return function, this stops the block here.
2427 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2428
Mike Stump04c68512010-01-21 15:20:48 +00002429 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002430
2431 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002432 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002433 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002434 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002435 }
2436
Jordan Rose5374c072013-08-19 16:27:28 +00002437 // If this is a call to a builtin function, it might not actually evaluate
2438 // its arguments. Don't add them to the CFG if this is the case.
2439 bool OmitArguments = false;
2440
Mike Stump92244b02010-01-19 22:00:14 +00002441 if (FunctionDecl *FD = C->getDirectCallee()) {
Nico Weber758fbac2018-02-13 21:31:47 +00002442 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002443 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002444 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002445 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00002446 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
2447 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002448 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002449
Sebastian Redl31ad7542011-03-13 17:09:40 +00002450 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002451 AddEHEdge = false;
2452
Jordan Rose5374c072013-08-19 16:27:28 +00002453 if (OmitArguments) {
2454 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2455 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2456 autoCreateBlock();
2457 appendStmt(Block, C);
2458 return Visit(C->getCallee());
2459 }
2460
2461 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002462 autoCreateBlock();
2463 appendCall(Block, C);
2464
2465 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002466 }
Mike Stump11289f42009-09-09 15:08:12 +00002467
Mike Stump92244b02010-01-19 22:00:14 +00002468 if (Block) {
2469 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002470 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002471 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002472 }
Mike Stump11289f42009-09-09 15:08:12 +00002473
Chandler Carrutha70991b2011-09-13 09:13:49 +00002474 if (NoReturn)
2475 Block = createNoReturnBlock();
2476 else
2477 Block = createBlock();
2478
Artem Dergachev1527dec2018-03-12 23:12:40 +00002479 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002480
Mike Stump04c68512010-01-21 15:20:48 +00002481 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002482 // Add exceptional edges.
2483 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002484 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002485 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002486 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002487 }
Mike Stump11289f42009-09-09 15:08:12 +00002488
Mike Stump8c5d7992009-07-25 21:26:53 +00002489 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002490}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002491
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002492CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2493 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002494 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002495 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002496 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002497 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002498
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002499 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002500 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002501 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002502 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002503 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002504 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002505
Ted Kremenek21822592009-07-17 18:20:32 +00002506 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002507 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002508 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002509 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002510 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002511
Ted Kremenek21822592009-07-17 18:20:32 +00002512 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002513 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002514 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002515 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2516 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002517 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002518 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002519}
Mike Stump11289f42009-09-09 15:08:12 +00002520
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002521CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002522 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002523 addLocalScopeForStmt(C);
2524
Matthias Gehre09a134e2015-11-14 00:36:50 +00002525 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002526 // If the body ends with a ReturnStmt, the dtors will be added in
2527 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002528 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002529 }
2530
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002531 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002532
2533 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2534 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002535 // If we hit a segment of code just containing ';' (NullStmts), we can
2536 // get a null block back. In such cases, just use the LastBlock
2537 if (CFGBlock *newBlock = addStmt(*I))
2538 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002539
Ted Kremenekce499c22009-08-27 23:16:26 +00002540 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002541 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002542 }
Mike Stump92244b02010-01-19 22:00:14 +00002543
Ted Kremenek93668002009-07-17 22:18:43 +00002544 return LastBlock;
2545}
Mike Stump11289f42009-09-09 15:08:12 +00002546
John McCallc07a0c72011-02-17 10:25:35 +00002547CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002548 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002549 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002550 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002551
Ted Kremenek51d40b02009-07-17 18:15:54 +00002552 // Create the confluence block that will "merge" the results of the ternary
2553 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002554 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002555 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002556 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002557 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002558
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002559 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002560
Ted Kremenek51d40b02009-07-17 18:15:54 +00002561 // Create a block for the LHS expression if there is an LHS expression. A
2562 // GCC extension allows LHS to be NULL, causing the condition to be the
2563 // value that is returned instead.
2564 // e.g: x ?: y is shorthand for: x ? x : y;
2565 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002566 Block = nullptr;
2567 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002568 const Expr *trueExpr = C->getTrueExpr();
2569 if (trueExpr != opaqueValue) {
2570 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002571 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002572 return nullptr;
2573 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002574 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002575 else
2576 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002577
Ted Kremenek51d40b02009-07-17 18:15:54 +00002578 // Create the block for the RHS expression.
2579 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002580 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002581 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002582 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002583
Richard Smithf676e452012-07-24 21:02:14 +00002584 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2585 if (BinaryOperator *Cond =
2586 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2587 if (Cond->isLogicalOp())
2588 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2589
Ted Kremenek51d40b02009-07-17 18:15:54 +00002590 // Create the block that will contain the condition.
2591 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002592
Mike Stump773582d2009-07-23 23:25:26 +00002593 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002594 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002595 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2596 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002597 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002598 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002599
Ted Kremenekd8138012011-02-24 03:09:15 +00002600 if (opaqueValue) {
2601 // Run the condition expression if it's not trivially expressed in
2602 // terms of the opaque value (or if there is no opaque value).
2603 if (condExpr != opaqueValue)
2604 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002605
Ted Kremenekd8138012011-02-24 03:09:15 +00002606 // Before that, run the common subexpression if there was one.
2607 // At least one of this or the above will be run.
2608 return addStmt(BCO->getCommon());
2609 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002610
Ted Kremenekd8138012011-02-24 03:09:15 +00002611 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002612}
2613
Ted Kremenek93668002009-07-17 22:18:43 +00002614CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002615 // Check if the Decl is for an __label__. If so, elide it from the
2616 // CFG entirely.
2617 if (isa<LabelDecl>(*DS->decl_begin()))
2618 return Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00002619
Ted Kremenek3a601142011-05-24 20:41:31 +00002620 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002621 if (DS->isSingleDecl())
2622 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002623
Craig Topper25542942014-05-20 04:30:07 +00002624 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002625
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002626 // Build an individual DeclStmt for each decl.
2627 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2628 E = DS->decl_rend();
2629 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00002630 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
Benjamin Kramerc3f89252016-10-20 14:27:22 +00002631 unsigned A = alignof(DeclStmt) < 8 ? 8 : alignof(DeclStmt);
Mike Stump11289f42009-09-09 15:08:12 +00002632
Ted Kremenek93668002009-07-17 22:18:43 +00002633 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2634 // automatically freed with the CFG.
2635 DeclGroupRef DG(*I);
2636 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00002637 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00002638 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002639 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002640
Ted Kremenek93668002009-07-17 22:18:43 +00002641 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002642 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002643 }
Mike Stump11289f42009-09-09 15:08:12 +00002644
2645 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002646}
Mike Stump11289f42009-09-09 15:08:12 +00002647
Ted Kremenek93668002009-07-17 22:18:43 +00002648/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002649/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002650CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002651 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002652 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002653
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002654 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002655 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2656 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002657 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002658 }
Mike Stump11289f42009-09-09 15:08:12 +00002659
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002660 bool HasTemporaries = false;
2661
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002662 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002663 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002664
2665 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2666 // For static variables, we need to create a branch to track
2667 // whether or not they are initialized.
2668 if (Block) {
2669 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002670 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002671 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002672 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002673 }
2674 blockAfterStaticInit = Succ;
2675 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002676
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002677 // Destructors of temporaries in initialization expression should be called
2678 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002679 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002680 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002681 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002682
Jordan Rose6d671cc2012-09-05 22:55:23 +00002683 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002684 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002685 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002686 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2687 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002688 }
2689 }
2690
2691 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002692 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002693
Artem Dergachev783a4572018-02-23 22:20:39 +00002694 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002695 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002696 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002697
Ted Kremenek213d0532012-03-22 05:57:43 +00002698 // Keep track of the last non-null block, as 'Block' can be nulled out
2699 // if the initializer expression is something like a 'while' in a
2700 // statement-expression.
2701 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002702
Ted Kremenek93668002009-07-17 22:18:43 +00002703 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002704 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002705 // For expression with temporaries go directly to subexpression to omit
2706 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002707 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2708 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2709 LastBlock = newBlock;
2710 }
2711 else {
2712 if (CFGBlock *newBlock = Visit(Init))
2713 LastBlock = newBlock;
2714 }
Ted Kremenek93668002009-07-17 22:18:43 +00002715 }
Mike Stump11289f42009-09-09 15:08:12 +00002716
Ted Kremenek93668002009-07-17 22:18:43 +00002717 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002718 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002719 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002720 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2721 LastBlock = newBlock;
2722 }
Mike Stump11289f42009-09-09 15:08:12 +00002723
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002724 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2725
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002726 // Remove variable from local scope.
2727 if (ScopePos && VD == *ScopePos)
2728 ++ScopePos;
2729
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002730 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002731 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002732 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002733 Block = createBlock(false);
2734 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002735 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002736 addSuccessor(Block, B);
2737 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002738 }
2739
2740 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002741}
2742
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002743CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002744 // We may see an if statement in the middle of a basic block, or it may be the
2745 // first statement we are processing. In either case, we create a new basic
2746 // block. First, we create the blocks for the then...else statements, and
2747 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002748 // middle of a block, we stop processing that block. That block is then the
2749 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002750
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002751 // Save local scope position because in case of condition variable ScopePos
2752 // won't be restored when traversing AST.
2753 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2754
Richard Smitha547eb22016-07-14 00:11:03 +00002755 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002756 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002757 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002758
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002759 // Create local scope for possible condition variable.
2760 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002761 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002762 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002763
Matthias Gehre351c2182017-07-12 07:04:19 +00002764 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002765
Chris Lattner57540c52011-04-15 05:22:18 +00002766 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002767 // block.
2768 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002769 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002770 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002771 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002772 }
Mike Stump31feda52009-07-17 01:31:16 +00002773
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002774 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002775 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002776
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002777 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002778 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002779
Ted Kremenek9aae5132007-08-23 21:42:29 +00002780 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002781 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002782 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002783
2784 // If branch is not a compound statement create implicit scope
2785 // and add destructors.
2786 if (!isa<CompoundStmt>(Else))
2787 addLocalScopeAndDtors(Else);
2788
Ted Kremenek93668002009-07-17 22:18:43 +00002789 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002790
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002791 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2792 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002793 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002794 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002795 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002796 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002797 }
Mike Stump31feda52009-07-17 01:31:16 +00002798
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002799 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002800 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002801 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002802 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002803 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002804 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002805 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002806
2807 // If branch is not a compound statement create implicit scope
2808 // and add destructors.
2809 if (!isa<CompoundStmt>(Then))
2810 addLocalScopeAndDtors(Then);
2811
Ted Kremenek93668002009-07-17 22:18:43 +00002812 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002813
Ted Kremenek1b379512009-04-01 03:52:47 +00002814 if (!ThenBlock) {
2815 // We can reach here if the "then" body has all NullStmts.
2816 // Create an empty block so we can distinguish between true and false
2817 // branches in path-sensitive analyses.
2818 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002819 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002820 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002821 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002822 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002823 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002824 }
2825
Ted Kremenekb50e7162012-07-14 05:04:10 +00002826 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2827 // having these handle the actual control-flow jump. Note that
2828 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2829 // we resort to the old control-flow behavior. This special handling
2830 // removes infeasible paths from the control-flow graph by having the
2831 // control-flow transfer of '&&' or '||' go directly into the then/else
2832 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002833 BinaryOperator *Cond =
2834 I->getConditionVariable()
2835 ? nullptr
2836 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2837 CFGBlock *LastBlock;
2838 if (Cond && Cond->isLogicalOp())
2839 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2840 else {
2841 // Now create a new block containing the if statement.
2842 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002843
Richard Smith509bbd12017-01-13 22:16:41 +00002844 // Set the terminator of the new block to the If statement.
2845 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002846
Richard Smith509bbd12017-01-13 22:16:41 +00002847 // See if this is a known constant.
2848 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002849
Richard Smith509bbd12017-01-13 22:16:41 +00002850 // Add the successors. If we know that specific branches are
2851 // unreachable, inform addSuccessor() of that knowledge.
2852 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2853 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002854
Richard Smith509bbd12017-01-13 22:16:41 +00002855 // Add the condition as the last statement in the new block. This may
2856 // create new blocks as the condition may contain control-flow. Any newly
2857 // created blocks will be pointed to be "Block".
2858 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002859
Richard Smith509bbd12017-01-13 22:16:41 +00002860 // If the IfStmt contains a condition variable, add it and its
2861 // initializer to the CFG.
2862 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2863 autoCreateBlock();
2864 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2865 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002866 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002867
Richard Smitha547eb22016-07-14 00:11:03 +00002868 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2869 if (Stmt *Init = I->getInit()) {
2870 autoCreateBlock();
2871 LastBlock = addStmt(Init);
2872 }
2873
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002874 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002875}
Mike Stump31feda52009-07-17 01:31:16 +00002876
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002877CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002878 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002879 //
Mike Stump31feda52009-07-17 01:31:16 +00002880 // NOTE: If a "return" appears in the middle of a block, this means that the
2881 // code afterwards is DEAD (unreachable). We still keep a basic block
2882 // for that code; a simple "mark-and-sweep" from the entry block will be
2883 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002884
2885 // Create the new block.
2886 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002887
Matthias Gehre351c2182017-07-12 07:04:19 +00002888 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002889
Artem Dergachev783a4572018-02-23 22:20:39 +00002890 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002891 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
Artem Dergachev783a4572018-02-23 22:20:39 +00002892 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002893
Pavel Labath921e7652013-09-06 08:12:48 +00002894 // If the one of the destructors does not return, we already have the Exit
2895 // block as a successor.
2896 if (!Block->hasNoReturnElement())
2897 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002898
2899 // Add the return statement to the block. This may create new blocks if R
2900 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002901 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002902}
2903
Nico Weber699670e2017-08-23 15:33:16 +00002904CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2905 // SEHExceptStmt are treated like labels, so they are the first statement in a
2906 // block.
2907
2908 // Save local scope position because in case of exception variable ScopePos
2909 // won't be restored when traversing AST.
2910 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2911
2912 addStmt(ES->getBlock());
2913 CFGBlock *SEHExceptBlock = Block;
2914 if (!SEHExceptBlock)
2915 SEHExceptBlock = createBlock();
2916
2917 appendStmt(SEHExceptBlock, ES);
2918
2919 // Also add the SEHExceptBlock as a label, like with regular labels.
2920 SEHExceptBlock->setLabel(ES);
2921
2922 // Bail out if the CFG is bad.
2923 if (badCFG)
2924 return nullptr;
2925
2926 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2927 Block = nullptr;
2928
2929 return SEHExceptBlock;
2930}
2931
2932CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2933 return VisitCompoundStmt(FS->getBlock());
2934}
2935
2936CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2937 // "__leave" is a control-flow statement. Thus we stop processing the current
2938 // block.
2939 if (badCFG)
2940 return nullptr;
2941
2942 // Now create a new block that ends with the __leave statement.
2943 Block = createBlock(false);
2944 Block->setTerminator(LS);
2945
2946 // If there is no target for the __leave, then we are looking at an incomplete
2947 // AST. This means that the CFG cannot be constructed.
2948 if (SEHLeaveJumpTarget.block) {
2949 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2950 addSuccessor(Block, SEHLeaveJumpTarget.block);
2951 } else
2952 badCFG = true;
2953
2954 return Block;
2955}
2956
2957CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2958 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2959 // processing the current block.
2960 CFGBlock *SEHTrySuccessor = nullptr;
2961
2962 if (Block) {
2963 if (badCFG)
2964 return nullptr;
2965 SEHTrySuccessor = Block;
2966 } else SEHTrySuccessor = Succ;
2967
2968 // FIXME: Implement __finally support.
2969 if (Terminator->getFinallyHandler())
2970 return NYS();
2971
2972 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2973
2974 // Create a new block that will contain the __try statement.
2975 CFGBlock *NewTryTerminatedBlock = createBlock(false);
2976
2977 // Add the terminator in the __try block.
2978 NewTryTerminatedBlock->setTerminator(Terminator);
2979
2980 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
2981 // The code after the try is the implicit successor if there's an __except.
2982 Succ = SEHTrySuccessor;
2983 Block = nullptr;
2984 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
2985 if (!ExceptBlock)
2986 return nullptr;
2987 // Add this block to the list of successors for the block with the try
2988 // statement.
2989 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
2990 }
2991 if (PrevSEHTryTerminatedBlock)
2992 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
2993 else
2994 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
2995
2996 // The code after the try is the implicit successor.
2997 Succ = SEHTrySuccessor;
2998
2999 // Save the current "__try" context.
3000 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
3001 NewTryTerminatedBlock);
3002 cfg->addTryDispatchBlock(TryTerminatedBlock);
3003
3004 // Save the current value for the __leave target.
3005 // All __leaves should go to the code following the __try
3006 // (FIXME: or if the __try has a __finally, to the __finally.)
3007 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
3008 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
3009
3010 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
3011 Block = nullptr;
3012 return addStmt(Terminator->getTryBlock());
3013}
3014
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003015CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003016 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00003017 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003018 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003019
Ted Kremenek93668002009-07-17 22:18:43 +00003020 if (!LabelBlock) // This can happen when the body is empty, i.e.
3021 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00003022
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003023 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
3024 "label already in map");
3025 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003026
3027 // Labels partition blocks, so this is the end of the basic block we were
3028 // processing (L is the block's label). Because this is label (and we have
3029 // already processed the substatement) there is no extra control-flow to worry
3030 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00003031 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003032 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003033 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003034
3035 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00003036 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003037
Ted Kremenek9aae5132007-08-23 21:42:29 +00003038 // This block is now the implicit successor of other blocks.
3039 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003040
Ted Kremenek9aae5132007-08-23 21:42:29 +00003041 return LabelBlock;
3042}
3043
Devin Coughlinb6029b72015-11-25 22:35:37 +00003044CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
3045 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3046 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
3047 if (Expr *CopyExpr = CI.getCopyExpr()) {
3048 CFGBlock *Tmp = Visit(CopyExpr);
3049 if (Tmp)
3050 LastBlock = Tmp;
3051 }
3052 }
3053 return LastBlock;
3054}
3055
Ted Kremenekda76a942012-04-12 20:34:52 +00003056CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
3057 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3058 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
3059 et = E->capture_init_end(); it != et; ++it) {
3060 if (Expr *Init = *it) {
3061 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00003062 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00003063 LastBlock = Tmp;
3064 }
3065 }
3066 return LastBlock;
3067}
Fangrui Song6907ce22018-07-30 19:24:48 +00003068
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003069CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003070 // Goto is a control-flow statement. Thus we stop processing the current
3071 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003072
Ted Kremenek9aae5132007-08-23 21:42:29 +00003073 Block = createBlock(false);
3074 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003075
3076 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003077 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003078
Ted Kremenek9aae5132007-08-23 21:42:29 +00003079 if (I == LabelMap.end())
3080 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003081 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3082 else {
3083 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003084 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003085 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003086 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003087
Mike Stump31feda52009-07-17 01:31:16 +00003088 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003089}
3090
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003091CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003092 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003093
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003094 // Save local scope position because in case of condition variable ScopePos
3095 // won't be restored when traversing AST.
3096 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3097
3098 // Create local scope for init statement and possible condition variable.
3099 // Add destructor for init statement and condition variable.
3100 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003101 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003102 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003103 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3104
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003105 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003106 addLocalScopeForVarDecl(VD);
3107 LocalScope::const_iterator ContinueScopePos = ScopePos;
3108
Matthias Gehre351c2182017-07-12 07:04:19 +00003109 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003110
Peter Szecsi999a25f2017-08-19 11:19:16 +00003111 addLoopExit(F);
3112
Mike Stump014b3ea2009-07-21 01:12:51 +00003113 // "for" is a control-flow statement. Thus we stop processing the current
3114 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003115 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003116 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003117 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003118 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003119 } else
3120 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003121
Ted Kremenek304a9532010-05-21 20:30:15 +00003122 // Save the current value for the break targets.
3123 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003124 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003125 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003126
Craig Topper25542942014-05-20 04:30:07 +00003127 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003128
Ted Kremenek9aae5132007-08-23 21:42:29 +00003129 // Now create the loop body.
3130 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003131 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003132
Ted Kremenekb50e7162012-07-14 05:04:10 +00003133 // Save the current values for Block, Succ, continue and break targets.
3134 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3135 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003136
Ted Kremenekb50e7162012-07-14 05:04:10 +00003137 // Create an empty block to represent the transition block for looping back
3138 // to the head of the loop. If we have increment code, it will
3139 // go in this block as well.
3140 Block = Succ = TransitionBlock = createBlock(false);
3141 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003142
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003143 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003144 // Generate increment code in its own basic block. This is the target of
3145 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003146 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003147 }
Mike Stump31feda52009-07-17 01:31:16 +00003148
Ted Kremenek902393b2009-04-28 00:51:56 +00003149 // Finish up the increment (or empty) block if it hasn't been already.
3150 if (Block) {
3151 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003152 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003153 return nullptr;
3154 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003155 }
Mike Stump31feda52009-07-17 01:31:16 +00003156
Ted Kremenekb50e7162012-07-14 05:04:10 +00003157 // The starting block for the loop increment is the block that should
3158 // represent the 'loop target' for looping back to the start of the loop.
3159 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3160 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003161
Ted Kremenekb50e7162012-07-14 05:04:10 +00003162 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003163 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003164
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003165 // If body is not a compound statement create implicit scope
3166 // and add destructors.
3167 if (!isa<CompoundStmt>(F->getBody()))
3168 addLocalScopeAndDtors(F->getBody());
3169
Mike Stump31feda52009-07-17 01:31:16 +00003170 // Now populate the body block, and in the process create new blocks as we
3171 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003172 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003173
Ted Kremenekb50e7162012-07-14 05:04:10 +00003174 if (!BodyBlock) {
3175 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3176 // Use the continue jump target as the proxy for the body.
3177 BodyBlock = ContinueJumpTarget.block;
3178 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003179 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003180 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003181 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003182
Ted Kremenekb50e7162012-07-14 05:04:10 +00003183 // Because of short-circuit evaluation, the condition of the loop can span
3184 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3185 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003186 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003187
Ted Kremenekb50e7162012-07-14 05:04:10 +00003188 do {
3189 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003190 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003191
3192 // Specially handle logical operators, which have a slightly
3193 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003194 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003195 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003196 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003197 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003198 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3199 break;
3200 }
3201
3202 // The default case when not handling logical operators.
3203 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3204 ExitConditionBlock->setTerminator(F);
3205
3206 // See if this is a known constant.
3207 TryResult KnownVal(true);
3208
3209 if (C) {
3210 // Now add the actual condition to the condition block.
3211 // Because the condition itself may contain control-flow, new blocks may
3212 // be created. Thus we update "Succ" after adding the condition.
3213 Block = ExitConditionBlock;
3214 EntryConditionBlock = addStmt(C);
3215
3216 // If this block contains a condition variable, add both the condition
3217 // variable and initializer to the CFG.
3218 if (VarDecl *VD = F->getConditionVariable()) {
3219 if (Expr *Init = VD->getInit()) {
3220 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003221 const DeclStmt *DS = F->getConditionVariableDeclStmt();
3222 assert(DS->isSingleDecl());
3223 findConstructionContexts(
3224 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3225 const_cast<DeclStmt *>(DS)),
3226 Init);
3227 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003228 EntryConditionBlock = addStmt(Init);
3229 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003230 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003231 }
3232 }
3233
3234 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003235 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003236
3237 KnownVal = tryEvaluateBool(C);
3238 }
3239
3240 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003241 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003242 // Link up the condition block with the code that follows the loop. (the
3243 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003244 addSuccessor(ExitConditionBlock,
3245 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003246 } while (false);
3247
3248 // Link up the loop-back block to the entry condition block.
3249 addSuccessor(TransitionBlock, EntryConditionBlock);
Fangrui Song6907ce22018-07-30 19:24:48 +00003250
Ted Kremenekb50e7162012-07-14 05:04:10 +00003251 // The condition block is the implicit successor for any code above the loop.
3252 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003253
Ted Kremenek9aae5132007-08-23 21:42:29 +00003254 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003255 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003256 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003257 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3258 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003259 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003260 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003261 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003262
3263 // There is no loop initialization. We are thus basically a while loop.
3264 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003265 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003266 Succ = EntryConditionBlock;
3267 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003268}
3269
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003270CFGBlock *
3271CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3272 AddStmtChoice asc) {
3273 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003274 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003275 MTE->getTemporary());
3276
3277 return VisitStmt(MTE, asc);
3278}
3279
Ted Kremenek5868ec62010-04-11 17:02:10 +00003280CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003281 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003282 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003283 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003284 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003285 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003286}
3287
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003288CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003289 // Objective-C fast enumeration 'for' statements:
3290 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3291 //
3292 // for ( Type newVariable in collection_expression ) { statements }
3293 //
3294 // becomes:
3295 //
3296 // prologue:
3297 // 1. collection_expression
3298 // T. jump to loop_entry
3299 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003300 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003301 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3302 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3303 // TB:
3304 // statements
3305 // T. jump to loop_entry
3306 // FB:
3307 // what comes after
3308 //
3309 // and
3310 //
3311 // Type existingItem;
3312 // for ( existingItem in expression ) { statements }
3313 //
3314 // becomes:
3315 //
Mike Stump31feda52009-07-17 01:31:16 +00003316 // the same with newVariable replaced with existingItem; the binding works
3317 // the same except that for one ObjCForCollectionStmt::getElement() returns
3318 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003319
Craig Topper25542942014-05-20 04:30:07 +00003320 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003321
Ted Kremenek9d56e642008-11-11 17:10:00 +00003322 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003323 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003324 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003325 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003326 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003327 } else
3328 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003329
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003330 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003331 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003332
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003333 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003334 ExitConditionBlock->setTerminator(S);
3335
3336 // The last statement in the block should be the ObjCForCollectionStmt, which
3337 // performs the actual binding to 'element' and determines if there are any
3338 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003339 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003340 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003341
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003342 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003343 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003344 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003345 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3346 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003347 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003348 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003349 return nullptr;
3350 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003351 }
Mike Stump31feda52009-07-17 01:31:16 +00003352
3353 // The condition block is the implicit successor for the loop body as well as
3354 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003355 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003356
Ted Kremenek9d56e642008-11-11 17:10:00 +00003357 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003358 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003359 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003360 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003361 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003362 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003363
Anna Zaks56b49752013-06-22 00:23:20 +00003364 // Add an intermediate block between the BodyBlock and the
3365 // EntryConditionBlock to represent the "loop back" transition, for looping
3366 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003367 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003368 Succ = LoopBackBlock = createBlock();
3369 LoopBackBlock->setLoopTarget(S);
Fangrui Song6907ce22018-07-30 19:24:48 +00003370
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003371 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003372 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003373
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003374 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003375
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003376 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003377 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003378 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003379 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003380 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003381 }
Mike Stump31feda52009-07-17 01:31:16 +00003382
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003383 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003384 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003385 }
Mike Stump31feda52009-07-17 01:31:16 +00003386
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003387 // Link up the condition block with the code that follows the loop.
3388 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003389 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003390
Ted Kremenek9d56e642008-11-11 17:10:00 +00003391 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003392 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003393 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003394}
3395
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003396CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3397 // Inline the body.
3398 return addStmt(S->getSubStmt());
3399 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3400}
3401
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003402CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003403 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003404
Ted Kremenek49805452009-05-02 01:49:13 +00003405 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003406 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003407
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003408 // The sync body starts its own basic block. This makes it a little easier
3409 // for diagnostic clients.
3410 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003411 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003412 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003413
Craig Topper25542942014-05-20 04:30:07 +00003414 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003415 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003416 }
Mike Stump31feda52009-07-17 01:31:16 +00003417
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003418 // Add the @synchronized to the CFG.
3419 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003420 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003421
Ted Kremenek49805452009-05-02 01:49:13 +00003422 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003423 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003424}
Mike Stump31feda52009-07-17 01:31:16 +00003425
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003426CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003427 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003428 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003429}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003430
John McCallfe96e0b2011-11-06 09:01:30 +00003431CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3432 autoCreateBlock();
3433
3434 // Add the PseudoObject as the last thing.
3435 appendStmt(Block, E);
3436
Fangrui Song6907ce22018-07-30 19:24:48 +00003437 CFGBlock *lastBlock = Block;
John McCallfe96e0b2011-11-06 09:01:30 +00003438
3439 // Before that, evaluate all of the semantics in order. In
3440 // CFG-land, that means appending them in reverse order.
3441 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3442 Expr *Semantic = E->getSemanticExpr(--i);
3443
3444 // If the semantic is an opaque value, we're being asked to bind
3445 // it to its source expression.
3446 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3447 Semantic = OVE->getSourceExpr();
3448
3449 if (CFGBlock *B = Visit(Semantic))
3450 lastBlock = B;
3451 }
3452
3453 return lastBlock;
3454}
3455
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003456CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003457 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003458
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003459 // Save local scope position because in case of condition variable ScopePos
3460 // won't be restored when traversing AST.
3461 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3462
3463 // Create local scope for possible condition variable.
3464 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003465 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003466 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003467 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003468 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003469 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003470 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003471
Mike Stump014b3ea2009-07-21 01:12:51 +00003472 // "while" is a control-flow statement. Thus we stop processing the current
3473 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003474 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003475 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003476 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003477 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003478 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003479 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003480 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003481 }
Mike Stump31feda52009-07-17 01:31:16 +00003482
Craig Topper25542942014-05-20 04:30:07 +00003483 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003484
Ted Kremenek9aae5132007-08-23 21:42:29 +00003485 // Process the loop body.
3486 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003487 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003488
Ted Kremenekb50e7162012-07-14 05:04:10 +00003489 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003490 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3491 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003492 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003493
Mike Stump31feda52009-07-17 01:31:16 +00003494 // Create an empty block to represent the transition block for looping back
3495 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003496 Succ = TransitionBlock = createBlock(false);
3497 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003498 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003499
Ted Kremenek9aae5132007-08-23 21:42:29 +00003500 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003501 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003502
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003503 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003504 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003505
3506 // If body is not a compound statement create implicit scope
3507 // and add destructors.
3508 if (!isa<CompoundStmt>(W->getBody()))
3509 addLocalScopeAndDtors(W->getBody());
3510
Ted Kremenek9aae5132007-08-23 21:42:29 +00003511 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003512 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003513
Ted Kremeneke9610502007-08-30 18:39:40 +00003514 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003515 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003516 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003517 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003518 }
3519
3520 // Because of short-circuit evaluation, the condition of the loop can span
3521 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3522 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003523 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003524
3525 do {
3526 Expr *C = W->getCond();
3527
3528 // Specially handle logical operators, which have a slightly
3529 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003530 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003531 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003532 std::tie(EntryConditionBlock, ExitConditionBlock) =
3533 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003534 break;
3535 }
3536
3537 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003538 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003539 ExitConditionBlock->setTerminator(W);
3540
3541 // Now add the actual condition to the condition block.
3542 // Because the condition itself may contain control-flow, new blocks may
3543 // be created. Thus we update "Succ" after adding the condition.
3544 Block = ExitConditionBlock;
3545 Block = EntryConditionBlock = addStmt(C);
3546
3547 // If this block contains a condition variable, add both the condition
3548 // variable and initializer to the CFG.
3549 if (VarDecl *VD = W->getConditionVariable()) {
3550 if (Expr *Init = VD->getInit()) {
3551 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003552 const DeclStmt *DS = W->getConditionVariableDeclStmt();
3553 assert(DS->isSingleDecl());
3554 findConstructionContexts(
3555 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3556 const_cast<DeclStmt *>(DS)),
3557 Init);
3558 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003559 EntryConditionBlock = addStmt(Init);
3560 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003561 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003562 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003563 }
Mike Stump31feda52009-07-17 01:31:16 +00003564
Ted Kremenekb50e7162012-07-14 05:04:10 +00003565 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003566 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003567
3568 // See if this is a known constant.
3569 const TryResult& KnownVal = tryEvaluateBool(C);
3570
Ted Kremenek30754282009-07-24 04:47:11 +00003571 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003572 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003573 // Link up the condition block with the code that follows the loop. (the
3574 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003575 addSuccessor(ExitConditionBlock,
3576 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003577 } while(false);
3578
3579 // Link up the loop-back block to the entry condition block.
3580 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003581
3582 // There can be no more statements in the condition block since we loop back
3583 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003584 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003585
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003586 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003587 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003588 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003589}
Mike Stump11289f42009-09-09 15:08:12 +00003590
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003591CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003592 // FIXME: For now we pretend that @catch and the code it contains does not
3593 // exit.
3594 return Block;
3595}
Mike Stump31feda52009-07-17 01:31:16 +00003596
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003597CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003598 // FIXME: This isn't complete. We basically treat @throw like a return
3599 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003600
Ted Kremenek0868eea2009-09-24 18:45:41 +00003601 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003602 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003603 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003604
Ted Kremenek93041ba2008-12-09 20:20:09 +00003605 // Create the new block.
3606 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003607
Ted Kremenek93041ba2008-12-09 20:20:09 +00003608 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003609 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003610
3611 // Add the statement to the block. This may create new blocks if S contains
3612 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003613 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003614}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003615
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003616CFGBlock *CFGBuilder::VisitObjCMessageExpr(ObjCMessageExpr *ME,
3617 AddStmtChoice asc) {
3618 findConstructionContextsForArguments(ME);
3619
3620 autoCreateBlock();
Artem Dergacheve1f30622018-07-31 19:46:14 +00003621 appendObjCMessage(Block, ME);
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003622
3623 return VisitChildren(ME);
3624}
3625
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003626CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003627 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003628 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003629 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003630
3631 // Create the new block.
3632 Block = createBlock(false);
3633
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003634 if (TryTerminatedBlock)
3635 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003636 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003637 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003638 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003639 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003640
3641 // Add the statement to the block. This may create new blocks if S contains
3642 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003643 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003644}
3645
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003646CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003647 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003648
Peter Szecsi999a25f2017-08-19 11:19:16 +00003649 addLoopExit(D);
3650
Mike Stump8d50b6a2009-07-21 01:27:50 +00003651 // "do...while" is a control-flow statement. Thus we stop processing the
3652 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003653 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003654 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003655 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003656 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003657 } else
3658 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003659
3660 // Because of short-circuit evaluation, the condition of the loop can span
3661 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3662 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003663 CFGBlock *ExitConditionBlock = createBlock(false);
3664 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003665
Ted Kremenek81e14852007-08-27 19:46:09 +00003666 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003667 ExitConditionBlock->setTerminator(D);
3668
3669 // Now add the actual condition to the condition block. Because the condition
3670 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003671 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003672 Block = ExitConditionBlock;
3673 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003674 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003675 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003676 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003677 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003678 }
Mike Stump31feda52009-07-17 01:31:16 +00003679
Ted Kremeneka1523a32008-02-27 07:20:00 +00003680 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003681 Succ = EntryConditionBlock;
3682
Mike Stump773582d2009-07-23 23:25:26 +00003683 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003684 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003685
Ted Kremenek9aae5132007-08-23 21:42:29 +00003686 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003687 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003688 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003689 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003690
Ted Kremenek9aae5132007-08-23 21:42:29 +00003691 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003692 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3693 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3694 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003695
Ted Kremenek9aae5132007-08-23 21:42:29 +00003696 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003697 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003698
Ted Kremenek9aae5132007-08-23 21:42:29 +00003699 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003700 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003701
Ted Kremenek9aae5132007-08-23 21:42:29 +00003702 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003703 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003704
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003705 // If body is not a compound statement create implicit scope
3706 // and add destructors.
3707 if (!isa<CompoundStmt>(D->getBody()))
3708 addLocalScopeAndDtors(D->getBody());
3709
Ted Kremenek9aae5132007-08-23 21:42:29 +00003710 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003711 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003712
Ted Kremeneke9610502007-08-30 18:39:40 +00003713 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003714 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003715 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003716 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003717 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003718 }
Mike Stump31feda52009-07-17 01:31:16 +00003719
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003720 // Add an intermediate block between the BodyBlock and the
3721 // ExitConditionBlock to represent the "loop back" transition. Create an
3722 // empty block to represent the transition block for looping back to the
3723 // head of the loop.
3724 // FIXME: Can we do this more efficiently without adding another block?
3725 Block = nullptr;
3726 Succ = BodyBlock;
3727 CFGBlock *LoopBackBlock = createBlock();
3728 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003729
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003730 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003731 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003732 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003733 else
Craig Topper25542942014-05-20 04:30:07 +00003734 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003735 }
Mike Stump31feda52009-07-17 01:31:16 +00003736
Ted Kremenek30754282009-07-24 04:47:11 +00003737 // Link up the condition block with the code that follows the loop.
3738 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003739 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003740
3741 // There can be no more statements in the body block(s) since we loop back to
3742 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003743 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003744
Ted Kremenek9aae5132007-08-23 21:42:29 +00003745 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003746 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003747 return BodyBlock;
3748}
3749
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003750CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003751 // "continue" is a control-flow statement. Thus we stop processing the
3752 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003753 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003754 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003755
Ted Kremenek9aae5132007-08-23 21:42:29 +00003756 // Now create a new block that ends with the continue statement.
3757 Block = createBlock(false);
3758 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003759
Ted Kremenek9aae5132007-08-23 21:42:29 +00003760 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003761 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003762 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003763 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003764 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003765 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003766 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003767
Ted Kremenek9aae5132007-08-23 21:42:29 +00003768 return Block;
3769}
Mike Stump11289f42009-09-09 15:08:12 +00003770
Peter Collingbournee190dee2011-03-11 19:24:49 +00003771CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3772 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003773 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003774 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003775 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003776 }
Mike Stump11289f42009-09-09 15:08:12 +00003777
Ted Kremenek93668002009-07-17 22:18:43 +00003778 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003779 CFGBlock *lastBlock = Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00003780
Ted Kremenek93668002009-07-17 22:18:43 +00003781 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003782 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003783 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003784 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003785 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003786 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003787}
Mike Stump11289f42009-09-09 15:08:12 +00003788
Ted Kremenek93668002009-07-17 22:18:43 +00003789/// VisitStmtExpr - Utility method to handle (nested) statement
3790/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003791CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003792 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003793 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003794 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003795 }
Ted Kremenek93668002009-07-17 22:18:43 +00003796 return VisitCompoundStmt(SE->getSubStmt());
3797}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003798
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003799CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003800 // "switch" is a control-flow statement. Thus we stop processing the current
3801 // block.
Craig Topper25542942014-05-20 04:30:07 +00003802 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003803
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003804 // Save local scope position because in case of condition variable ScopePos
3805 // won't be restored when traversing AST.
3806 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3807
Richard Smitha547eb22016-07-14 00:11:03 +00003808 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003809 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003810 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003811
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003812 // Create local scope for possible condition variable.
3813 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003814 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003815 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003816
Matthias Gehre351c2182017-07-12 07:04:19 +00003817 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003818
Ted Kremenek9aae5132007-08-23 21:42:29 +00003819 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003820 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003821 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003822 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003823 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003824
3825 // Save the current "switch" context.
3826 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003827 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003828 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003829
Mike Stump31feda52009-07-17 01:31:16 +00003830 // Set the "default" case to be the block after the switch statement. If the
3831 // switch statement contains a "default:", this value will be overwritten with
3832 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003833 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003834
Ted Kremenek9aae5132007-08-23 21:42:29 +00003835 // Create a new block that will contain the switch statement.
3836 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003837
Ted Kremenek9aae5132007-08-23 21:42:29 +00003838 // Now process the switch body. The code after the switch is the implicit
3839 // successor.
3840 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003841 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003842
3843 // When visiting the body, the case statements should automatically get linked
3844 // up to the switch. We also don't keep a pointer to the body, since all
3845 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003846 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003847 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003848
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003849 // For pruning unreachable case statements, save the current state
3850 // for tracking the condition value.
3851 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3852 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003853
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003854 // Determine if the switch condition can be explicitly evaluated.
3855 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003856 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003857 bool b = tryEvaluate(Terminator->getCond(), result);
3858 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003859 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003860
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003861 // If body is not a compound statement create implicit scope
3862 // and add destructors.
3863 if (!isa<CompoundStmt>(Terminator->getBody()))
3864 addLocalScopeAndDtors(Terminator->getBody());
3865
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003866 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003867 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003868 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003869 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003870 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003871
Mike Stump31feda52009-07-17 01:31:16 +00003872 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003873 // following the switch body. Moreover, take into account if all the
3874 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003875 //
3876 // Note: We add a successor to a switch that is considered covered yet has no
3877 // case statements if the enumeration has no enumerators.
3878 bool SwitchAlwaysHasSuccessor = false;
3879 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3880 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3881 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003882 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3883 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003884
Ted Kremenek81e14852007-08-27 19:46:09 +00003885 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003886 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003887 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003888 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003889
Richard Smitha547eb22016-07-14 00:11:03 +00003890 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003891 // SwitchStmt and the condition variable initialization to the CFG.
3892 if (VarDecl *VD = Terminator->getConditionVariable()) {
3893 if (Expr *Init = VD->getInit()) {
3894 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003895 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003896 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003897 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003898 }
3899 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003900
Richard Smitha547eb22016-07-14 00:11:03 +00003901 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3902 if (Stmt *Init = Terminator->getInit()) {
3903 autoCreateBlock();
3904 LastBlock = addStmt(Init);
3905 }
3906
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003907 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003908}
Fangrui Song6907ce22018-07-30 19:24:48 +00003909
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003910static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003911 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003912 const CaseStmt *CS,
3913 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003914 if (!switchCond)
3915 return true;
3916
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003917 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003918
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003919 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003920 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003921 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003922 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003923 const llvm::APSInt &condInt = switchCond->Val.getInt();
Fangrui Song6907ce22018-07-30 19:24:48 +00003924
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003925 if (condInt == lhsInt) {
3926 addCase = true;
3927 switchExclusivelyCovered = true;
3928 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003929 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003930 if (const Expr *RHS = CS->getRHS()) {
3931 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003932 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003933 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003934 addCase = true;
3935 switchExclusivelyCovered = true;
3936 }
3937 }
3938 }
3939 }
3940 else
3941 addCase = true;
3942 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003943 return addCase;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003944}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003945
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003946CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003947 // CaseStmts are essentially labels, so they are the first statement in a
3948 // block.
Craig Topper25542942014-05-20 04:30:07 +00003949 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003950
Ted Kremenek60fa6572010-08-04 23:54:30 +00003951 if (Stmt *Sub = CS->getSubStmt()) {
3952 // For deeply nested chains of CaseStmts, instead of doing a recursion
3953 // (which can blow out the stack), manually unroll and create blocks
3954 // along the way.
3955 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003956 CFGBlock *currentBlock = createBlock(false);
3957 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003958
Ted Kremenek60fa6572010-08-04 23:54:30 +00003959 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003960 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003961 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003962 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003963
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003964 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003965 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003966 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003967 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003968
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003969 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003970 CS = cast<CaseStmt>(Sub);
3971 Sub = CS->getSubStmt();
3972 }
3973
3974 addStmt(Sub);
3975 }
Mike Stump11289f42009-09-09 15:08:12 +00003976
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003977 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003978 if (!CaseBlock)
3979 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003980
3981 // Cases statements partition blocks, so this is the top of the basic block we
3982 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003983 CaseBlock->setLabel(CS);
3984
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003985 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003986 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003987
3988 // Add this block to the list of successors for the block with the switch
3989 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003990 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003991 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003992 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003993 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003994
Ted Kremenek9aae5132007-08-23 21:42:29 +00003995 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003996 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003997
Ted Kremenek60fa6572010-08-04 23:54:30 +00003998 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003999 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004000 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004001 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00004002 // This block is now the implicit successor of other blocks.
4003 Succ = CaseBlock;
4004 }
Mike Stump31feda52009-07-17 01:31:16 +00004005
Ted Kremenek60fa6572010-08-04 23:54:30 +00004006 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00004007}
Mike Stump31feda52009-07-17 01:31:16 +00004008
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004009CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00004010 if (Terminator->getSubStmt())
4011 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00004012
Ted Kremenek654c78f2008-02-13 22:05:39 +00004013 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004014
4015 if (!DefaultCaseBlock)
4016 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004017
4018 // Default statements partition blocks, so this is the top of the basic block
4019 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004020 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00004021
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004022 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004023 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00004024
Mike Stump31feda52009-07-17 01:31:16 +00004025 // Unlike case statements, we don't add the default block to the successors
4026 // for the switch statement immediately. This is done when we finish
4027 // processing the switch statement. This allows for the default case
4028 // (including a fall-through to the code after the switch statement) to always
4029 // be the last successor of a switch-terminated block.
4030
Ted Kremenek654c78f2008-02-13 22:05:39 +00004031 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004032 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004033
Ted Kremenek654c78f2008-02-13 22:05:39 +00004034 // This block is now the implicit successor of other blocks.
4035 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00004036
4037 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00004038}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004039
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004040CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
4041 // "try"/"catch" is a control-flow statement. Thus we stop processing the
4042 // current block.
Craig Topper25542942014-05-20 04:30:07 +00004043 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004044
4045 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004046 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004047 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004048 TrySuccessor = Block;
4049 } else TrySuccessor = Succ;
4050
Mike Stump0bdba6c2010-01-20 01:15:34 +00004051 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004052
4053 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00004054 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004055 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00004056 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004057
Mike Stump0bdba6c2010-01-20 01:15:34 +00004058 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004059 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
4060 // The code after the try is the implicit successor.
4061 Succ = TrySuccessor;
4062 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00004063 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00004064 HasCatchAll = true;
4065 }
Craig Topper25542942014-05-20 04:30:07 +00004066 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004067 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00004068 if (!CatchBlock)
4069 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004070 // Add this block to the list of successors for the block with the try
4071 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004072 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004073 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00004074 if (!HasCatchAll) {
4075 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004076 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00004077 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004078 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00004079 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004080
4081 // The code after the try is the implicit successor.
4082 Succ = TrySuccessor;
4083
Mike Stump845384a2010-01-20 01:30:58 +00004084 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00004085 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
4086 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00004087
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004088 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004089 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004090 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004091}
4092
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004093CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004094 // CXXCatchStmt are treated like labels, so they are the first statement in a
4095 // block.
4096
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004097 // Save local scope position because in case of exception variable ScopePos
4098 // won't be restored when traversing AST.
4099 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4100
4101 // Create local scope for possible exception variable.
4102 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004103 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004104 LocalScope::const_iterator BeginScopePos = ScopePos;
4105 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004106 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004107 }
4108
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004109 if (CS->getHandlerBlock())
4110 addStmt(CS->getHandlerBlock());
4111
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004112 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004113 if (!CatchBlock)
4114 CatchBlock = createBlock();
Fangrui Song6907ce22018-07-30 19:24:48 +00004115
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004116 // CXXCatchStmt is more than just a label. They have semantic meaning
4117 // as well, as they implicitly "initialize" the catch variable. Add
4118 // it to the CFG as a CFGElement so that the control-flow of these
4119 // semantics gets captured.
4120 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004121
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004122 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4123 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004124 CatchBlock->setLabel(CS);
4125
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004126 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004127 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004128 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004129
4130 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004131 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004132
4133 return CatchBlock;
4134}
4135
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004136CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004137 // C++0x for-range statements are specified as [stmt.ranged]:
4138 //
4139 // {
4140 // auto && __range = range-init;
4141 // for ( auto __begin = begin-expr,
4142 // __end = end-expr;
4143 // __begin != __end;
4144 // ++__begin ) {
4145 // for-range-declaration = *__begin;
4146 // statement
4147 // }
4148 // }
4149
4150 // Save local scope position before the addition of the implicit variables.
4151 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4152
4153 // Create local scopes and destructors for range, begin and end variables.
4154 if (Stmt *Range = S->getRangeStmt())
4155 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004156 if (Stmt *Begin = S->getBeginStmt())
4157 addLocalScopeForStmt(Begin);
4158 if (Stmt *End = S->getEndStmt())
4159 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004160 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004161
4162 LocalScope::const_iterator ContinueScopePos = ScopePos;
4163
4164 // "for" is a control-flow statement. Thus we stop processing the current
4165 // block.
Craig Topper25542942014-05-20 04:30:07 +00004166 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004167 if (Block) {
4168 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004169 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004170 LoopSuccessor = Block;
4171 } else
4172 LoopSuccessor = Succ;
4173
4174 // Save the current value for the break targets.
4175 // All breaks should go to the code following the loop.
4176 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4177 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4178
4179 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004180 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004181 ConditionBlock->setTerminator(S);
4182
4183 // Now add the actual condition to the condition block.
4184 if (Expr *C = S->getCond()) {
4185 Block = ConditionBlock;
4186 CFGBlock *BeginConditionBlock = addStmt(C);
4187 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004188 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004189 assert(BeginConditionBlock == ConditionBlock &&
4190 "condition block in for-range was unexpectedly complex");
4191 (void)BeginConditionBlock;
4192 }
4193
4194 // The condition block is the implicit successor for the loop body as well as
4195 // any code above the loop.
4196 Succ = ConditionBlock;
4197
4198 // See if this is a known constant.
4199 TryResult KnownVal(true);
4200
4201 if (S->getCond())
4202 KnownVal = tryEvaluateBool(S->getCond());
4203
4204 // Now create the loop body.
4205 {
4206 assert(S->getBody());
4207
4208 // Save the current values for Block, Succ, and continue targets.
4209 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4210 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4211
4212 // Generate increment code in its own basic block. This is the target of
4213 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004214 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004215 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004216 if (badCFG)
4217 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004218 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4219
4220 // The starting block for the loop increment is the block that should
4221 // represent the 'loop target' for looping back to the start of the loop.
4222 ContinueJumpTarget.block->setLoopTarget(S);
4223
4224 // Finish up the increment block and prepare to start the loop body.
4225 assert(Block);
4226 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004227 return nullptr;
4228 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004229
4230 // Add implicit scope and dtors for loop variable.
4231 addLocalScopeAndDtors(S->getLoopVarStmt());
4232
4233 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004234 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004235 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004236 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004237 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004238 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004239 return nullptr;
4240
Richard Smith02e85f32011-04-14 22:09:26 +00004241 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004242 addSuccessor(ConditionBlock,
4243 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004244 }
4245
4246 // Link up the condition block with the code that follows the loop (the
4247 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004248 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004249
4250 // Add the initialization statements.
4251 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004252 addStmt(S->getBeginStmt());
4253 addStmt(S->getEndStmt());
Richard Smith0c502d22011-04-18 15:49:25 +00004254 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004255}
4256
John McCall5d413782010-12-06 08:20:24 +00004257CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004258 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004259 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004260 // If adding implicit destructors visit the full expression for adding
4261 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004262 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004263 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004264
4265 // Full expression has to be added as CFGStmt so it will be sequenced
4266 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004267 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004268 }
4269 return Visit(E->getSubExpr(), asc);
4270}
4271
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004272CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4273 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004274 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004275 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004276 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004277
Artem Dergachev783a4572018-02-23 22:20:39 +00004278 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004279 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004280 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004281
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004282 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004283 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004284 }
4285 return Visit(E->getSubExpr(), asc);
4286}
4287
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004288CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4289 AddStmtChoice asc) {
Artem Dergachevbd880fe2018-07-31 19:39:37 +00004290 // If the constructor takes objects as arguments by value, we need to properly
4291 // construct these objects. Construction contexts we find here aren't for the
4292 // constructor C, they're for its arguments only.
4293 findConstructionContextsForArguments(C);
4294
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004295 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004296 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004297
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004298 return VisitChildren(C);
4299}
4300
Jordan Rosec9176072014-01-13 17:59:19 +00004301CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4302 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004303 autoCreateBlock();
4304 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004305
Artem Dergachev783a4572018-02-23 22:20:39 +00004306 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004307 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004308 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004309
Jordan Rosec9176072014-01-13 17:59:19 +00004310 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004311 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004312
Jordan Rosec9176072014-01-13 17:59:19 +00004313 if (BuildOpts.AddCXXNewAllocator)
4314 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004315
Jordan Rosec9176072014-01-13 17:59:19 +00004316 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004317 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004318
Jordan Rosec9176072014-01-13 17:59:19 +00004319 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4320 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004321 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004322
Jordan Rosec9176072014-01-13 17:59:19 +00004323 return Block;
4324}
Jordan Rosed2f40792013-09-03 17:00:57 +00004325
4326CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4327 AddStmtChoice asc) {
4328 autoCreateBlock();
4329 appendStmt(Block, DE);
4330 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004331 if (!DTy.isNull()) {
4332 DTy = DTy.getNonReferenceType();
4333 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4334 if (RD) {
4335 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4336 appendDeleteDtor(Block, RD, DE);
4337 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004338 }
4339
4340 return VisitChildren(DE);
4341}
4342
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004343CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4344 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004345 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004346 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004347 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004348 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004349 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004350 }
4351 return Visit(E->getSubExpr(), asc);
4352}
4353
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004354CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4355 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004356 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004357 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004358 return VisitChildren(C);
4359}
4360
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004361CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4362 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004363 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004364 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004365 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004366 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004367 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004368}
4369
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004370CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004371 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004372 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004373
Ted Kremenekeda180e22007-08-28 19:26:49 +00004374 if (!IBlock) {
4375 IBlock = createBlock(false);
4376 cfg->setIndirectGotoBlock(IBlock);
4377 }
Mike Stump31feda52009-07-17 01:31:16 +00004378
Ted Kremenekeda180e22007-08-28 19:26:49 +00004379 // IndirectGoto is a control-flow statement. Thus we stop processing the
4380 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004381 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004382 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004383
Ted Kremenekeda180e22007-08-28 19:26:49 +00004384 Block = createBlock(false);
4385 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004386 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004387 return addStmt(I->getTarget());
4388}
4389
Manuel Klimekb5616c92014-08-07 10:42:17 +00004390CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4391 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004392 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4393
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004394tryAgain:
4395 if (!E) {
4396 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004397 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004398 }
4399 switch (E->getStmtClass()) {
4400 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004401 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004402
4403 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004404 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4405 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004406
4407 case Stmt::CXXBindTemporaryExprClass:
4408 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004409 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004410
John McCallc07a0c72011-02-17 10:25:35 +00004411 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004412 case Stmt::ConditionalOperatorClass:
4413 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004414 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004415
4416 case Stmt::ImplicitCastExprClass:
4417 // For implicit cast we want BindToTemporary to be passed further.
4418 E = cast<CastExpr>(E)->getSubExpr();
4419 goto tryAgain;
4420
Manuel Klimekb0042c42014-07-30 08:34:42 +00004421 case Stmt::CXXFunctionalCastExprClass:
4422 // For functional cast we want BindToTemporary to be passed further.
4423 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4424 goto tryAgain;
4425
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004426 case Stmt::ParenExprClass:
4427 E = cast<ParenExpr>(E)->getSubExpr();
4428 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004429
Manuel Klimekb0042c42014-07-30 08:34:42 +00004430 case Stmt::MaterializeTemporaryExprClass: {
4431 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4432 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4433 SmallVector<const Expr *, 2> CommaLHSs;
4434 SmallVector<SubobjectAdjustment, 2> Adjustments;
4435 // Find the expression whose lifetime needs to be extended.
4436 E = const_cast<Expr *>(
4437 cast<MaterializeTemporaryExpr>(E)
4438 ->GetTemporaryExpr()
4439 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4440 // Visit the skipped comma operator left-hand sides for other temporaries.
4441 for (const Expr *CommaLHS : CommaLHSs) {
4442 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004443 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004444 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004445 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004446 }
Richard Smith4137af22014-07-27 05:12:49 +00004447
4448 case Stmt::BlockExprClass:
4449 // Don't recurse into blocks; their subexpressions don't get evaluated
4450 // here.
4451 return Block;
4452
4453 case Stmt::LambdaExprClass: {
4454 // For lambda expressions, only recurse into the capture initializers,
4455 // and not the body.
4456 auto *LE = cast<LambdaExpr>(E);
4457 CFGBlock *B = Block;
4458 for (Expr *Init : LE->capture_inits()) {
Richard Smith7ed5fb22018-07-27 17:13:18 +00004459 if (Init) {
4460 if (CFGBlock *R = VisitForTemporaryDtors(
4461 Init, /*BindToTemporary=*/false, Context))
4462 B = R;
4463 }
Richard Smith4137af22014-07-27 05:12:49 +00004464 }
4465 return B;
4466 }
4467
4468 case Stmt::CXXDefaultArgExprClass:
4469 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4470 goto tryAgain;
4471
4472 case Stmt::CXXDefaultInitExprClass:
4473 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4474 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004475 }
4476}
4477
Manuel Klimekb5616c92014-08-07 10:42:17 +00004478CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4479 TempDtorContext &Context) {
4480 if (isa<LambdaExpr>(E)) {
4481 // Do not visit the children of lambdas; they have their own CFGs.
4482 return Block;
4483 }
4484
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004485 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004486 // order that they will appear in the CFG. Because the CFG is built
4487 // bottom-up, this means we visit them in their natural order, which
4488 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004489 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004490 for (Stmt *Child : E->children())
4491 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004492 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004493 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004494
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004495 return B;
4496}
4497
Manuel Klimekb5616c92014-08-07 10:42:17 +00004498CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4499 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004500 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004501 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004502 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4503 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4504 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004505
Manuel Klimekedf925b92014-08-07 18:44:19 +00004506 // We do not know at CFG-construction time whether the right-hand-side was
4507 // executed, thus we add a branch node that depends on the temporary
4508 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004509 TempDtorContext RHSContext(
4510 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004511 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004512 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004513
Manuel Klimekb5616c92014-08-07 10:42:17 +00004514 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004515 }
4516
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004517 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004518 // For assignment operator (=) LHS expression is visited
4519 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004520 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4521 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004522 return LHSBlock ? LHSBlock : RHSBlock;
4523 }
4524
4525 // For any other binary operator RHS expression is visited before
4526 // LHS expression (order of children). For destructors visit them in reverse
4527 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004528 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4529 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004530 return RHSBlock ? RHSBlock : LHSBlock;
4531}
4532
4533CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004534 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004535 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004536 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004537 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004538 // If lifetime of temporary is not prolonged (by assigning to constant
4539 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004540
Chandler Carruthad747252011-09-13 06:09:01 +00004541 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004542
Richard Trieu95a192a2015-05-28 00:14:02 +00004543 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004544 // If the destructor is marked as a no-return destructor, we need to
4545 // create a new block for the destructor which does not have as a
4546 // successor anything built thus far. Control won't flow out of this
4547 // block.
4548 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004549 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004550 } else if (Context.needsTempDtorBranch()) {
4551 // If we need to introduce a branch, we add a new block that we will hook
4552 // up to a decision block later.
4553 if (B) Succ = B;
4554 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004555 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004556 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004557 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004558 if (Context.needsTempDtorBranch()) {
4559 Context.setDecisionPoint(Succ, E);
4560 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004561 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004562
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004563 B = Block;
4564 }
4565 return B;
4566}
4567
Manuel Klimekb5616c92014-08-07 10:42:17 +00004568void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4569 CFGBlock *FalseSucc) {
4570 if (!Context.TerminatorExpr) {
4571 // If no temporary was found, we do not need to insert a decision point.
4572 return;
4573 }
4574 assert(Context.TerminatorExpr);
4575 CFGBlock *Decision = createBlock(false);
4576 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004577 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004578 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004579 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004580 Block = Decision;
4581}
4582
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004583CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004584 AbstractConditionalOperator *E, bool BindToTemporary,
4585 TempDtorContext &Context) {
4586 VisitForTemporaryDtors(E->getCond(), false, Context);
4587 CFGBlock *ConditionBlock = Block;
4588 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004589 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004590 TryResult NegatedVal = ConditionVal;
4591 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004592
Manuel Klimekdeb02622014-08-08 07:37:13 +00004593 TempDtorContext TrueContext(
4594 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004595 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004596 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004597
Manuel Klimekb5616c92014-08-07 10:42:17 +00004598 Block = ConditionBlock;
4599 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004600 TempDtorContext FalseContext(
4601 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004602 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004603
Manuel Klimekb5616c92014-08-07 10:42:17 +00004604 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004605 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004606 } else if (TrueContext.TerminatorExpr) {
4607 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004608 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004609 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004610 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004611 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004612 return Block;
4613}
4614
Mike Stump31feda52009-07-17 01:31:16 +00004615/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4616/// no successors or predecessors. If this is the first block created in the
4617/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004618CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004619 bool first_block = begin() == end();
4620
4621 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004622 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004623 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004624 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004625
4626 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004627 if (first_block)
4628 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004629
4630 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004631 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004632}
4633
David Blaikiee90195c2014-08-29 18:53:26 +00004634/// buildCFG - Constructs a CFG from an AST.
4635std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4636 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004637 CFGBuilder Builder(C, BO);
4638 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004639}
4640
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004641const CXXDestructorDecl *
4642CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004643 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004644 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004645 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004646 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004647 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004648 case CFGElement::Statement:
4649 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004650 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004651 case CFGElement::ScopeBegin:
4652 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004653 llvm_unreachable("getDestructorDecl should only be used with "
4654 "ImplicitDtors");
4655 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004656 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004657 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004658
4659 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4660 //
4661 // Lifetime-extending constructs are handled here. This works for a single
4662 // temporary in an initializer expression.
4663 if (ty->isReferenceType()) {
4664 if (const Expr *Init = var->getInit()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00004665 ty = getReferenceInitTemporaryType(Init);
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004666 }
4667 }
4668
Ted Kremeneke7d78882012-03-19 23:48:41 +00004669 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004670 ty = arrayType->getElementType();
4671 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004672 const RecordType *recordType = ty->getAs<RecordType>();
4673 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004674 cast<CXXRecordDecl>(recordType->getDecl());
Fangrui Song6907ce22018-07-30 19:24:48 +00004675 return classDecl->getDestructor();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004676 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004677 case CFGElement::DeleteDtor: {
4678 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4679 QualType DTy = DE->getDestroyedType();
4680 DTy = DTy.getNonReferenceType();
4681 const CXXRecordDecl *classDecl =
4682 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4683 return classDecl->getDestructor();
4684 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004685 case CFGElement::TemporaryDtor: {
4686 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004687 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004688 const CXXTemporary *temp = bindExpr->getTemporary();
4689 return temp->getDestructor();
4690 }
4691 case CFGElement::BaseDtor:
4692 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004693 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004694 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004695 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004696 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004697}
4698
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004699bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004700 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4701 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004702 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004703}
4704
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004705//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004706// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004707//===----------------------------------------------------------------------===//
4708
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004709CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004710 : ReachableBlock(IsReachable ? B : nullptr),
4711 UnreachableBlock(!IsReachable ? B : nullptr,
4712 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004713
4714CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004715 : ReachableBlock(B),
4716 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4717 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004718
4719void CFGBlock::addSuccessor(AdjacentBlock Succ,
4720 BumpVectorContext &C) {
4721 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004722 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004723
4724 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004725 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004726
4727 Succs.push_back(Succ, C);
4728}
4729
Ted Kremenekb0371852010-09-09 00:06:04 +00004730bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004731 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004732 if (F.IgnoreNullPredecessors && !From)
4733 return true;
4734
4735 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004736 // If the 'To' has no label or is labeled but the label isn't a
4737 // CaseStmt then filter this edge.
4738 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004739 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004740 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004741 const Stmt *L = To->getLabel();
4742 if (!L || !isa<CaseStmt>(L))
4743 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004744 }
4745 }
4746 }
4747
4748 return false;
4749}
4750
4751//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004752// CFG pretty printing
4753//===----------------------------------------------------------------------===//
4754
Ted Kremenek7e776b12007-08-22 18:22:34 +00004755namespace {
4756
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004757class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004758 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4759 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4760
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004761 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004762 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004763 signed currentBlock = 0;
4764 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004765 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004766
Eugene Zelenko38c70522017-12-07 21:55:09 +00004767public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004768 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004769 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004770 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4771 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004772 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Fangrui Song6907ce22018-07-30 19:24:48 +00004773 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004774 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4775 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004776 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004777 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004778
Ted Kremenek96a7a592011-03-01 03:15:10 +00004779 switch (stmt->getStmtClass()) {
4780 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004781 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4782 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004783 case Stmt::IfStmtClass: {
4784 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4785 if (var)
4786 DeclMap[var] = P;
4787 break;
4788 }
4789 case Stmt::ForStmtClass: {
4790 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4791 if (var)
4792 DeclMap[var] = P;
4793 break;
4794 }
4795 case Stmt::WhileStmtClass: {
4796 const VarDecl *var =
4797 cast<WhileStmt>(stmt)->getConditionVariable();
4798 if (var)
4799 DeclMap[var] = P;
4800 break;
4801 }
4802 case Stmt::SwitchStmtClass: {
4803 const VarDecl *var =
4804 cast<SwitchStmt>(stmt)->getConditionVariable();
4805 if (var)
4806 DeclMap[var] = P;
4807 break;
4808 }
4809 case Stmt::CXXCatchStmtClass: {
4810 const VarDecl *var =
4811 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4812 if (var)
4813 DeclMap[var] = P;
4814 break;
4815 }
4816 default:
4817 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004818 }
4819 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004820 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004821 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004822 }
Mike Stump31feda52009-07-17 01:31:16 +00004823
Eugene Zelenko38c70522017-12-07 21:55:09 +00004824 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004825
Chris Lattnerc61089a2009-06-30 01:26:17 +00004826 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004827 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004828 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004829
Craig Topperb45acb82014-03-14 06:02:07 +00004830 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004831 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004832
4833 if (I == StmtMap.end())
4834 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004835
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004836 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004837 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004838 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004839 }
Mike Stump31feda52009-07-17 01:31:16 +00004840
Ted Kremenek60983dc2010-01-19 20:52:05 +00004841 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004842 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004843 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004844
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004845 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004846 DeclMapTy::iterator I = DeclMap.find(D);
4847
4848 if (I == DeclMap.end())
4849 return false;
4850
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004851 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004852 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004853 return false;
4854 }
4855
4856 OS << "[B" << I->second.first << "." << I->second.second << "]";
4857 return true;
4858 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004859};
4860
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004861class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004862 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004863 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004864 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004865 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004866
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004867public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004868 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004869 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004870 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004871 this->Policy.IncludeNewlines = false;
4872 }
Mike Stump31feda52009-07-17 01:31:16 +00004873
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004874 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004875 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004876 if (Stmt *C = I->getCond())
4877 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004878 }
Mike Stump31feda52009-07-17 01:31:16 +00004879
Ted Kremenek9aae5132007-08-23 21:42:29 +00004880 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004881 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004882 Terminator->printPretty(OS, Helper, Policy);
4883 }
4884
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004885 void VisitDeclStmt(DeclStmt *DS) {
4886 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4887 OS << "static init " << VD->getName();
4888 }
4889
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004890 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004891 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004892 if (F->getInit())
4893 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004894 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004895 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004896 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004897 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004898 if (F->getInc())
4899 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004900 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004901 }
Mike Stump31feda52009-07-17 01:31:16 +00004902
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004903 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004904 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004905 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004906 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004907 }
Mike Stump31feda52009-07-17 01:31:16 +00004908
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004909 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004910 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004911 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004912 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004913 }
Mike Stump31feda52009-07-17 01:31:16 +00004914
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004915 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004916 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004917 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004918 }
Mike Stump31feda52009-07-17 01:31:16 +00004919
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004920 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004921 OS << "try ...";
4922 }
4923
Nico Weber699670e2017-08-23 15:33:16 +00004924 void VisitSEHTryStmt(SEHTryStmt *CS) {
4925 OS << "__try ...";
4926 }
4927
John McCallc07a0c72011-02-17 10:25:35 +00004928 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004929 if (Stmt *Cond = C->getCond())
4930 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004931 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004932 }
Mike Stump31feda52009-07-17 01:31:16 +00004933
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004934 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004935 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004936 if (Stmt *Cond = C->getCond())
4937 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004938 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004939 }
Mike Stump31feda52009-07-17 01:31:16 +00004940
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004941 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004942 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004943 if (Stmt *T = I->getTarget())
4944 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004945 }
Mike Stump31feda52009-07-17 01:31:16 +00004946
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004947 void VisitBinaryOperator(BinaryOperator* B) {
4948 if (!B->isLogicalOp()) {
4949 VisitExpr(B);
4950 return;
4951 }
Mike Stump31feda52009-07-17 01:31:16 +00004952
Richard Trieuddd01ce2014-06-09 22:53:25 +00004953 if (B->getLHS())
4954 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004955
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004956 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004957 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004958 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004959 return;
John McCalle3027922010-08-25 11:45:40 +00004960 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004961 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004962 return;
4963 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004964 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004965 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004966 }
Mike Stump31feda52009-07-17 01:31:16 +00004967
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004968 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004969 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004970 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004971
4972public:
4973 void print(CFGTerminator T) {
4974 if (T.isTemporaryDtorsBranch())
4975 OS << "(Temp Dtor) ";
4976 Visit(T.getStmt());
4977 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004978};
Eugene Zelenko38c70522017-12-07 21:55:09 +00004979
4980} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00004981
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004982static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
4983 const CXXCtorInitializer *I) {
4984 if (I->isBaseInitializer())
4985 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
4986 else if (I->isDelegatingInitializer())
4987 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
4988 else
4989 OS << I->getAnyMember()->getName();
4990 OS << "(";
4991 if (Expr *IE = I->getInit())
4992 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
4993 OS << ")";
4994
4995 if (I->isBaseInitializer())
4996 OS << " (Base initializer)";
4997 else if (I->isDelegatingInitializer())
4998 OS << " (Delegating initializer)";
4999 else
5000 OS << " (Member initializer)";
5001}
5002
Artem Dergachev1527dec2018-03-12 23:12:40 +00005003static void print_construction_context(raw_ostream &OS,
5004 StmtPrinterHelper &Helper,
5005 const ConstructionContext *CC) {
Artem Dergachevff267df2018-06-28 00:04:54 +00005006 SmallVector<const Stmt *, 3> Stmts;
Artem Dergachev1527dec2018-03-12 23:12:40 +00005007 switch (CC->getKind()) {
Artem Dergachev922455f2018-03-22 22:02:38 +00005008 case ConstructionContext::SimpleConstructorInitializerKind: {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005009 OS << ", ";
Artem Dergachev922455f2018-03-22 22:02:38 +00005010 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC);
5011 print_initializer(OS, Helper, SICC->getCXXCtorInitializer());
Artem Dergacheva657a322018-07-31 20:45:53 +00005012 return;
Artem Dergachev922455f2018-03-22 22:02:38 +00005013 }
5014 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: {
5015 OS << ", ";
5016 const auto *CICC =
5017 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC);
5018 print_initializer(OS, Helper, CICC->getCXXCtorInitializer());
Artem Dergachevff267df2018-06-28 00:04:54 +00005019 Stmts.push_back(CICC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005020 break;
5021 }
5022 case ConstructionContext::SimpleVariableKind: {
Artem Dergachev317291e2018-03-22 21:37:39 +00005023 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005024 Stmts.push_back(SDSCC->getDeclStmt());
Artem Dergachev317291e2018-03-22 21:37:39 +00005025 break;
5026 }
5027 case ConstructionContext::CXX17ElidedCopyVariableKind: {
5028 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005029 Stmts.push_back(CDSCC->getDeclStmt());
5030 Stmts.push_back(CDSCC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005031 break;
5032 }
5033 case ConstructionContext::NewAllocatedObjectKind: {
5034 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005035 Stmts.push_back(NECC->getCXXNewExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005036 break;
5037 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005038 case ConstructionContext::SimpleReturnedValueKind: {
5039 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005040 Stmts.push_back(RSCC->getReturnStmt());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005041 break;
5042 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005043 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: {
5044 const auto *RSCC =
5045 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005046 Stmts.push_back(RSCC->getReturnStmt());
5047 Stmts.push_back(RSCC->getCXXBindTemporaryExpr());
Artem Dergachev317291e2018-03-22 21:37:39 +00005048 break;
5049 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005050 case ConstructionContext::SimpleTemporaryObjectKind: {
5051 const auto *TOCC = cast<SimpleTemporaryObjectConstructionContext>(CC);
5052 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5053 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5054 break;
5055 }
5056 case ConstructionContext::ElidedTemporaryObjectKind: {
5057 const auto *TOCC = cast<ElidedTemporaryObjectConstructionContext>(CC);
5058 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5059 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5060 Stmts.push_back(TOCC->getConstructorAfterElision());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005061 break;
5062 }
Artem Dergacheva657a322018-07-31 20:45:53 +00005063 case ConstructionContext::ArgumentKind: {
5064 const auto *ACC = cast<ArgumentConstructionContext>(CC);
5065 if (const Stmt *BTE = ACC->getCXXBindTemporaryExpr()) {
5066 OS << ", ";
5067 Helper.handledStmt(const_cast<Stmt *>(BTE), OS);
5068 }
5069 OS << ", ";
5070 Helper.handledStmt(const_cast<Expr *>(ACC->getCallLikeExpr()), OS);
5071 OS << "+" << ACC->getIndex();
5072 return;
5073 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005074 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005075 for (auto I: Stmts)
5076 if (I) {
5077 OS << ", ";
5078 Helper.handledStmt(const_cast<Stmt *>(I), OS);
5079 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005080}
5081
Aaron Ballmanff924b02013-11-18 20:11:50 +00005082static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00005083 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00005084 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
5085 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00005086 assert(S != nullptr && "Expecting non-null Stmt");
5087
Aaron Ballmanff924b02013-11-18 20:11:50 +00005088 // special printing for statement-expressions.
5089 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
5090 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00005091
Benjamin Kramer5733e352015-07-18 17:09:36 +00005092 auto Children = Sub->children();
5093 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005094 OS << "({ ... ; ";
5095 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
5096 OS << " })\n";
5097 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005098 }
5099 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00005100 // special printing for comma expressions.
5101 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
5102 if (B->getOpcode() == BO_Comma) {
5103 OS << "... , ";
5104 Helper.handledStmt(B->getRHS(),OS);
5105 OS << '\n';
5106 return;
5107 }
5108 }
5109 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00005110
Artem Dergachev1527dec2018-03-12 23:12:40 +00005111 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
5112 if (isa<CXXOperatorCallExpr>(S))
5113 OS << " (OperatorCall)";
5114 OS << " (CXXRecordTypedCall";
5115 print_construction_context(OS, Helper, VTC->getConstructionContext());
5116 OS << ")";
5117 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005118 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005119 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005120 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005121 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005122 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005123 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005124 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00005125 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005126 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005127 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00005128 OS << " (" << CE->getStmtClassName() << ", "
5129 << CE->getCastKindName()
5130 << ", " << CE->getType().getAsString()
5131 << ")";
5132 }
Mike Stump31feda52009-07-17 01:31:16 +00005133
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005134 // Expressions need a newline.
5135 if (isa<Expr>(S))
5136 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005137 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005138 print_initializer(OS, Helper, IE->getInitializer());
5139 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005140 } else if (Optional<CFGAutomaticObjDtor> DE =
5141 E.getAs<CFGAutomaticObjDtor>()) {
5142 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005143 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005144
Artem Dergacheva25809f2018-06-04 18:56:25 +00005145 ASTContext &ACtx = VD->getASTContext();
5146 QualType T = VD->getType();
5147 if (T->isReferenceType())
5148 T = getReferenceInitTemporaryType(VD->getInit(), nullptr);
5149 if (const ArrayType *AT = ACtx.getAsArrayType(T))
5150 T = ACtx.getBaseElementType(AT);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005151
5152 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
5153 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00005154 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
5155 const VarDecl *VD = DE->getVarDecl();
5156 Helper.handleDecl(VD, OS);
5157
5158 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00005159 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
5160 const Stmt *LoopStmt = LE->getLoopStmt();
5161 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005162 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
5163 OS << "CFGScopeBegin(";
5164 if (const VarDecl *VD = SB->getVarDecl())
5165 OS << VD->getQualifiedNameAsString();
5166 OS << ")\n";
5167 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
5168 OS << "CFGScopeEnd(";
5169 if (const VarDecl *VD = SE->getVarDecl())
5170 OS << VD->getQualifiedNameAsString();
5171 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00005172 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
5173 OS << "CFGNewAllocator(";
5174 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
5175 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5176 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00005177 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
5178 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
5179 if (!RD)
5180 return;
5181 CXXDeleteExpr *DelExpr =
5182 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005183 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005184 OS << "->~" << RD->getName().str() << "()";
5185 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005186 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5187 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005188 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005189 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005190 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5191 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005192 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005193 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005194 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005195 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005196 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5197 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005198 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005199 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005200 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005201 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005202}
Mike Stump31feda52009-07-17 01:31:16 +00005203
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005204static void print_block(raw_ostream &OS, const CFG* cfg,
5205 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005206 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005207 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005208 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005209
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005210 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005211 if (ShowColors)
5212 OS.changeColor(raw_ostream::YELLOW, true);
Fangrui Song6907ce22018-07-30 19:24:48 +00005213
Ted Kremenek72be32a2011-12-22 23:33:52 +00005214 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005215
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005216 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005217 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005218 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005219 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005220 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005221 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005222 else if (B.hasNoReturnElement())
5223 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005224 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005225 OS << "]\n";
Fangrui Song6907ce22018-07-30 19:24:48 +00005226
Ted Kremenek72be32a2011-12-22 23:33:52 +00005227 if (ShowColors)
5228 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005229
Ted Kremenek71eca012007-08-29 23:20:49 +00005230 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005231 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005232 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005233 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005234
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005235 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005236 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005237 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005238 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005239 if (C->getLHS())
5240 C->getLHS()->printPretty(OS, &Helper,
5241 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005242 if (C->getRHS()) {
5243 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005244 C->getRHS()->printPretty(OS, &Helper,
5245 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005246 }
Mike Stump92244b02010-01-19 22:00:14 +00005247 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005248 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005249 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005250 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005251 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005252 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005253 0);
5254 else
5255 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005256 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005257 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5258 OS << "__except (";
5259 ES->getFilterExpr()->printPretty(OS, &Helper,
5260 PrintingPolicy(Helper.getLangOpts()), 0);
5261 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005262 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005263 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005264
Ted Kremenek71eca012007-08-29 23:20:49 +00005265 OS << ":\n";
5266 }
Mike Stump31feda52009-07-17 01:31:16 +00005267
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005268 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005269 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005270
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005271 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5272 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005273 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005274 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005275 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005276
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005277 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005278
Aaron Ballmanff924b02013-11-18 20:11:50 +00005279 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005280
Ted Kremenek72be32a2011-12-22 23:33:52 +00005281 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005282 }
Mike Stump31feda52009-07-17 01:31:16 +00005283
Ted Kremenek71eca012007-08-29 23:20:49 +00005284 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005285 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005286 if (ShowColors)
5287 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005288
Ted Kremenek72be32a2011-12-22 23:33:52 +00005289 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005290
Aaron Ballmanff924b02013-11-18 20:11:50 +00005291 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005292
Aaron Ballmanff924b02013-11-18 20:11:50 +00005293 PrintingPolicy PP(Helper.getLangOpts());
5294 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005295 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005296 OS << '\n';
Fangrui Song6907ce22018-07-30 19:24:48 +00005297
Ted Kremenek72be32a2011-12-22 23:33:52 +00005298 if (ShowColors)
5299 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005300 }
Mike Stump31feda52009-07-17 01:31:16 +00005301
Ted Kremenek71eca012007-08-29 23:20:49 +00005302 if (print_edges) {
5303 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005304 if (!B.pred_empty()) {
5305 const raw_ostream::Colors Color = raw_ostream::BLUE;
5306 if (ShowColors)
5307 OS.changeColor(Color);
5308 OS << " Preds " ;
5309 if (ShowColors)
5310 OS.resetColor();
5311 OS << '(' << B.pred_size() << "):";
5312 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005313
Ted Kremenek72be32a2011-12-22 23:33:52 +00005314 if (ShowColors)
5315 OS.changeColor(Color);
Fangrui Song6907ce22018-07-30 19:24:48 +00005316
Ted Kremenek72be32a2011-12-22 23:33:52 +00005317 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5318 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005319 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005320 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005321
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005322 CFGBlock *B = *I;
5323 bool Reachable = true;
5324 if (!B) {
5325 Reachable = false;
5326 B = I->getPossiblyUnreachableBlock();
5327 }
5328
5329 OS << " B" << B->getBlockID();
5330 if (!Reachable)
5331 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005332 }
Fangrui Song6907ce22018-07-30 19:24:48 +00005333
Ted Kremenek72be32a2011-12-22 23:33:52 +00005334 if (ShowColors)
5335 OS.resetColor();
5336
5337 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005338 }
Mike Stump31feda52009-07-17 01:31:16 +00005339
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005340 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005341 if (!B.succ_empty()) {
5342 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5343 if (ShowColors)
5344 OS.changeColor(Color);
5345 OS << " Succs ";
5346 if (ShowColors)
5347 OS.resetColor();
5348 OS << '(' << B.succ_size() << "):";
5349 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005350
Ted Kremenek72be32a2011-12-22 23:33:52 +00005351 if (ShowColors)
5352 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005353
Ted Kremenek72be32a2011-12-22 23:33:52 +00005354 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5355 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005356 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005357 OS << "\n ";
5358
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005359 CFGBlock *B = *I;
5360
5361 bool Reachable = true;
5362 if (!B) {
5363 Reachable = false;
5364 B = I->getPossiblyUnreachableBlock();
5365 }
5366
5367 if (B) {
5368 OS << " B" << B->getBlockID();
5369 if (!Reachable)
5370 OS << "(Unreachable)";
5371 }
5372 else {
5373 OS << " NULL";
5374 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005375 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005376
Ted Kremenek72be32a2011-12-22 23:33:52 +00005377 if (ShowColors)
5378 OS.resetColor();
5379 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005380 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005381 }
Mike Stump31feda52009-07-17 01:31:16 +00005382}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005383
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005384/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005385void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5386 print(llvm::errs(), LO, ShowColors);
5387}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005388
5389/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005390void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005391 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005392
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005393 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005394 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005395
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005396 // Iterate through the CFGBlocks and print them one by one.
5397 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5398 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005399 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005400 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005401
Aaron Ballmanff924b02013-11-18 20:11:50 +00005402 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005403 }
Mike Stump31feda52009-07-17 01:31:16 +00005404
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005405 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005406 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005407 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005408 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005409}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005410
5411/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005412void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5413 bool ShowColors) const {
5414 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005415}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005416
Yaron Kerencdae9412016-01-29 19:38:18 +00005417LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005418 dump(getParent(), LangOptions(), false);
5419}
5420
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005421/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5422/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005423void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005424 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005425 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005426 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005427 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005428}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005429
Ted Kremenek15647632008-01-30 23:02:42 +00005430/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005431void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005432 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005433 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005434 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005435}
5436
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005437Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00005438 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005439 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005440 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005441
Craig Topper25542942014-05-20 04:30:07 +00005442 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005443
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005444 switch (Terminator->getStmtClass()) {
5445 default:
5446 break;
Mike Stump31feda52009-07-17 01:31:16 +00005447
Jordan Rosecf10ea82013-06-06 21:53:45 +00005448 case Stmt::CXXForRangeStmtClass:
5449 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5450 break;
5451
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005452 case Stmt::ForStmtClass:
5453 E = cast<ForStmt>(Terminator)->getCond();
5454 break;
Mike Stump31feda52009-07-17 01:31:16 +00005455
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005456 case Stmt::WhileStmtClass:
5457 E = cast<WhileStmt>(Terminator)->getCond();
5458 break;
Mike Stump31feda52009-07-17 01:31:16 +00005459
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005460 case Stmt::DoStmtClass:
5461 E = cast<DoStmt>(Terminator)->getCond();
5462 break;
Mike Stump31feda52009-07-17 01:31:16 +00005463
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005464 case Stmt::IfStmtClass:
5465 E = cast<IfStmt>(Terminator)->getCond();
5466 break;
Mike Stump31feda52009-07-17 01:31:16 +00005467
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005468 case Stmt::ChooseExprClass:
5469 E = cast<ChooseExpr>(Terminator)->getCond();
5470 break;
Mike Stump31feda52009-07-17 01:31:16 +00005471
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005472 case Stmt::IndirectGotoStmtClass:
5473 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5474 break;
Mike Stump31feda52009-07-17 01:31:16 +00005475
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005476 case Stmt::SwitchStmtClass:
5477 E = cast<SwitchStmt>(Terminator)->getCond();
5478 break;
Mike Stump31feda52009-07-17 01:31:16 +00005479
John McCallc07a0c72011-02-17 10:25:35 +00005480 case Stmt::BinaryConditionalOperatorClass:
5481 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5482 break;
5483
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005484 case Stmt::ConditionalOperatorClass:
5485 E = cast<ConditionalOperator>(Terminator)->getCond();
5486 break;
Mike Stump31feda52009-07-17 01:31:16 +00005487
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005488 case Stmt::BinaryOperatorClass: // '&&' and '||'
5489 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005490 break;
Mike Stump31feda52009-07-17 01:31:16 +00005491
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005492 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005493 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005494 }
Mike Stump31feda52009-07-17 01:31:16 +00005495
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005496 if (!StripParens)
5497 return E;
5498
Craig Topper25542942014-05-20 04:30:07 +00005499 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005500}
5501
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005502//===----------------------------------------------------------------------===//
5503// CFG Graphviz Visualization
5504//===----------------------------------------------------------------------===//
5505
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005506#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005507static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005508#endif
5509
Chris Lattnerc61089a2009-06-30 01:26:17 +00005510void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005511#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005512 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005513 GraphHelper = &H;
5514 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005515 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005516#endif
5517}
5518
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005519namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005520
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005521template<>
5522struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005523 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005524
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005525 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005526#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005527 std::string OutSStr;
5528 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005529 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005530 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005531
5532 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5533
5534 // Process string output to make it nicer...
5535 for (unsigned i = 0; i != OutStr.length(); ++i)
5536 if (OutStr[i] == '\n') { // Left justify
5537 OutStr[i] = '\\';
5538 OutStr.insert(OutStr.begin()+i+1, 'l');
5539 }
Mike Stump31feda52009-07-17 01:31:16 +00005540
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005541 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005542#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005543 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005544#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005545 }
5546};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005547
5548} // namespace llvm