blob: b02fbe10712b04c59dddac6d5f74b8acfe19c9a5 [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;
148
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;
282
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) {}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000369
370 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;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000495
496 // State to track for building switch statements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000497 bool switchExclusivelyCovered = false;
498 Expr::EvalResult *switchCond = nullptr;
Ted Kremeneka099c592011-03-10 03:50:34 +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);
519
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);
John McCallfe96e0b2011-11-06 09:01:30 +0000572 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E);
Ted Kremenek6f400242012-07-14 05:04:01 +0000573 CFGBlock *VisitReturnStmt(ReturnStmt *R);
Nico Weber699670e2017-08-23 15:33:16 +0000574 CFGBlock *VisitSEHExceptStmt(SEHExceptStmt *S);
575 CFGBlock *VisitSEHFinallyStmt(SEHFinallyStmt *S);
576 CFGBlock *VisitSEHLeaveStmt(SEHLeaveStmt *S);
577 CFGBlock *VisitSEHTryStmt(SEHTryStmt *S);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000578 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000579 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000580 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
581 AddStmtChoice asc);
Zhanyong Wan6dace612010-11-22 08:45:56 +0000582 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000583 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000584
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000585 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd);
586 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000587 CFGBlock *VisitChildren(Stmt *S);
Ted Kremeneke2499842012-04-12 20:03:44 +0000588 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc);
Mike Stump48871a22009-07-17 01:04:31 +0000589
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000590 void maybeAddScopeBeginForVarDecl(CFGBlock *B, const VarDecl *VD,
591 const Stmt *S) {
592 if (ScopePos && (VD == ScopePos.getFirstVarInScope()))
593 appendScopeBegin(B, VD, S);
594 }
595
Manuel Klimekb5616c92014-08-07 10:42:17 +0000596 /// When creating the CFG for temporary destructors, we want to mirror the
597 /// branch structure of the corresponding constructor calls.
598 /// Thus, while visiting a statement for temporary destructors, we keep a
599 /// context to keep track of the following information:
600 /// - whether a subexpression is executed unconditionally
601 /// - if a subexpression is executed conditionally, the first
602 /// CXXBindTemporaryExpr we encounter in that subexpression (which
603 /// corresponds to the last temporary destructor we have to call for this
604 /// subexpression) and the CFG block at that point (which will become the
605 /// successor block when inserting the decision point).
606 ///
607 /// That way, we can build the branch structure for temporary destructors as
608 /// follows:
609 /// 1. If a subexpression is executed unconditionally, we add the temporary
610 /// destructor calls to the current block.
611 /// 2. If a subexpression is executed conditionally, when we encounter a
612 /// CXXBindTemporaryExpr:
613 /// a) If it is the first temporary destructor call in the subexpression,
614 /// we remember the CXXBindTemporaryExpr and the current block in the
615 /// TempDtorContext; we start a new block, and insert the temporary
616 /// destructor call.
617 /// b) Otherwise, add the temporary destructor call to the current block.
618 /// 3. When we finished visiting a conditionally executed subexpression,
619 /// and we found at least one temporary constructor during the visitation
620 /// (2.a has executed), we insert a decision block that uses the
621 /// CXXBindTemporaryExpr as terminator, and branches to the current block
622 /// if the CXXBindTemporaryExpr was marked executed, and otherwise
623 /// branches to the stored successor.
624 struct TempDtorContext {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000625 TempDtorContext() = default;
Manuel Klimekdeb02622014-08-08 07:37:13 +0000626 TempDtorContext(TryResult KnownExecuted)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000627 : IsConditional(true), KnownExecuted(KnownExecuted) {}
Manuel Klimekb5616c92014-08-07 10:42:17 +0000628
629 /// Returns whether we need to start a new branch for a temporary destructor
Eric Christopher2c4555a2015-06-19 01:52:53 +0000630 /// call. This is the case when the temporary destructor is
Manuel Klimekb5616c92014-08-07 10:42:17 +0000631 /// conditionally executed, and it is the first one we encounter while
632 /// visiting a subexpression - other temporary destructors at the same level
633 /// will be added to the same block and are executed under the same
634 /// condition.
635 bool needsTempDtorBranch() const {
636 return IsConditional && !TerminatorExpr;
637 }
638
639 /// Remember the successor S of a temporary destructor decision branch for
640 /// the corresponding CXXBindTemporaryExpr E.
641 void setDecisionPoint(CFGBlock *S, CXXBindTemporaryExpr *E) {
642 Succ = S;
643 TerminatorExpr = E;
644 }
645
Eugene Zelenko38c70522017-12-07 21:55:09 +0000646 const bool IsConditional = false;
647 const TryResult KnownExecuted = true;
648 CFGBlock *Succ = nullptr;
649 CXXBindTemporaryExpr *TerminatorExpr = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000650 };
651
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000652 // Visitors to walk an AST and generate destructors of temporaries in
653 // full expression.
Manuel Klimekb5616c92014-08-07 10:42:17 +0000654 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
655 TempDtorContext &Context);
656 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E, TempDtorContext &Context);
657 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E,
658 TempDtorContext &Context);
659 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(
660 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context);
661 CFGBlock *VisitConditionalOperatorForTemporaryDtors(
662 AbstractConditionalOperator *E, bool BindToTemporary,
663 TempDtorContext &Context);
664 void InsertTempDtorDecisionBlock(const TempDtorContext &Context,
665 CFGBlock *FalseSucc = nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000666
Ted Kremenek6065ef62008-04-28 18:00:46 +0000667 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000668 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000669 badCFG = true;
670 return Block;
671 }
Mike Stump31feda52009-07-17 01:31:16 +0000672
Artem Dergachev40684812018-02-27 20:03:35 +0000673 // Remember to apply the construction context based on the current \p Layer
674 // when constructing the CFG element for \p CE.
675 void consumeConstructionContext(const ConstructionContextLayer *Layer,
Artem Dergachev1527dec2018-03-12 23:12:40 +0000676 Expr *E);
Artem Dergachevc1b07bd2018-02-23 23:38:41 +0000677
Artem Dergachev40684812018-02-27 20:03:35 +0000678 // Scan \p Child statement to find constructors in it, while keeping in mind
679 // that its parent statement is providing a partial construction context
680 // described by \p Layer. If a constructor is found, it would be assigned
681 // the context based on the layer. If an additional construction context layer
682 // is found, the function recurses into that.
683 void findConstructionContexts(const ConstructionContextLayer *Layer,
Artem Dergachev783a4572018-02-23 22:20:39 +0000684 Stmt *Child);
Artem Dergachev40684812018-02-27 20:03:35 +0000685
Artem Dergachev41ffb302018-02-08 22:58:15 +0000686 // Unset the construction context after consuming it. This is done immediately
Artem Dergachev1527dec2018-03-12 23:12:40 +0000687 // after adding the CFGConstructor or CFGCXXRecordTypedCall element, so
688 // there's no need to do this manually in every Visit... function.
689 void cleanupConstructionContext(Expr *E);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000690
Ted Kremenek93668002009-07-17 22:18:43 +0000691 void autoCreateBlock() { if (!Block) Block = createBlock(); }
692 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000693 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000694
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000695 CFGBlock *addStmt(Stmt *S) {
696 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000697 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000698
Alexis Hunt1d792652011-01-08 20:30:50 +0000699 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000700 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000701 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000702 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000703 void addLifetimeEnds(LocalScope::const_iterator B,
704 LocalScope::const_iterator E, Stmt *S);
705 void addAutomaticObjHandling(LocalScope::const_iterator B,
706 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000707 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000708 void addScopesEnd(LocalScope::const_iterator B, LocalScope::const_iterator E,
709 Stmt *S);
710
711 void getDeclsWithEndedScope(LocalScope::const_iterator B,
712 LocalScope::const_iterator E, Stmt *S);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000713
Marcin Swiderski5e415732010-09-30 23:05:00 +0000714 // Local scopes creation.
715 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
716
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000717 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000718 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
719 LocalScope* Scope = nullptr);
720 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000721
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000722 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000723
724 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000725
Ted Kremenek37881932011-04-04 23:29:12 +0000726 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000727 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000728 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000729
Jordy Rose17347372011-06-10 08:49:37 +0000730 // All block-level expressions should have already been IgnoreParens()ed.
731 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000732 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000733 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000734
Artem Dergachev41ffb302018-02-08 22:58:15 +0000735 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
736 if (BuildOpts.AddRichCXXConstructors) {
Artem Dergachev40684812018-02-27 20:03:35 +0000737 if (const ConstructionContextLayer *Layer =
738 ConstructionContextMap.lookup(CE)) {
Artem Dergachev783a4572018-02-23 22:20:39 +0000739 cleanupConstructionContext(CE);
Artem Dergachev6a5cd5e2018-03-30 19:25:39 +0000740 if (const auto *CC = ConstructionContext::createFromLayers(
741 cfg->getBumpVectorContext(), Layer)) {
742 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
743 return;
744 }
Artem Dergachev41ffb302018-02-08 22:58:15 +0000745 }
746 }
747
748 // No valid construction context found. Fall back to statement.
749 B->appendStmt(CE, cfg->getBumpVectorContext());
750 }
751
Artem Dergachev1527dec2018-03-12 23:12:40 +0000752 void appendCall(CFGBlock *B, CallExpr *CE) {
Richard Trieuf4a0e9a2018-03-15 00:09:26 +0000753 if (alwaysAdd(CE) && cachedEntry)
754 cachedEntry->second = B;
755
Artem Dergachev1527dec2018-03-12 23:12:40 +0000756 if (BuildOpts.AddRichCXXConstructors) {
Artem Dergachev54ed6422018-03-12 23:52:36 +0000757 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(CE, *Context)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +0000758 if (const ConstructionContextLayer *Layer =
759 ConstructionContextMap.lookup(CE)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +0000760 cleanupConstructionContext(CE);
Artem Dergachev6a5cd5e2018-03-30 19:25:39 +0000761 if (const auto *CC = ConstructionContext::createFromLayers(
762 cfg->getBumpVectorContext(), Layer)) {
763 B->appendCXXRecordTypedCall(CE, CC, cfg->getBumpVectorContext());
764 return;
765 }
Artem Dergachev1527dec2018-03-12 23:12:40 +0000766 }
767 }
768 }
769
770 // No valid construction context found. Fall back to statement.
771 B->appendStmt(CE, cfg->getBumpVectorContext());
772 }
773
Alexis Hunt1d792652011-01-08 20:30:50 +0000774 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000775 B->appendInitializer(I, cfg->getBumpVectorContext());
776 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000777
Jordan Rosec9176072014-01-13 17:59:19 +0000778 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
779 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
780 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000781
Marcin Swiderski20b88732010-10-05 05:37:00 +0000782 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
783 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
784 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000785
Marcin Swiderski20b88732010-10-05 05:37:00 +0000786 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
787 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
788 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000789
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000790 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
791 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
792 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000793
Chandler Carruthad747252011-09-13 06:09:01 +0000794 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
795 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
796 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000797
Matthias Gehre351c2182017-07-12 07:04:19 +0000798 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
799 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
800 }
801
Peter Szecsi999a25f2017-08-19 11:19:16 +0000802 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
803 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
804 }
805
Jordan Rosed2f40792013-09-03 17:00:57 +0000806 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
807 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
808 }
809
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000810 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000811 LocalScope::const_iterator B, LocalScope::const_iterator E);
812
Matthias Gehre351c2182017-07-12 07:04:19 +0000813 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
814 LocalScope::const_iterator B,
815 LocalScope::const_iterator E);
816
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000817 const VarDecl *
818 prependAutomaticObjScopeEndWithTerminator(CFGBlock *Blk,
819 LocalScope::const_iterator B,
820 LocalScope::const_iterator E);
821
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000822 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
823 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
824 cfg->getBumpVectorContext());
825 }
826
827 /// Add a reachable successor to a block, with the alternate variant that is
828 /// unreachable.
829 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
830 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
831 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000832 }
Mike Stump11289f42009-09-09 15:08:12 +0000833
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000834 void appendScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
835 if (BuildOpts.AddScopes)
836 B->appendScopeBegin(VD, S, cfg->getBumpVectorContext());
837 }
838
839 void prependScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
840 if (BuildOpts.AddScopes)
841 B->prependScopeBegin(VD, S, cfg->getBumpVectorContext());
842 }
843
844 void appendScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
845 if (BuildOpts.AddScopes)
846 B->appendScopeEnd(VD, S, cfg->getBumpVectorContext());
847 }
848
849 void prependScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
850 if (BuildOpts.AddScopes)
851 B->prependScopeEnd(VD, S, cfg->getBumpVectorContext());
852 }
853
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000854 /// Find a relational comparison with an expression evaluating to a
Richard Trieuf935b562014-04-05 05:17:01 +0000855 /// boolean and a constant other than 0 and 1.
856 /// e.g. if ((x < y) == 10)
857 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
858 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
859 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
860
861 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
862 const Expr *BoolExpr = RHSExpr;
863 bool IntFirst = true;
864 if (!IntLiteral) {
865 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
866 BoolExpr = LHSExpr;
867 IntFirst = false;
868 }
869
870 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
871 return TryResult();
872
873 llvm::APInt IntValue = IntLiteral->getValue();
874 if ((IntValue == 1) || (IntValue == 0))
875 return TryResult();
876
877 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
878 !IntValue.isNegative();
879
880 BinaryOperatorKind Bok = B->getOpcode();
881 if (Bok == BO_GT || Bok == BO_GE) {
882 // Always true for 10 > bool and bool > -1
883 // Always false for -1 > bool and bool > 10
884 return TryResult(IntFirst == IntLarger);
885 } else {
886 // Always true for -1 < bool and bool < 10
887 // Always false for 10 < bool and bool < -1
888 return TryResult(IntFirst != IntLarger);
889 }
890 }
891
Jordan Rose7afd71e2014-05-20 17:31:11 +0000892 /// Find an incorrect equality comparison. Either with an expression
893 /// evaluating to a boolean and a constant other than 0 and 1.
894 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
895 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000896 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
897 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
898 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
899
900 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
901 const Expr *BoolExpr = RHSExpr;
902
903 if (!IntLiteral) {
904 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
905 BoolExpr = LHSExpr;
906 }
907
Jordan Rose7afd71e2014-05-20 17:31:11 +0000908 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000909 return TryResult();
910
Jordan Rose7afd71e2014-05-20 17:31:11 +0000911 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
912 if (BitOp && (BitOp->getOpcode() == BO_And ||
913 BitOp->getOpcode() == BO_Or)) {
914 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
915 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
916
917 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
918
919 if (!IntLiteral2)
920 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
921
922 if (!IntLiteral2)
923 return TryResult();
924
925 llvm::APInt L1 = IntLiteral->getValue();
926 llvm::APInt L2 = IntLiteral2->getValue();
927 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
928 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
929 if (BuildOpts.Observer)
930 BuildOpts.Observer->compareBitwiseEquality(B,
931 B->getOpcode() != BO_EQ);
932 TryResult(B->getOpcode() != BO_EQ);
933 }
934 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
935 llvm::APInt IntValue = IntLiteral->getValue();
936 if ((IntValue == 1) || (IntValue == 0)) {
937 return TryResult();
938 }
939 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000940 }
941
Jordan Rose7afd71e2014-05-20 17:31:11 +0000942 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000943 }
944
945 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
946 const llvm::APSInt &Value1,
947 const llvm::APSInt &Value2) {
948 assert(Value1.isSigned() == Value2.isSigned());
949 switch (Relation) {
950 default:
951 return TryResult();
952 case BO_EQ:
953 return TryResult(Value1 == Value2);
954 case BO_NE:
955 return TryResult(Value1 != Value2);
956 case BO_LT:
957 return TryResult(Value1 < Value2);
958 case BO_LE:
959 return TryResult(Value1 <= Value2);
960 case BO_GT:
961 return TryResult(Value1 > Value2);
962 case BO_GE:
963 return TryResult(Value1 >= Value2);
964 }
965 }
966
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000967 /// Find a pair of comparison expressions with or without parentheses
Richard Trieuf935b562014-04-05 05:17:01 +0000968 /// with a shared variable and constants and a logical operator between them
969 /// that always evaluates to either true or false.
970 /// e.g. if (x != 3 || x != 4)
971 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
972 assert(B->isLogicalOp());
973 const BinaryOperator *LHS =
974 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
975 const BinaryOperator *RHS =
976 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
977 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000978 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000979
980 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000981 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000982
George Burgess IVced56e62015-10-01 18:47:52 +0000983 const DeclRefExpr *Decl1;
984 const Expr *Expr1;
985 BinaryOperatorKind BO1;
986 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000987
George Burgess IVced56e62015-10-01 18:47:52 +0000988 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000989 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000990
George Burgess IVced56e62015-10-01 18:47:52 +0000991 const DeclRefExpr *Decl2;
992 const Expr *Expr2;
993 BinaryOperatorKind BO2;
994 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000995
George Burgess IVced56e62015-10-01 18:47:52 +0000996 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000997 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000998
999 // Check that it is the same variable on both sides.
1000 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001001 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001002
George Burgess IVced56e62015-10-01 18:47:52 +00001003 // Make sure the user's intent is clear (e.g. they're comparing against two
1004 // int literals, or two things from the same enum)
1005 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001006 return {};
George Burgess IVced56e62015-10-01 18:47:52 +00001007
Richard Trieuf935b562014-04-05 05:17:01 +00001008 llvm::APSInt L1, L2;
1009
George Burgess IVced56e62015-10-01 18:47:52 +00001010 if (!Expr1->EvaluateAsInt(L1, *Context) ||
1011 !Expr2->EvaluateAsInt(L2, *Context))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001012 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001013
1014 // Can't compare signed with unsigned or with different bit width.
1015 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001016 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001017
1018 // Values that will be used to determine if result of logical
1019 // operator is always true/false
1020 const llvm::APSInt Values[] = {
1021 // Value less than both Value1 and Value2
1022 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
1023 // L1
1024 L1,
1025 // Value between Value1 and Value2
1026 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
1027 L1.isUnsigned()),
1028 // L2
1029 L2,
1030 // Value greater than both Value1 and Value2
1031 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
1032 };
1033
1034 // Check whether expression is always true/false by evaluating the following
1035 // * variable x is less than the smallest literal.
1036 // * variable x is equal to the smallest literal.
1037 // * Variable x is between smallest and largest literal.
1038 // * Variable x is equal to the largest literal.
1039 // * Variable x is greater than largest literal.
1040 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001041 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +00001042 TryResult Res1, Res2;
1043 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
1044 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
1045
1046 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001047 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001048
1049 if (B->getOpcode() == BO_LAnd) {
1050 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
1051 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
1052 } else {
1053 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
1054 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
1055 }
1056 }
1057
1058 if (AlwaysTrue || AlwaysFalse) {
1059 if (BuildOpts.Observer)
1060 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
1061 return TryResult(AlwaysTrue);
1062 }
Eugene Zelenko38c70522017-12-07 21:55:09 +00001063 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001064 }
1065
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001066 /// Try and evaluate an expression to an integer constant.
1067 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
1068 if (!BuildOpts.PruneTriviallyFalseEdges)
1069 return false;
1070 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001071 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001072 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001073 }
Mike Stump11289f42009-09-09 15:08:12 +00001074
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001075 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001076 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001077 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001078 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001079 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001080 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001081
1082 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1083 if (Bop->isLogicalOp()) {
1084 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001085 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1086 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001087 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001088
1089 // Retrieve result at first, or the map might be updated.
1090 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1091 CachedBoolEvals[S] = Result; // update or insert
1092 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001093 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001094 else {
1095 switch (Bop->getOpcode()) {
1096 default: break;
1097 // For 'x & 0' and 'x * 0', we can determine that
1098 // the value is always false.
1099 case BO_Mul:
1100 case BO_And: {
1101 // If either operand is zero, we know the value
1102 // must be false.
1103 llvm::APSInt IntVal;
1104 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001105 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001106 return TryResult(false);
1107 }
1108 }
1109 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001110 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001111 return TryResult(false);
1112 }
1113 }
1114 }
1115 break;
1116 }
1117 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001118 }
1119
1120 return evaluateAsBooleanConditionNoCache(S);
1121 }
1122
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001123 /// Evaluate as boolean \param E without using the cache.
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001124 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1125 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1126 if (Bop->isLogicalOp()) {
1127 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1128 if (LHS.isKnown()) {
1129 // We were able to evaluate the LHS, see if we can get away with not
1130 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1131 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1132 return LHS.isTrue();
1133
1134 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1135 if (RHS.isKnown()) {
1136 if (Bop->getOpcode() == BO_LOr)
1137 return LHS.isTrue() || RHS.isTrue();
1138 else
1139 return LHS.isTrue() && RHS.isTrue();
1140 }
1141 } else {
1142 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1143 if (RHS.isKnown()) {
1144 // We can't evaluate the LHS; however, sometimes the result
1145 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1146 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1147 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001148 } else {
1149 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1150 if (BopRes.isKnown())
1151 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001152 }
1153 }
1154
Eugene Zelenko38c70522017-12-07 21:55:09 +00001155 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001156 } else if (Bop->isEqualityOp()) {
1157 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1158 if (BopRes.isKnown())
1159 return BopRes.isTrue();
1160 } else if (Bop->isRelationalOp()) {
1161 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1162 if (BopRes.isKnown())
1163 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001164 }
1165 }
1166
1167 bool Result;
1168 if (E->EvaluateAsBooleanCondition(Result, *Context))
1169 return Result;
1170
Eugene Zelenko38c70522017-12-07 21:55:09 +00001171 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001172 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001173
1174 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001175};
Mike Stump31feda52009-07-17 01:31:16 +00001176
Eugene Zelenko38c70522017-12-07 21:55:09 +00001177} // namespace
1178
Ted Kremeneka099c592011-03-10 03:50:34 +00001179inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1180 const Stmt *stmt) const {
1181 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1182}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001183
Ted Kremeneka099c592011-03-10 03:50:34 +00001184bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001185 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
1186
Ted Kremeneka099c592011-03-10 03:50:34 +00001187 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001188 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001189
1190 if (lastLookup == stmt) {
1191 if (cachedEntry) {
1192 assert(cachedEntry->first == stmt);
1193 return true;
1194 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001195 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001196 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001197
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001198 lastLookup = stmt;
1199
1200 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001201 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1202
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001203 if (!fb) {
1204 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001205 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001206 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001207 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001208
1209 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001210 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001211 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001212 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001213 }
1214
Ted Kremeneka099c592011-03-10 03:50:34 +00001215 cachedEntry = &*itr;
1216 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001217}
1218
Douglas Gregor4619e432008-12-05 23:32:09 +00001219// FIXME: Add support for dependent-sized array types in C++?
1220// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001221static const VariableArrayType *FindVA(const Type *t) {
1222 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1223 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001224 if (vat->getSizeExpr())
1225 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001226
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001227 t = vt->getElementType().getTypePtr();
1228 }
Mike Stump31feda52009-07-17 01:31:16 +00001229
Craig Topper25542942014-05-20 04:30:07 +00001230 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001231}
Mike Stump31feda52009-07-17 01:31:16 +00001232
Artem Dergachev40684812018-02-27 20:03:35 +00001233void CFGBuilder::consumeConstructionContext(
Artem Dergachev1527dec2018-03-12 23:12:40 +00001234 const ConstructionContextLayer *Layer, Expr *E) {
Artem Dergachev40684812018-02-27 20:03:35 +00001235 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachev1527dec2018-03-12 23:12:40 +00001236 ConstructionContextMap.lookup(E)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001237 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001238 // We might have visited this child when we were finding construction
1239 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001240 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001241 "Already within a different construction context!");
1242 } else {
Artem Dergachev1527dec2018-03-12 23:12:40 +00001243 ConstructionContextMap[E] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001244 }
1245}
1246
Artem Dergachev783a4572018-02-23 22:20:39 +00001247void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001248 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001249 if (!BuildOpts.AddRichCXXConstructors)
1250 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001251
Artem Dergachev41ffb302018-02-08 22:58:15 +00001252 if (!Child)
1253 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001254
1255 switch(Child->getStmtClass()) {
1256 case Stmt::CXXConstructExprClass:
1257 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachev40684812018-02-27 20:03:35 +00001258 consumeConstructionContext(Layer, cast<CXXConstructExpr>(Child));
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001259 break;
1260 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00001261 // FIXME: This, like the main visit, doesn't support CUDAKernelCallExpr.
1262 // FIXME: An isa<> would look much better but this whole switch is a
1263 // workaround for an internal compiler error in MSVC 2015 (see r326021).
1264 case Stmt::CallExprClass:
1265 case Stmt::CXXMemberCallExprClass:
1266 case Stmt::CXXOperatorCallExprClass:
1267 case Stmt::UserDefinedLiteralClass: {
1268 auto *CE = cast<CallExpr>(Child);
Artem Dergachev54ed6422018-03-12 23:52:36 +00001269 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(CE, *Context))
Artem Dergachev1527dec2018-03-12 23:12:40 +00001270 consumeConstructionContext(Layer, CE);
1271 break;
1272 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001273 case Stmt::ExprWithCleanupsClass: {
1274 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001275 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001276 break;
1277 }
1278 case Stmt::CXXFunctionalCastExprClass: {
1279 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001280 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001281 break;
1282 }
1283 case Stmt::ImplicitCastExprClass: {
1284 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev317291e2018-03-22 21:37:39 +00001285 // Should we support other implicit cast kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001286 switch (Cast->getCastKind()) {
1287 case CK_NoOp:
1288 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001289 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev13f96642018-03-09 01:39:59 +00001290 default:
1291 break;
1292 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001293 break;
1294 }
1295 case Stmt::CXXBindTemporaryExprClass: {
1296 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachev783a4572018-02-23 22:20:39 +00001297 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001298 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
1299 BTE, Layer),
Artem Dergachev783a4572018-02-23 22:20:39 +00001300 BTE->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001301 break;
1302 }
1303 case Stmt::ConditionalOperatorClass: {
1304 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev9d3a7d82018-03-30 19:21:18 +00001305 if (!dyn_cast_or_null<MaterializeTemporaryExpr>(Layer->getTriggerStmt())) {
1306 // If the object returned by the conditional operator is not going to be a
1307 // temporary object that needs to be immediately materialized, then
1308 // it must be C++17 with its mandatory copy elision. Do not yet promise
1309 // to support this case.
1310 assert(!CO->getType()->getAsCXXRecordDecl() || CO->isGLValue() ||
1311 Context->getLangOpts().CPlusPlus17);
1312 break;
1313 }
Artem Dergachev40684812018-02-27 20:03:35 +00001314 findConstructionContexts(Layer, CO->getLHS());
1315 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001316 break;
1317 }
1318 default:
1319 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001320 }
1321}
1322
Artem Dergachev1527dec2018-03-12 23:12:40 +00001323void CFGBuilder::cleanupConstructionContext(Expr *E) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001324 assert(BuildOpts.AddRichCXXConstructors &&
1325 "We should not be managing construction contexts!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001326 assert(ConstructionContextMap.count(E) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001327 "Cannot exit construction context without the context!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001328 ConstructionContextMap.erase(E);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001329}
1330
1331
Mike Stump31feda52009-07-17 01:31:16 +00001332/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1333/// arbitrary statement. Examples include a single expression or a function
1334/// body (compound statement). The ownership of the returned CFG is
1335/// transferred to the caller. If CFG construction fails, this method returns
1336/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001337std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001338 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001339 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001340 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001341
Mike Stump31feda52009-07-17 01:31:16 +00001342 // Create an empty block that will serve as the exit block for the CFG. Since
1343 // this is the first block added to the CFG, it will be implicitly registered
1344 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001345 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001346 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001347 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001348
Matthias Gehre351c2182017-07-12 07:04:19 +00001349 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1350 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1351
Marcin Swiderski20b88732010-10-05 05:37:00 +00001352 if (BuildOpts.AddImplicitDtors)
1353 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1354 addImplicitDtorsForDestructor(DD);
1355
Ted Kremenek9aae5132007-08-23 21:42:29 +00001356 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001357 CFGBlock *B = addStmt(Statement);
1358
1359 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001360 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001361
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001362 // For C++ constructor add initializers to CFG.
1363 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001364 for (auto *I : llvm::reverse(CD->inits())) {
1365 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001366 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001367 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001368 }
1369 }
1370
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001371 if (B)
1372 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001373
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001374 // Backpatch the gotos whose label -> block mappings we didn't know when we
1375 // encountered them.
1376 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1377 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001378
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001379 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001380 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001381 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001382
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001383 // If there is no target for the goto, then we are looking at an
1384 // incomplete AST. Handle this by not registering a successor.
1385 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001386
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001387 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001388 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1389 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001390 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1391 JT.scopePosition);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001392 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1393 B, I->scopePosition, JT.scopePosition);
1394 appendScopeBegin(JT.block, VD, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001395 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001396 }
1397
1398 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001399 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001400 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1401 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001402 // Lookup the target block.
1403 LabelMapTy::iterator LI = LabelMap.find(*I);
1404
1405 // If there is no target block that contains label, then we are looking
1406 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001407 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001408
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001409 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001410 }
Mike Stump31feda52009-07-17 01:31:16 +00001411
Mike Stump31feda52009-07-17 01:31:16 +00001412 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001413 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001414
Artem Dergachev783a4572018-02-23 22:20:39 +00001415 if (BuildOpts.AddRichCXXConstructors)
1416 assert(ConstructionContextMap.empty() &&
1417 "Not all construction contexts were cleaned up!");
1418
David Blaikiee90195c2014-08-29 18:53:26 +00001419 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001420}
Mike Stump31feda52009-07-17 01:31:16 +00001421
Ted Kremenek9aae5132007-08-23 21:42:29 +00001422/// createBlock - Used to lazily create blocks that are connected
1423/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001424CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1425 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001426 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001427 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001428 return B;
1429}
Mike Stump31feda52009-07-17 01:31:16 +00001430
Chandler Carrutha70991b2011-09-13 09:13:49 +00001431/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1432/// CFG. It is *not* connected to the current (global) successor, and instead
1433/// directly tied to the exit block in order to be reachable.
1434CFGBlock *CFGBuilder::createNoReturnBlock() {
1435 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001436 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001437 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001438 return B;
1439}
1440
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001441/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001442CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001443 if (!BuildOpts.AddInitializers)
1444 return Block;
1445
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001446 bool HasTemporaries = false;
1447
1448 // Destructors of temporaries in initialization expression should be called
1449 // after initialization finishes.
1450 Expr *Init = I->getInit();
1451 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001452 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001453
Jordan Rose6d671cc2012-09-05 22:55:23 +00001454 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001455 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001456 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001457 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1458 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001459 }
1460 }
1461
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001462 autoCreateBlock();
1463 appendInitializer(Block, I);
1464
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001465 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001466 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001467 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001468 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001469
Ted Kremenek8219b822010-12-16 07:46:53 +00001470 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001471 // For expression with temporaries go directly to subexpression to omit
1472 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001473 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1474 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001475 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1476 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1477 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1478 // may cause the same Expr to appear more than once in the CFG. Doing it
1479 // here is safe because there's only one initializer per field.
1480 autoCreateBlock();
1481 appendStmt(Block, Default);
1482 if (Stmt *Child = Default->getExpr())
1483 if (CFGBlock *R = Visit(Child))
1484 Block = R;
1485 return Block;
1486 }
1487 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001488 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001489 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001490
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001491 return Block;
1492}
1493
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001494/// Retrieve the type of the temporary object whose lifetime was
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001495/// extended by a local reference with the given initializer.
Artem Dergacheva25809f2018-06-04 18:56:25 +00001496static QualType getReferenceInitTemporaryType(const Expr *Init,
Richard Smithb8c0f552016-12-09 18:49:13 +00001497 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001498 while (true) {
1499 // Skip parentheses.
1500 Init = Init->IgnoreParens();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001501
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001502 // Skip through cleanups.
1503 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1504 Init = EWC->getSubExpr();
1505 continue;
1506 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001507
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001508 // Skip through the temporary-materialization expression.
1509 if (const MaterializeTemporaryExpr *MTE
1510 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1511 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001512 if (FoundMTE)
1513 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001514 continue;
1515 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001516
1517 // Skip sub-object accesses into rvalues.
1518 SmallVector<const Expr *, 2> CommaLHSs;
1519 SmallVector<SubobjectAdjustment, 2> Adjustments;
1520 const Expr *SkippedInit =
1521 Init->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments);
1522 if (SkippedInit != Init) {
1523 Init = SkippedInit;
1524 continue;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001525 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001526
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001527 break;
1528 }
1529
1530 return Init->getType();
1531}
Matthias Gehre351c2182017-07-12 07:04:19 +00001532
Peter Szecsi999a25f2017-08-19 11:19:16 +00001533// TODO: Support adding LoopExit element to the CFG in case where the loop is
1534// ended by ReturnStmt, GotoStmt or ThrowExpr.
1535void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1536 if(!BuildOpts.AddLoopExit)
1537 return;
1538 autoCreateBlock();
1539 appendLoopExit(Block, LoopStmt);
1540}
1541
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001542void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1543 LocalScope::const_iterator E, Stmt *S) {
1544 if (!BuildOpts.AddScopes)
1545 return;
1546
1547 if (B == E)
1548 return;
1549
1550 // To go from B to E, one first goes up the scopes from B to P
1551 // then sideways in one scope from P to P' and then down
1552 // the scopes from P' to E.
1553 // The lifetime of all objects between B and P end.
1554 LocalScope::const_iterator P = B.shared_parent(E);
1555 int Dist = B.distance(P);
1556 if (Dist <= 0)
1557 return;
1558
1559 for (LocalScope::const_iterator I = B; I != P; ++I)
1560 if (I.pointsToFirstDeclaredVar())
1561 DeclsWithEndedScope.insert(*I);
1562}
1563
Matthias Gehre351c2182017-07-12 07:04:19 +00001564void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1565 LocalScope::const_iterator E,
1566 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001567 getDeclsWithEndedScope(B, E, S);
1568 if (BuildOpts.AddScopes)
1569 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001570 if (BuildOpts.AddImplicitDtors)
1571 addAutomaticObjDtors(B, E, S);
1572 if (BuildOpts.AddLifetime)
1573 addLifetimeEnds(B, E, S);
1574}
1575
1576/// Add to current block automatic objects that leave the scope.
1577void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1578 LocalScope::const_iterator E, Stmt *S) {
1579 if (!BuildOpts.AddLifetime)
1580 return;
1581
1582 if (B == E)
1583 return;
1584
1585 // To go from B to E, one first goes up the scopes from B to P
1586 // then sideways in one scope from P to P' and then down
1587 // the scopes from P' to E.
1588 // The lifetime of all objects between B and P end.
1589 LocalScope::const_iterator P = B.shared_parent(E);
1590 int dist = B.distance(P);
1591 if (dist <= 0)
1592 return;
1593
1594 // We need to perform the scope leaving in reverse order
1595 SmallVector<VarDecl *, 10> DeclsTrivial;
1596 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1597 DeclsTrivial.reserve(dist);
1598 DeclsNonTrivial.reserve(dist);
1599
1600 for (LocalScope::const_iterator I = B; I != P; ++I)
1601 if (hasTrivialDestructor(*I))
1602 DeclsTrivial.push_back(*I);
1603 else
1604 DeclsNonTrivial.push_back(*I);
1605
1606 autoCreateBlock();
1607 // object with trivial destructor end their lifetime last (when storage
1608 // duration ends)
1609 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1610 E = DeclsTrivial.rend();
1611 I != E; ++I)
1612 appendLifetimeEnds(Block, *I, S);
1613
1614 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1615 I = DeclsNonTrivial.rbegin(),
1616 E = DeclsNonTrivial.rend();
1617 I != E; ++I)
1618 appendLifetimeEnds(Block, *I, S);
1619}
1620
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001621/// Add to current block markers for ending scopes.
1622void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1623 LocalScope::const_iterator E, Stmt *S) {
1624 // If implicit destructors are enabled, we'll add scope ends in
1625 // addAutomaticObjDtors.
1626 if (BuildOpts.AddImplicitDtors)
1627 return;
1628
1629 autoCreateBlock();
1630
1631 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1632 I != E; ++I)
1633 appendScopeEnd(Block, *I, S);
1634
1635 return;
1636}
1637
Marcin Swiderski5e415732010-09-30 23:05:00 +00001638/// addAutomaticObjDtors - Add to current block automatic objects destructors
1639/// for objects in range of local scope positions. Use S as trigger statement
1640/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001641void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001642 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001643 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001644 return;
1645
Marcin Swiderski5e415732010-09-30 23:05:00 +00001646 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001647 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001648
Chandler Carruthad747252011-09-13 06:09:01 +00001649 // We need to append the destructors in reverse order, but any one of them
1650 // may be a no-return destructor which changes the CFG. As a result, buffer
1651 // this sequence up and replay them in reverse order when appending onto the
1652 // CFGBlock(s).
1653 SmallVector<VarDecl*, 10> Decls;
1654 Decls.reserve(B.distance(E));
1655 for (LocalScope::const_iterator I = B; I != E; ++I)
1656 Decls.push_back(*I);
1657
1658 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1659 E = Decls.rend();
1660 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001661 if (hasTrivialDestructor(*I)) {
1662 // If AddScopes is enabled and *I is a first variable in a scope, add a
1663 // ScopeEnd marker in a Block.
1664 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1665 autoCreateBlock();
1666 appendScopeEnd(Block, *I, S);
1667 }
1668 continue;
1669 }
Chandler Carruthad747252011-09-13 06:09:01 +00001670 // If this destructor is marked as a no-return destructor, we need to
1671 // create a new block for the destructor which does not have as a successor
1672 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001673 QualType Ty = (*I)->getType();
1674 if (Ty->isReferenceType()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00001675 Ty = getReferenceInitTemporaryType((*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001676 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001677 Ty = Context->getBaseElementType(Ty);
1678
Richard Trieu95a192a2015-05-28 00:14:02 +00001679 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001680 Block = createNoReturnBlock();
1681 else
Chandler Carruthad747252011-09-13 06:09:01 +00001682 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001683
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001684 // Add ScopeEnd just after automatic obj destructor.
1685 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1686 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001687 appendAutomaticObjDtor(Block, *I, S);
1688 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001689}
1690
Marcin Swiderski20b88732010-10-05 05:37:00 +00001691/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1692/// base and member objects in destructor.
1693void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001694 assert(BuildOpts.AddImplicitDtors &&
1695 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001696 const CXXRecordDecl *RD = DD->getParent();
1697
1698 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001699 for (const auto &VI : RD->vbases()) {
1700 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001701 if (!CD->hasTrivialDestructor()) {
1702 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001703 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001704 }
1705 }
1706
1707 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001708 for (const auto &BI : RD->bases()) {
1709 if (!BI.isVirtual()) {
1710 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001711 if (!CD->hasTrivialDestructor()) {
1712 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001713 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001714 }
1715 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001716 }
1717
1718 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001719 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001720 // Check for constant size array. Set type to array element type.
1721 QualType QT = FI->getType();
1722 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1723 if (AT->getSize() == 0)
1724 continue;
1725 QT = AT->getElementType();
1726 }
1727
1728 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001729 if (!CD->hasTrivialDestructor()) {
1730 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001731 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001732 }
1733 }
1734}
1735
Marcin Swiderski5e415732010-09-30 23:05:00 +00001736/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1737/// way return valid LocalScope object.
1738LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001739 if (Scope)
1740 return Scope;
1741 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1742 return new (alloc.Allocate<LocalScope>())
1743 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001744}
1745
1746/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +00001747/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001748void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001749 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1750 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001751 return;
1752
Craig Topper25542942014-05-20 04:30:07 +00001753 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001754
1755 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001756 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001757 for (auto *BI : CS->body()) {
1758 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001759 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001760 Scope = addLocalScopeForDeclStmt(DS, Scope);
1761 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001762 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001763 }
1764
1765 // For any other statement scope will be implicit and as such will be
1766 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001767 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001768 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001769}
1770
1771/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1772/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001773LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001774 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001775 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1776 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001777 return Scope;
1778
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001779 for (auto *DI : DS->decls())
1780 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001781 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001782 return Scope;
1783}
1784
Matthias Gehre351c2182017-07-12 07:04:19 +00001785bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1786 // Check for const references bound to temporary. Set type to pointee.
1787 QualType QT = VD->getType();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001788 if (QT->isReferenceType()) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001789 // Attempt to determine whether this declaration lifetime-extends a
1790 // temporary.
1791 //
1792 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1793 // temporaries, and a single declaration can extend multiple temporaries.
1794 // We should look at the storage duration on each nested
1795 // MaterializeTemporaryExpr instead.
1796
1797 const Expr *Init = VD->getInit();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001798 if (!Init) {
1799 // Probably an exception catch-by-reference variable.
1800 // FIXME: It doesn't really mean that the object has a trivial destructor.
1801 // Also are there other cases?
Matthias Gehre351c2182017-07-12 07:04:19 +00001802 return true;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001803 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001804
Artem Dergacheva25809f2018-06-04 18:56:25 +00001805 // Lifetime-extending a temporary?
Matthias Gehre351c2182017-07-12 07:04:19 +00001806 bool FoundMTE = false;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001807 QT = getReferenceInitTemporaryType(Init, &FoundMTE);
Matthias Gehre351c2182017-07-12 07:04:19 +00001808 if (!FoundMTE)
1809 return true;
1810 }
1811
1812 // Check for constant size array. Set type to array element type.
1813 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1814 if (AT->getSize() == 0)
1815 return true;
1816 QT = AT->getElementType();
1817 }
1818
1819 // Check if type is a C++ class with non-trivial destructor.
1820 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1821 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1822 return true;
1823}
1824
Marcin Swiderski5e415732010-09-30 23:05:00 +00001825/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1826/// create add scope for automatic objects and temporary objects bound to
1827/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001828LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001829 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001830 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1831 "AddImplicitDtors and AddLifetime cannot be used at the same time");
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
1836 // Check if variable is local.
1837 switch (VD->getStorageClass()) {
1838 case SC_None:
1839 case SC_Auto:
1840 case SC_Register:
1841 break;
1842 default: return Scope;
1843 }
1844
Matthias Gehre351c2182017-07-12 07:04:19 +00001845 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001846 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001847 // Add the variable to scope
1848 Scope = createOrReuseLocalScope(Scope);
1849 Scope->addVar(VD);
1850 ScopePos = Scope->begin();
1851 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001852 return Scope;
1853 }
1854
1855 assert(BuildOpts.AddLifetime);
1856 // Add the variable to scope
1857 Scope = createOrReuseLocalScope(Scope);
1858 Scope->addVar(VD);
1859 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001860 return Scope;
1861}
1862
1863/// addLocalScopeAndDtors - For given statement add local scope for it and
1864/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001865void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001866 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001867 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001868 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001869}
1870
Marcin Swiderski321a7072010-09-30 22:54:37 +00001871/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1872/// variables with automatic storage duration to CFGBlock's elements vector.
1873/// Elements will be prepended to physical beginning of the vector which
1874/// happens to be logical end. Use blocks terminator as statement that specifies
1875/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001876/// FIXME: This mechanism for adding automatic destructors doesn't handle
1877/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001878void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001879 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001880 if (!BuildOpts.AddImplicitDtors)
1881 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001882 BumpVectorContext &C = cfg->getBumpVectorContext();
1883 CFGBlock::iterator InsertPos
1884 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1885 for (LocalScope::const_iterator I = B; I != E; ++I)
1886 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1887 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001888}
1889
Matthias Gehre351c2182017-07-12 07:04:19 +00001890/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1891/// variables with automatic storage duration to CFGBlock's elements vector.
1892/// Elements will be prepended to physical beginning of the vector which
1893/// happens to be logical end. Use blocks terminator as statement that specifies
1894/// where lifetime ends.
1895void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1896 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1897 if (!BuildOpts.AddLifetime)
1898 return;
1899 BumpVectorContext &C = cfg->getBumpVectorContext();
1900 CFGBlock::iterator InsertPos =
1901 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1902 for (LocalScope::const_iterator I = B; I != E; ++I)
1903 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1904}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001905
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001906/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
1907/// variables with automatic storage duration to CFGBlock's elements vector.
1908/// Elements will be prepended to physical beginning of the vector which
1909/// happens to be logical end. Use blocks terminator as statement that specifies
1910/// where scope ends.
1911const VarDecl *
1912CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
1913 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1914 if (!BuildOpts.AddScopes)
1915 return nullptr;
1916 BumpVectorContext &C = cfg->getBumpVectorContext();
1917 CFGBlock::iterator InsertPos =
1918 Blk->beginScopeEndInsert(Blk->end(), 1, C);
1919 LocalScope::const_iterator PlaceToInsert = B;
1920 for (LocalScope::const_iterator I = B; I != E; ++I)
1921 PlaceToInsert = I;
1922 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminator());
1923 return *PlaceToInsert;
1924}
1925
Ted Kremenek93668002009-07-17 22:18:43 +00001926/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001927/// blocks for ternary operators, &&, and ||. We also process "," and
1928/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001929CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001930 if (!S) {
1931 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001932 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001933 }
Jordy Rose17347372011-06-10 08:49:37 +00001934
1935 if (Expr *E = dyn_cast<Expr>(S))
1936 S = E->IgnoreParens();
1937
Ted Kremenek93668002009-07-17 22:18:43 +00001938 switch (S->getStmtClass()) {
1939 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001940 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001941
1942 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001943 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001944
John McCallc07a0c72011-02-17 10:25:35 +00001945 case Stmt::BinaryConditionalOperatorClass:
1946 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1947
Ted Kremenek93668002009-07-17 22:18:43 +00001948 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001949 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001950
Ted Kremenek93668002009-07-17 22:18:43 +00001951 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00001952 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001953
Ted Kremenek93668002009-07-17 22:18:43 +00001954 case Stmt::BreakStmtClass:
1955 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001956
Ted Kremenek93668002009-07-17 22:18:43 +00001957 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001958 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001959 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001960 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001961 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001962
Ted Kremenek93668002009-07-17 22:18:43 +00001963 case Stmt::CaseStmtClass:
1964 return VisitCaseStmt(cast<CaseStmt>(S));
1965
1966 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001967 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001968
Ted Kremenek93668002009-07-17 22:18:43 +00001969 case Stmt::CompoundStmtClass:
1970 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001971
Ted Kremenek93668002009-07-17 22:18:43 +00001972 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001973 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001974
Ted Kremenek93668002009-07-17 22:18:43 +00001975 case Stmt::ContinueStmtClass:
1976 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001977
Ted Kremenekb27378c2010-01-19 20:40:33 +00001978 case Stmt::CXXCatchStmtClass:
1979 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1980
John McCall5d413782010-12-06 08:20:24 +00001981 case Stmt::ExprWithCleanupsClass:
1982 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001983
Jordan Rosee5d53932012-08-23 18:10:53 +00001984 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001985 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001986 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1987 // called function's declaration, not by the caller. If we simply add
1988 // this expression to the CFG, we could end up with the same Expr
1989 // appearing multiple times.
1990 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001991 //
1992 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1993 // expression to be used in the same function (through aggregate
1994 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00001995 return VisitStmt(S, asc);
1996
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001997 case Stmt::CXXBindTemporaryExprClass:
1998 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
1999
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002000 case Stmt::CXXConstructExprClass:
2001 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
2002
Jordan Rosec9176072014-01-13 17:59:19 +00002003 case Stmt::CXXNewExprClass:
2004 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2005
Jordan Rosed2f40792013-09-03 17:00:57 +00002006 case Stmt::CXXDeleteExprClass:
2007 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2008
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002009 case Stmt::CXXFunctionalCastExprClass:
2010 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2011
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002012 case Stmt::CXXTemporaryObjectExprClass:
2013 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2014
Ted Kremenekb27378c2010-01-19 20:40:33 +00002015 case Stmt::CXXThrowExprClass:
2016 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002017
Ted Kremenekb27378c2010-01-19 20:40:33 +00002018 case Stmt::CXXTryStmtClass:
2019 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002020
Richard Smith02e85f32011-04-14 22:09:26 +00002021 case Stmt::CXXForRangeStmtClass:
2022 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2023
Ted Kremenek93668002009-07-17 22:18:43 +00002024 case Stmt::DeclStmtClass:
2025 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002026
Ted Kremenek93668002009-07-17 22:18:43 +00002027 case Stmt::DefaultStmtClass:
2028 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002029
Ted Kremenek93668002009-07-17 22:18:43 +00002030 case Stmt::DoStmtClass:
2031 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002032
Ted Kremenek93668002009-07-17 22:18:43 +00002033 case Stmt::ForStmtClass:
2034 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002035
Ted Kremenek93668002009-07-17 22:18:43 +00002036 case Stmt::GotoStmtClass:
2037 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002038
Ted Kremenek93668002009-07-17 22:18:43 +00002039 case Stmt::IfStmtClass:
2040 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002041
Ted Kremenek8219b822010-12-16 07:46:53 +00002042 case Stmt::ImplicitCastExprClass:
2043 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002044
Ted Kremenek93668002009-07-17 22:18:43 +00002045 case Stmt::IndirectGotoStmtClass:
2046 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002047
Ted Kremenek93668002009-07-17 22:18:43 +00002048 case Stmt::LabelStmtClass:
2049 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002050
Ted Kremenekda76a942012-04-12 20:34:52 +00002051 case Stmt::LambdaExprClass:
2052 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2053
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002054 case Stmt::MaterializeTemporaryExprClass:
2055 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2056 asc);
2057
Ted Kremenek5868ec62010-04-11 17:02:10 +00002058 case Stmt::MemberExprClass:
2059 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2060
Ted Kremenek04268232011-11-05 00:10:15 +00002061 case Stmt::NullStmtClass:
2062 return Block;
2063
Ted Kremenek93668002009-07-17 22:18:43 +00002064 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002065 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2066
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002067 case Stmt::ObjCAutoreleasePoolStmtClass:
2068 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2069
Ted Kremenek93668002009-07-17 22:18:43 +00002070 case Stmt::ObjCAtSynchronizedStmtClass:
2071 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002072
Ted Kremenek93668002009-07-17 22:18:43 +00002073 case Stmt::ObjCAtThrowStmtClass:
2074 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002075
Ted Kremenek93668002009-07-17 22:18:43 +00002076 case Stmt::ObjCAtTryStmtClass:
2077 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002078
Ted Kremenek93668002009-07-17 22:18:43 +00002079 case Stmt::ObjCForCollectionStmtClass:
2080 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002081
Ted Kremenek04268232011-11-05 00:10:15 +00002082 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002083 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002084
John McCallfe96e0b2011-11-06 09:01:30 +00002085 case Stmt::PseudoObjectExprClass:
2086 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2087
Ted Kremenek93668002009-07-17 22:18:43 +00002088 case Stmt::ReturnStmtClass:
2089 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002090
Nico Weber699670e2017-08-23 15:33:16 +00002091 case Stmt::SEHExceptStmtClass:
2092 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2093
2094 case Stmt::SEHFinallyStmtClass:
2095 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2096
2097 case Stmt::SEHLeaveStmtClass:
2098 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2099
2100 case Stmt::SEHTryStmtClass:
2101 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2102
Peter Collingbournee190dee2011-03-11 19:24:49 +00002103 case Stmt::UnaryExprOrTypeTraitExprClass:
2104 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2105 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002106
Ted Kremenek93668002009-07-17 22:18:43 +00002107 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002108 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002109
Ted Kremenek93668002009-07-17 22:18:43 +00002110 case Stmt::SwitchStmtClass:
2111 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002112
Zhanyong Wan6dace612010-11-22 08:45:56 +00002113 case Stmt::UnaryOperatorClass:
2114 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2115
Ted Kremenek93668002009-07-17 22:18:43 +00002116 case Stmt::WhileStmtClass:
2117 return VisitWhileStmt(cast<WhileStmt>(S));
2118 }
2119}
Mike Stump11289f42009-09-09 15:08:12 +00002120
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002121CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002122 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002123 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002124 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002125 }
Mike Stump11289f42009-09-09 15:08:12 +00002126
Ted Kremenek93668002009-07-17 22:18:43 +00002127 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002128}
Mike Stump31feda52009-07-17 01:31:16 +00002129
Ted Kremenek93668002009-07-17 22:18:43 +00002130/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002131CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2132 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002133
Ted Kremenek8ae67872013-02-05 22:00:19 +00002134 // Visit the children in their reverse order so that they appear in
2135 // left-to-right (natural) order in the CFG.
2136 reverse_children RChildren(S);
2137 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2138 I != E; ++I) {
2139 if (Stmt *Child = *I)
2140 if (CFGBlock *R = Visit(Child))
2141 B = R;
2142 }
2143 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002144}
Mike Stump11289f42009-09-09 15:08:12 +00002145
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002146CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2147 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002148 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002149
Ted Kremenek7c58d352011-03-10 01:14:11 +00002150 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002151 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002152 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002153 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002154
Ted Kremenek9aae5132007-08-23 21:42:29 +00002155 return Block;
2156}
Mike Stump11289f42009-09-09 15:08:12 +00002157
Zhanyong Wan6dace612010-11-22 08:45:56 +00002158CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002159 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002160 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002161 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002162 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002163 }
2164
Ted Kremenek8219b822010-12-16 07:46:53 +00002165 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002166}
2167
Ted Kremeneka16436f2012-07-14 05:04:06 +00002168CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2169 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2170 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002171
Ted Kremeneka16436f2012-07-14 05:04:06 +00002172 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002173 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002174
Craig Topper25542942014-05-20 04:30:07 +00002175 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2176 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002177}
2178
2179std::pair<CFGBlock*, CFGBlock*>
2180CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2181 Stmt *Term,
2182 CFGBlock *TrueBlock,
2183 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002184 // Introspect the RHS. If it is a nested logical operation, we recursively
2185 // build the CFG using this function. Otherwise, resort to default
2186 // CFG construction behavior.
2187 Expr *RHS = B->getRHS()->IgnoreParens();
2188 CFGBlock *RHSBlock, *ExitBlock;
2189
2190 do {
2191 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2192 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002193 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002194 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2195 break;
2196 }
2197
2198 // The RHS is not a nested logical operation. Don't push the terminator
2199 // down further, but instead visit RHS and construct the respective
2200 // pieces of the CFG, and link up the RHSBlock with the terminator
2201 // we have been provided.
2202 ExitBlock = RHSBlock = createBlock(false);
2203
Richard Trieu6a6af522017-01-04 00:46:30 +00002204 // Even though KnownVal is only used in the else branch of the next
2205 // conditional, tryEvaluateBool performs additional checking on the
2206 // Expr, so it should be called unconditionally.
2207 TryResult KnownVal = tryEvaluateBool(RHS);
2208 if (!KnownVal.isKnown())
2209 KnownVal = tryEvaluateBool(B);
2210
Ted Kremenekb50e7162012-07-14 05:04:10 +00002211 if (!Term) {
2212 assert(TrueBlock == FalseBlock);
2213 addSuccessor(RHSBlock, TrueBlock);
2214 }
2215 else {
2216 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002217 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2218 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002219 }
2220
2221 Block = RHSBlock;
2222 RHSBlock = addStmt(RHS);
2223 }
2224 while (false);
2225
2226 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002227 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002228
2229 // Generate the blocks for evaluating the LHS.
2230 Expr *LHS = B->getLHS()->IgnoreParens();
2231
2232 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2233 if (B_LHS->isLogicalOp()) {
2234 if (B->getOpcode() == BO_LOr)
2235 FalseBlock = RHSBlock;
2236 else
2237 TrueBlock = RHSBlock;
2238
2239 // For the LHS, treat 'B' as the terminator that we want to sink
2240 // into the nested branch. The RHS always gets the top-most
2241 // terminator.
2242 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2243 }
2244
2245 // Create the block evaluating the LHS.
2246 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002247 CFGBlock *LHSBlock = createBlock(false);
2248 LHSBlock->setTerminator(B);
2249
Ted Kremeneka16436f2012-07-14 05:04:06 +00002250 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002251 CFGBlock *EntryLHSBlock = addStmt(LHS);
2252
2253 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002254 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002255
2256 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002257 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002258
2259 // Now link the LHSBlock with RHSBlock.
2260 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002261 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2262 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002263 } else {
2264 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002265 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2266 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002267 }
2268
Ted Kremenekb50e7162012-07-14 05:04:10 +00002269 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002270}
2271
2272CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2273 AddStmtChoice asc) {
2274 // && or ||
2275 if (B->isLogicalOp())
2276 return VisitLogicalOperator(B);
2277
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002278 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002279 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002280 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002281 addStmt(B->getRHS());
2282 return addStmt(B->getLHS());
2283 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002284
2285 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002286 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002287 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002288 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002289 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002290 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002291 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002292 }
Mike Stump11289f42009-09-09 15:08:12 +00002293
Ted Kremenek7c58d352011-03-10 01:14:11 +00002294 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002295 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002296 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002297 }
2298
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002299 CFGBlock *RBlock = Visit(B->getRHS());
2300 CFGBlock *LBlock = Visit(B->getLHS());
2301 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2302 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2303 // return RBlock. Otherwise we'll incorrectly return NULL.
2304 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002305}
2306
Ted Kremeneke2499842012-04-12 20:03:44 +00002307CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002308 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002309 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002310 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002311 }
2312 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002313}
2314
Ted Kremenek93668002009-07-17 22:18:43 +00002315CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2316 // "break" is a control-flow statement. Thus we stop processing the current
2317 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002318 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002319 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002320
Ted Kremenek93668002009-07-17 22:18:43 +00002321 // Now create a new block that ends with the break statement.
2322 Block = createBlock(false);
2323 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002324
Ted Kremenek93668002009-07-17 22:18:43 +00002325 // If there is no target for the break, then we are looking at an incomplete
2326 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002327 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002328 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002329 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002330 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002331 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002332
Ted Kremenek9aae5132007-08-23 21:42:29 +00002333 return Block;
2334}
Mike Stump11289f42009-09-09 15:08:12 +00002335
Sebastian Redl31ad7542011-03-13 17:09:40 +00002336static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002337 QualType Ty = E->getType();
2338 if (Ty->isFunctionPointerType())
2339 Ty = Ty->getAs<PointerType>()->getPointeeType();
2340 else if (Ty->isBlockPointerType())
2341 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002342
Mike Stump04c68512010-01-21 15:20:48 +00002343 const FunctionType *FT = Ty->getAs<FunctionType>();
2344 if (FT) {
2345 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002346 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00002347 Proto->isNothrow())
Mike Stump04c68512010-01-21 15:20:48 +00002348 return false;
2349 }
2350 return true;
2351}
2352
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002353CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002354 // Compute the callee type.
2355 QualType calleeType = C->getCallee()->getType();
2356 if (calleeType == Context->BoundMemberTy) {
2357 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2358
2359 // We should only get a null bound type if processing a dependent
2360 // CFG. Recover by assuming nothing.
2361 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002362 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002363
Artem Dergachev72da02f2018-04-19 23:09:22 +00002364 // FIXME: Once actually implemented, this construction context layer should
2365 // include the number of the argument as well.
2366 for (auto Arg: C->arguments()) {
2367 findConstructionContexts(
2368 ConstructionContextLayer::create(cfg->getBumpVectorContext(), C), Arg);
2369 }
2370
John McCallc67067f2011-05-11 07:19:11 +00002371 // If this is a call to a no-return function, this stops the block here.
2372 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2373
Mike Stump04c68512010-01-21 15:20:48 +00002374 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002375
2376 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002377 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002378 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002379 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002380 }
2381
Jordan Rose5374c072013-08-19 16:27:28 +00002382 // If this is a call to a builtin function, it might not actually evaluate
2383 // its arguments. Don't add them to the CFG if this is the case.
2384 bool OmitArguments = false;
2385
Mike Stump92244b02010-01-19 22:00:14 +00002386 if (FunctionDecl *FD = C->getDirectCallee()) {
Nico Weber758fbac2018-02-13 21:31:47 +00002387 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002388 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002389 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002390 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00002391 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
2392 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002393 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002394
Sebastian Redl31ad7542011-03-13 17:09:40 +00002395 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002396 AddEHEdge = false;
2397
Jordan Rose5374c072013-08-19 16:27:28 +00002398 if (OmitArguments) {
2399 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2400 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2401 autoCreateBlock();
2402 appendStmt(Block, C);
2403 return Visit(C->getCallee());
2404 }
2405
2406 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002407 autoCreateBlock();
2408 appendCall(Block, C);
2409
2410 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002411 }
Mike Stump11289f42009-09-09 15:08:12 +00002412
Mike Stump92244b02010-01-19 22:00:14 +00002413 if (Block) {
2414 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002415 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002416 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002417 }
Mike Stump11289f42009-09-09 15:08:12 +00002418
Chandler Carrutha70991b2011-09-13 09:13:49 +00002419 if (NoReturn)
2420 Block = createNoReturnBlock();
2421 else
2422 Block = createBlock();
2423
Artem Dergachev1527dec2018-03-12 23:12:40 +00002424 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002425
Mike Stump04c68512010-01-21 15:20:48 +00002426 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002427 // Add exceptional edges.
2428 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002429 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002430 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002431 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002432 }
Mike Stump11289f42009-09-09 15:08:12 +00002433
Mike Stump8c5d7992009-07-25 21:26:53 +00002434 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002435}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002436
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002437CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2438 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002439 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002440 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002441 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002442 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002443
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002444 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002445 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002446 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002447 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002448 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002449 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002450
Ted Kremenek21822592009-07-17 18:20:32 +00002451 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002452 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002453 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002454 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002455 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002456
Ted Kremenek21822592009-07-17 18:20:32 +00002457 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002458 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002459 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002460 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2461 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002462 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002463 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002464}
Mike Stump11289f42009-09-09 15:08:12 +00002465
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002466CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002467 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002468 addLocalScopeForStmt(C);
2469
Matthias Gehre09a134e2015-11-14 00:36:50 +00002470 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002471 // If the body ends with a ReturnStmt, the dtors will be added in
2472 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002473 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002474 }
2475
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002476 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002477
2478 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2479 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002480 // If we hit a segment of code just containing ';' (NullStmts), we can
2481 // get a null block back. In such cases, just use the LastBlock
2482 if (CFGBlock *newBlock = addStmt(*I))
2483 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002484
Ted Kremenekce499c22009-08-27 23:16:26 +00002485 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002486 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002487 }
Mike Stump92244b02010-01-19 22:00:14 +00002488
Ted Kremenek93668002009-07-17 22:18:43 +00002489 return LastBlock;
2490}
Mike Stump11289f42009-09-09 15:08:12 +00002491
John McCallc07a0c72011-02-17 10:25:35 +00002492CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002493 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002494 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002495 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002496
Ted Kremenek51d40b02009-07-17 18:15:54 +00002497 // Create the confluence block that will "merge" the results of the ternary
2498 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002499 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002500 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002501 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002502 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002503
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002504 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002505
Ted Kremenek51d40b02009-07-17 18:15:54 +00002506 // Create a block for the LHS expression if there is an LHS expression. A
2507 // GCC extension allows LHS to be NULL, causing the condition to be the
2508 // value that is returned instead.
2509 // e.g: x ?: y is shorthand for: x ? x : y;
2510 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002511 Block = nullptr;
2512 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002513 const Expr *trueExpr = C->getTrueExpr();
2514 if (trueExpr != opaqueValue) {
2515 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002516 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002517 return nullptr;
2518 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002519 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002520 else
2521 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002522
Ted Kremenek51d40b02009-07-17 18:15:54 +00002523 // Create the block for the RHS expression.
2524 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002525 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002526 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002527 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002528
Richard Smithf676e452012-07-24 21:02:14 +00002529 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2530 if (BinaryOperator *Cond =
2531 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2532 if (Cond->isLogicalOp())
2533 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2534
Ted Kremenek51d40b02009-07-17 18:15:54 +00002535 // Create the block that will contain the condition.
2536 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002537
Mike Stump773582d2009-07-23 23:25:26 +00002538 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002539 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002540 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2541 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002542 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002543 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002544
Ted Kremenekd8138012011-02-24 03:09:15 +00002545 if (opaqueValue) {
2546 // Run the condition expression if it's not trivially expressed in
2547 // terms of the opaque value (or if there is no opaque value).
2548 if (condExpr != opaqueValue)
2549 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002550
Ted Kremenekd8138012011-02-24 03:09:15 +00002551 // Before that, run the common subexpression if there was one.
2552 // At least one of this or the above will be run.
2553 return addStmt(BCO->getCommon());
2554 }
2555
2556 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002557}
2558
Ted Kremenek93668002009-07-17 22:18:43 +00002559CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002560 // Check if the Decl is for an __label__. If so, elide it from the
2561 // CFG entirely.
2562 if (isa<LabelDecl>(*DS->decl_begin()))
2563 return Block;
2564
Ted Kremenek3a601142011-05-24 20:41:31 +00002565 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002566 if (DS->isSingleDecl())
2567 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002568
Craig Topper25542942014-05-20 04:30:07 +00002569 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002570
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002571 // Build an individual DeclStmt for each decl.
2572 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2573 E = DS->decl_rend();
2574 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00002575 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
Benjamin Kramerc3f89252016-10-20 14:27:22 +00002576 unsigned A = alignof(DeclStmt) < 8 ? 8 : alignof(DeclStmt);
Mike Stump11289f42009-09-09 15:08:12 +00002577
Ted Kremenek93668002009-07-17 22:18:43 +00002578 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2579 // automatically freed with the CFG.
2580 DeclGroupRef DG(*I);
2581 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00002582 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00002583 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002584 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002585
Ted Kremenek93668002009-07-17 22:18:43 +00002586 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002587 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002588 }
Mike Stump11289f42009-09-09 15:08:12 +00002589
2590 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002591}
Mike Stump11289f42009-09-09 15:08:12 +00002592
Ted Kremenek93668002009-07-17 22:18:43 +00002593/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002594/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002595CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002596 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002597 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002598
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002599 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002600 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2601 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002602 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002603 }
Mike Stump11289f42009-09-09 15:08:12 +00002604
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002605 bool HasTemporaries = false;
2606
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002607 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002608 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002609
2610 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2611 // For static variables, we need to create a branch to track
2612 // whether or not they are initialized.
2613 if (Block) {
2614 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002615 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002616 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002617 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002618 }
2619 blockAfterStaticInit = Succ;
2620 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002621
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002622 // Destructors of temporaries in initialization expression should be called
2623 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002624 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002625 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002626 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002627
Jordan Rose6d671cc2012-09-05 22:55:23 +00002628 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002629 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002630 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002631 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2632 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002633 }
2634 }
2635
2636 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002637 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002638
Artem Dergachev783a4572018-02-23 22:20:39 +00002639 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002640 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002641 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002642
Ted Kremenek213d0532012-03-22 05:57:43 +00002643 // Keep track of the last non-null block, as 'Block' can be nulled out
2644 // if the initializer expression is something like a 'while' in a
2645 // statement-expression.
2646 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002647
Ted Kremenek93668002009-07-17 22:18:43 +00002648 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002649 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002650 // For expression with temporaries go directly to subexpression to omit
2651 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002652 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2653 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2654 LastBlock = newBlock;
2655 }
2656 else {
2657 if (CFGBlock *newBlock = Visit(Init))
2658 LastBlock = newBlock;
2659 }
Ted Kremenek93668002009-07-17 22:18:43 +00002660 }
Mike Stump11289f42009-09-09 15:08:12 +00002661
Ted Kremenek93668002009-07-17 22:18:43 +00002662 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002663 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002664 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002665 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2666 LastBlock = newBlock;
2667 }
Mike Stump11289f42009-09-09 15:08:12 +00002668
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002669 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2670
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002671 // Remove variable from local scope.
2672 if (ScopePos && VD == *ScopePos)
2673 ++ScopePos;
2674
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002675 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002676 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002677 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002678 Block = createBlock(false);
2679 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002680 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002681 addSuccessor(Block, B);
2682 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002683 }
2684
2685 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002686}
2687
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002688CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002689 // We may see an if statement in the middle of a basic block, or it may be the
2690 // first statement we are processing. In either case, we create a new basic
2691 // block. First, we create the blocks for the then...else statements, and
2692 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002693 // middle of a block, we stop processing that block. That block is then the
2694 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002695
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002696 // Save local scope position because in case of condition variable ScopePos
2697 // won't be restored when traversing AST.
2698 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2699
Richard Smitha547eb22016-07-14 00:11:03 +00002700 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002701 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002702 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002703
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002704 // Create local scope for possible condition variable.
2705 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002706 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002707 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002708
Matthias Gehre351c2182017-07-12 07:04:19 +00002709 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002710
Chris Lattner57540c52011-04-15 05:22:18 +00002711 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002712 // block.
2713 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002714 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002715 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002716 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002717 }
Mike Stump31feda52009-07-17 01:31:16 +00002718
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002719 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002720 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002721
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002722 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002723 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002724
Ted Kremenek9aae5132007-08-23 21:42:29 +00002725 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002726 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002727 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002728
2729 // If branch is not a compound statement create implicit scope
2730 // and add destructors.
2731 if (!isa<CompoundStmt>(Else))
2732 addLocalScopeAndDtors(Else);
2733
Ted Kremenek93668002009-07-17 22:18:43 +00002734 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002735
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002736 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2737 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002738 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002739 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002740 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002741 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002742 }
Mike Stump31feda52009-07-17 01:31:16 +00002743
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002744 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002745 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002746 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002747 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002748 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002749 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002750 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002751
2752 // If branch is not a compound statement create implicit scope
2753 // and add destructors.
2754 if (!isa<CompoundStmt>(Then))
2755 addLocalScopeAndDtors(Then);
2756
Ted Kremenek93668002009-07-17 22:18:43 +00002757 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002758
Ted Kremenek1b379512009-04-01 03:52:47 +00002759 if (!ThenBlock) {
2760 // We can reach here if the "then" body has all NullStmts.
2761 // Create an empty block so we can distinguish between true and false
2762 // branches in path-sensitive analyses.
2763 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002764 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002765 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002766 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002767 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002768 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002769 }
2770
Ted Kremenekb50e7162012-07-14 05:04:10 +00002771 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2772 // having these handle the actual control-flow jump. Note that
2773 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2774 // we resort to the old control-flow behavior. This special handling
2775 // removes infeasible paths from the control-flow graph by having the
2776 // control-flow transfer of '&&' or '||' go directly into the then/else
2777 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002778 BinaryOperator *Cond =
2779 I->getConditionVariable()
2780 ? nullptr
2781 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2782 CFGBlock *LastBlock;
2783 if (Cond && Cond->isLogicalOp())
2784 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2785 else {
2786 // Now create a new block containing the if statement.
2787 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002788
Richard Smith509bbd12017-01-13 22:16:41 +00002789 // Set the terminator of the new block to the If statement.
2790 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002791
Richard Smith509bbd12017-01-13 22:16:41 +00002792 // See if this is a known constant.
2793 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002794
Richard Smith509bbd12017-01-13 22:16:41 +00002795 // Add the successors. If we know that specific branches are
2796 // unreachable, inform addSuccessor() of that knowledge.
2797 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2798 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002799
Richard Smith509bbd12017-01-13 22:16:41 +00002800 // Add the condition as the last statement in the new block. This may
2801 // create new blocks as the condition may contain control-flow. Any newly
2802 // created blocks will be pointed to be "Block".
2803 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002804
Richard Smith509bbd12017-01-13 22:16:41 +00002805 // If the IfStmt contains a condition variable, add it and its
2806 // initializer to the CFG.
2807 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2808 autoCreateBlock();
2809 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2810 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002811 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002812
Richard Smitha547eb22016-07-14 00:11:03 +00002813 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2814 if (Stmt *Init = I->getInit()) {
2815 autoCreateBlock();
2816 LastBlock = addStmt(Init);
2817 }
2818
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002819 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002820}
Mike Stump31feda52009-07-17 01:31:16 +00002821
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002822CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002823 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002824 //
Mike Stump31feda52009-07-17 01:31:16 +00002825 // NOTE: If a "return" appears in the middle of a block, this means that the
2826 // code afterwards is DEAD (unreachable). We still keep a basic block
2827 // for that code; a simple "mark-and-sweep" from the entry block will be
2828 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002829
2830 // Create the new block.
2831 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002832
Matthias Gehre351c2182017-07-12 07:04:19 +00002833 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002834
Artem Dergachev783a4572018-02-23 22:20:39 +00002835 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002836 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
Artem Dergachev783a4572018-02-23 22:20:39 +00002837 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002838
Pavel Labath921e7652013-09-06 08:12:48 +00002839 // If the one of the destructors does not return, we already have the Exit
2840 // block as a successor.
2841 if (!Block->hasNoReturnElement())
2842 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002843
2844 // Add the return statement to the block. This may create new blocks if R
2845 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002846 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002847}
2848
Nico Weber699670e2017-08-23 15:33:16 +00002849CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2850 // SEHExceptStmt are treated like labels, so they are the first statement in a
2851 // block.
2852
2853 // Save local scope position because in case of exception variable ScopePos
2854 // won't be restored when traversing AST.
2855 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2856
2857 addStmt(ES->getBlock());
2858 CFGBlock *SEHExceptBlock = Block;
2859 if (!SEHExceptBlock)
2860 SEHExceptBlock = createBlock();
2861
2862 appendStmt(SEHExceptBlock, ES);
2863
2864 // Also add the SEHExceptBlock as a label, like with regular labels.
2865 SEHExceptBlock->setLabel(ES);
2866
2867 // Bail out if the CFG is bad.
2868 if (badCFG)
2869 return nullptr;
2870
2871 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2872 Block = nullptr;
2873
2874 return SEHExceptBlock;
2875}
2876
2877CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2878 return VisitCompoundStmt(FS->getBlock());
2879}
2880
2881CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2882 // "__leave" is a control-flow statement. Thus we stop processing the current
2883 // block.
2884 if (badCFG)
2885 return nullptr;
2886
2887 // Now create a new block that ends with the __leave statement.
2888 Block = createBlock(false);
2889 Block->setTerminator(LS);
2890
2891 // If there is no target for the __leave, then we are looking at an incomplete
2892 // AST. This means that the CFG cannot be constructed.
2893 if (SEHLeaveJumpTarget.block) {
2894 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2895 addSuccessor(Block, SEHLeaveJumpTarget.block);
2896 } else
2897 badCFG = true;
2898
2899 return Block;
2900}
2901
2902CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2903 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2904 // processing the current block.
2905 CFGBlock *SEHTrySuccessor = nullptr;
2906
2907 if (Block) {
2908 if (badCFG)
2909 return nullptr;
2910 SEHTrySuccessor = Block;
2911 } else SEHTrySuccessor = Succ;
2912
2913 // FIXME: Implement __finally support.
2914 if (Terminator->getFinallyHandler())
2915 return NYS();
2916
2917 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2918
2919 // Create a new block that will contain the __try statement.
2920 CFGBlock *NewTryTerminatedBlock = createBlock(false);
2921
2922 // Add the terminator in the __try block.
2923 NewTryTerminatedBlock->setTerminator(Terminator);
2924
2925 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
2926 // The code after the try is the implicit successor if there's an __except.
2927 Succ = SEHTrySuccessor;
2928 Block = nullptr;
2929 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
2930 if (!ExceptBlock)
2931 return nullptr;
2932 // Add this block to the list of successors for the block with the try
2933 // statement.
2934 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
2935 }
2936 if (PrevSEHTryTerminatedBlock)
2937 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
2938 else
2939 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
2940
2941 // The code after the try is the implicit successor.
2942 Succ = SEHTrySuccessor;
2943
2944 // Save the current "__try" context.
2945 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
2946 NewTryTerminatedBlock);
2947 cfg->addTryDispatchBlock(TryTerminatedBlock);
2948
2949 // Save the current value for the __leave target.
2950 // All __leaves should go to the code following the __try
2951 // (FIXME: or if the __try has a __finally, to the __finally.)
2952 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
2953 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
2954
2955 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
2956 Block = nullptr;
2957 return addStmt(Terminator->getTryBlock());
2958}
2959
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002960CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002961 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002962 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002963 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002964
Ted Kremenek93668002009-07-17 22:18:43 +00002965 if (!LabelBlock) // This can happen when the body is empty, i.e.
2966 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002967
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002968 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2969 "label already in map");
2970 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002971
2972 // Labels partition blocks, so this is the end of the basic block we were
2973 // processing (L is the block's label). Because this is label (and we have
2974 // already processed the substatement) there is no extra control-flow to worry
2975 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002976 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002977 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002978 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002979
2980 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002981 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002982
Ted Kremenek9aae5132007-08-23 21:42:29 +00002983 // This block is now the implicit successor of other blocks.
2984 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002985
Ted Kremenek9aae5132007-08-23 21:42:29 +00002986 return LabelBlock;
2987}
2988
Devin Coughlinb6029b72015-11-25 22:35:37 +00002989CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
2990 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2991 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
2992 if (Expr *CopyExpr = CI.getCopyExpr()) {
2993 CFGBlock *Tmp = Visit(CopyExpr);
2994 if (Tmp)
2995 LastBlock = Tmp;
2996 }
2997 }
2998 return LastBlock;
2999}
3000
Ted Kremenekda76a942012-04-12 20:34:52 +00003001CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
3002 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3003 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
3004 et = E->capture_init_end(); it != et; ++it) {
3005 if (Expr *Init = *it) {
3006 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00003007 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00003008 LastBlock = Tmp;
3009 }
3010 }
3011 return LastBlock;
3012}
3013
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003014CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003015 // Goto is a control-flow statement. Thus we stop processing the current
3016 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003017
Ted Kremenek9aae5132007-08-23 21:42:29 +00003018 Block = createBlock(false);
3019 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003020
3021 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003022 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003023
Ted Kremenek9aae5132007-08-23 21:42:29 +00003024 if (I == LabelMap.end())
3025 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003026 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3027 else {
3028 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003029 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003030 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003031 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003032
Mike Stump31feda52009-07-17 01:31:16 +00003033 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003034}
3035
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003036CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003037 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003038
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003039 // Save local scope position because in case of condition variable ScopePos
3040 // won't be restored when traversing AST.
3041 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3042
3043 // Create local scope for init statement and possible condition variable.
3044 // Add destructor for init statement and condition variable.
3045 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003046 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003047 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003048 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3049
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003050 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003051 addLocalScopeForVarDecl(VD);
3052 LocalScope::const_iterator ContinueScopePos = ScopePos;
3053
Matthias Gehre351c2182017-07-12 07:04:19 +00003054 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003055
Peter Szecsi999a25f2017-08-19 11:19:16 +00003056 addLoopExit(F);
3057
Mike Stump014b3ea2009-07-21 01:12:51 +00003058 // "for" is a control-flow statement. Thus we stop processing the current
3059 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003060 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003061 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003062 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003063 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003064 } else
3065 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003066
Ted Kremenek304a9532010-05-21 20:30:15 +00003067 // Save the current value for the break targets.
3068 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003069 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003070 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003071
Craig Topper25542942014-05-20 04:30:07 +00003072 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003073
Ted Kremenek9aae5132007-08-23 21:42:29 +00003074 // Now create the loop body.
3075 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003076 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003077
Ted Kremenekb50e7162012-07-14 05:04:10 +00003078 // Save the current values for Block, Succ, continue and break targets.
3079 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3080 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003081
Ted Kremenekb50e7162012-07-14 05:04:10 +00003082 // Create an empty block to represent the transition block for looping back
3083 // to the head of the loop. If we have increment code, it will
3084 // go in this block as well.
3085 Block = Succ = TransitionBlock = createBlock(false);
3086 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003087
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003088 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003089 // Generate increment code in its own basic block. This is the target of
3090 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003091 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003092 }
Mike Stump31feda52009-07-17 01:31:16 +00003093
Ted Kremenek902393b2009-04-28 00:51:56 +00003094 // Finish up the increment (or empty) block if it hasn't been already.
3095 if (Block) {
3096 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003097 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003098 return nullptr;
3099 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003100 }
Mike Stump31feda52009-07-17 01:31:16 +00003101
Ted Kremenekb50e7162012-07-14 05:04:10 +00003102 // The starting block for the loop increment is the block that should
3103 // represent the 'loop target' for looping back to the start of the loop.
3104 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3105 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003106
Ted Kremenekb50e7162012-07-14 05:04:10 +00003107 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003108 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003109
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003110 // If body is not a compound statement create implicit scope
3111 // and add destructors.
3112 if (!isa<CompoundStmt>(F->getBody()))
3113 addLocalScopeAndDtors(F->getBody());
3114
Mike Stump31feda52009-07-17 01:31:16 +00003115 // Now populate the body block, and in the process create new blocks as we
3116 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003117 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003118
Ted Kremenekb50e7162012-07-14 05:04:10 +00003119 if (!BodyBlock) {
3120 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3121 // Use the continue jump target as the proxy for the body.
3122 BodyBlock = ContinueJumpTarget.block;
3123 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003124 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003125 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003126 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00003127
3128 // Because of short-circuit evaluation, the condition of the loop can span
3129 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3130 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003131 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003132
Ted Kremenekb50e7162012-07-14 05:04:10 +00003133 do {
3134 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003135 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003136
3137 // Specially handle logical operators, which have a slightly
3138 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003139 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003140 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003141 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003142 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003143 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3144 break;
3145 }
3146
3147 // The default case when not handling logical operators.
3148 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3149 ExitConditionBlock->setTerminator(F);
3150
3151 // See if this is a known constant.
3152 TryResult KnownVal(true);
3153
3154 if (C) {
3155 // Now add the actual condition to the condition block.
3156 // Because the condition itself may contain control-flow, new blocks may
3157 // be created. Thus we update "Succ" after adding the condition.
3158 Block = ExitConditionBlock;
3159 EntryConditionBlock = addStmt(C);
3160
3161 // If this block contains a condition variable, add both the condition
3162 // variable and initializer to the CFG.
3163 if (VarDecl *VD = F->getConditionVariable()) {
3164 if (Expr *Init = VD->getInit()) {
3165 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003166 const DeclStmt *DS = F->getConditionVariableDeclStmt();
3167 assert(DS->isSingleDecl());
3168 findConstructionContexts(
3169 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3170 const_cast<DeclStmt *>(DS)),
3171 Init);
3172 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003173 EntryConditionBlock = addStmt(Init);
3174 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003175 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003176 }
3177 }
3178
3179 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003180 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003181
3182 KnownVal = tryEvaluateBool(C);
3183 }
3184
3185 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003186 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003187 // Link up the condition block with the code that follows the loop. (the
3188 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003189 addSuccessor(ExitConditionBlock,
3190 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003191 } while (false);
3192
3193 // Link up the loop-back block to the entry condition block.
3194 addSuccessor(TransitionBlock, EntryConditionBlock);
3195
3196 // The condition block is the implicit successor for any code above the loop.
3197 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003198
Ted Kremenek9aae5132007-08-23 21:42:29 +00003199 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003200 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003201 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003202 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3203 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003204 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003205 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003206 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003207
3208 // There is no loop initialization. We are thus basically a while loop.
3209 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003210 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003211 Succ = EntryConditionBlock;
3212 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003213}
3214
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003215CFGBlock *
3216CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3217 AddStmtChoice asc) {
3218 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003219 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003220 MTE->getTemporary());
3221
3222 return VisitStmt(MTE, asc);
3223}
3224
Ted Kremenek5868ec62010-04-11 17:02:10 +00003225CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003226 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003227 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003228 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003229 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003230 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003231}
3232
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003233CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003234 // Objective-C fast enumeration 'for' statements:
3235 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3236 //
3237 // for ( Type newVariable in collection_expression ) { statements }
3238 //
3239 // becomes:
3240 //
3241 // prologue:
3242 // 1. collection_expression
3243 // T. jump to loop_entry
3244 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003245 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003246 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3247 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3248 // TB:
3249 // statements
3250 // T. jump to loop_entry
3251 // FB:
3252 // what comes after
3253 //
3254 // and
3255 //
3256 // Type existingItem;
3257 // for ( existingItem in expression ) { statements }
3258 //
3259 // becomes:
3260 //
Mike Stump31feda52009-07-17 01:31:16 +00003261 // the same with newVariable replaced with existingItem; the binding works
3262 // the same except that for one ObjCForCollectionStmt::getElement() returns
3263 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003264
Craig Topper25542942014-05-20 04:30:07 +00003265 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003266
Ted Kremenek9d56e642008-11-11 17:10:00 +00003267 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003268 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003269 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003270 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003271 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003272 } else
3273 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003274
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003275 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003276 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003277
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003278 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003279 ExitConditionBlock->setTerminator(S);
3280
3281 // The last statement in the block should be the ObjCForCollectionStmt, which
3282 // performs the actual binding to 'element' and determines if there are any
3283 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003284 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003285 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003286
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003287 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003288 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003289 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003290 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3291 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003292 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003293 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003294 return nullptr;
3295 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003296 }
Mike Stump31feda52009-07-17 01:31:16 +00003297
3298 // The condition block is the implicit successor for the loop body as well as
3299 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003300 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003301
Ted Kremenek9d56e642008-11-11 17:10:00 +00003302 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003303 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003304 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003305 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003306 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003307 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003308
Anna Zaks56b49752013-06-22 00:23:20 +00003309 // Add an intermediate block between the BodyBlock and the
3310 // EntryConditionBlock to represent the "loop back" transition, for looping
3311 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003312 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003313 Succ = LoopBackBlock = createBlock();
3314 LoopBackBlock->setLoopTarget(S);
3315
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003316 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003317 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003318
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003319 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003320
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003321 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003322 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003323 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003324 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003325 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003326 }
Mike Stump31feda52009-07-17 01:31:16 +00003327
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003328 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003329 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003330 }
Mike Stump31feda52009-07-17 01:31:16 +00003331
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003332 // Link up the condition block with the code that follows the loop.
3333 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003334 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003335
Ted Kremenek9d56e642008-11-11 17:10:00 +00003336 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003337 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003338 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003339}
3340
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003341CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3342 // Inline the body.
3343 return addStmt(S->getSubStmt());
3344 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3345}
3346
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003347CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003348 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003349
Ted Kremenek49805452009-05-02 01:49:13 +00003350 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003351 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003352
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003353 // The sync body starts its own basic block. This makes it a little easier
3354 // for diagnostic clients.
3355 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003356 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003357 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003358
Craig Topper25542942014-05-20 04:30:07 +00003359 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003360 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003361 }
Mike Stump31feda52009-07-17 01:31:16 +00003362
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003363 // Add the @synchronized to the CFG.
3364 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003365 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003366
Ted Kremenek49805452009-05-02 01:49:13 +00003367 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003368 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003369}
Mike Stump31feda52009-07-17 01:31:16 +00003370
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003371CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003372 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003373 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003374}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003375
John McCallfe96e0b2011-11-06 09:01:30 +00003376CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3377 autoCreateBlock();
3378
3379 // Add the PseudoObject as the last thing.
3380 appendStmt(Block, E);
3381
3382 CFGBlock *lastBlock = Block;
3383
3384 // Before that, evaluate all of the semantics in order. In
3385 // CFG-land, that means appending them in reverse order.
3386 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3387 Expr *Semantic = E->getSemanticExpr(--i);
3388
3389 // If the semantic is an opaque value, we're being asked to bind
3390 // it to its source expression.
3391 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3392 Semantic = OVE->getSourceExpr();
3393
3394 if (CFGBlock *B = Visit(Semantic))
3395 lastBlock = B;
3396 }
3397
3398 return lastBlock;
3399}
3400
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003401CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003402 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003403
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003404 // Save local scope position because in case of condition variable ScopePos
3405 // won't be restored when traversing AST.
3406 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3407
3408 // Create local scope for possible condition variable.
3409 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003410 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003411 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003412 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003413 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003414 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003415 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003416
Mike Stump014b3ea2009-07-21 01:12:51 +00003417 // "while" is a control-flow statement. Thus we stop processing the current
3418 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003419 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003420 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003421 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003422 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003423 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003424 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003425 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003426 }
Mike Stump31feda52009-07-17 01:31:16 +00003427
Craig Topper25542942014-05-20 04:30:07 +00003428 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003429
Ted Kremenek9aae5132007-08-23 21:42:29 +00003430 // Process the loop body.
3431 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003432 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003433
Ted Kremenekb50e7162012-07-14 05:04:10 +00003434 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003435 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3436 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003437 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003438
Mike Stump31feda52009-07-17 01:31:16 +00003439 // Create an empty block to represent the transition block for looping back
3440 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003441 Succ = TransitionBlock = createBlock(false);
3442 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003443 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003444
Ted Kremenek9aae5132007-08-23 21:42:29 +00003445 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003446 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003447
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003448 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003449 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003450
3451 // If body is not a compound statement create implicit scope
3452 // and add destructors.
3453 if (!isa<CompoundStmt>(W->getBody()))
3454 addLocalScopeAndDtors(W->getBody());
3455
Ted Kremenek9aae5132007-08-23 21:42:29 +00003456 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003457 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003458
Ted Kremeneke9610502007-08-30 18:39:40 +00003459 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003460 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003461 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003462 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003463 }
3464
3465 // Because of short-circuit evaluation, the condition of the loop can span
3466 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3467 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003468 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003469
3470 do {
3471 Expr *C = W->getCond();
3472
3473 // Specially handle logical operators, which have a slightly
3474 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003475 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003476 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003477 std::tie(EntryConditionBlock, ExitConditionBlock) =
3478 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003479 break;
3480 }
3481
3482 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003483 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003484 ExitConditionBlock->setTerminator(W);
3485
3486 // Now add the actual condition to the condition block.
3487 // Because the condition itself may contain control-flow, new blocks may
3488 // be created. Thus we update "Succ" after adding the condition.
3489 Block = ExitConditionBlock;
3490 Block = EntryConditionBlock = addStmt(C);
3491
3492 // If this block contains a condition variable, add both the condition
3493 // variable and initializer to the CFG.
3494 if (VarDecl *VD = W->getConditionVariable()) {
3495 if (Expr *Init = VD->getInit()) {
3496 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003497 const DeclStmt *DS = W->getConditionVariableDeclStmt();
3498 assert(DS->isSingleDecl());
3499 findConstructionContexts(
3500 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3501 const_cast<DeclStmt *>(DS)),
3502 Init);
3503 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003504 EntryConditionBlock = addStmt(Init);
3505 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003506 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003507 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003508 }
Mike Stump31feda52009-07-17 01:31:16 +00003509
Ted Kremenekb50e7162012-07-14 05:04:10 +00003510 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003511 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003512
3513 // See if this is a known constant.
3514 const TryResult& KnownVal = tryEvaluateBool(C);
3515
Ted Kremenek30754282009-07-24 04:47:11 +00003516 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003517 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003518 // Link up the condition block with the code that follows the loop. (the
3519 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003520 addSuccessor(ExitConditionBlock,
3521 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003522 } while(false);
3523
3524 // Link up the loop-back block to the entry condition block.
3525 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003526
3527 // There can be no more statements in the condition block since we loop back
3528 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003529 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003530
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003531 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003532 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003533 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003534}
Mike Stump11289f42009-09-09 15:08:12 +00003535
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003536CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003537 // FIXME: For now we pretend that @catch and the code it contains does not
3538 // exit.
3539 return Block;
3540}
Mike Stump31feda52009-07-17 01:31:16 +00003541
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003542CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003543 // FIXME: This isn't complete. We basically treat @throw like a return
3544 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003545
Ted Kremenek0868eea2009-09-24 18:45:41 +00003546 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003547 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003548 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003549
Ted Kremenek93041ba2008-12-09 20:20:09 +00003550 // Create the new block.
3551 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003552
Ted Kremenek93041ba2008-12-09 20:20:09 +00003553 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003554 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003555
3556 // Add the statement to the block. This may create new blocks if S contains
3557 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003558 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003559}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003560
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003561CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003562 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003563 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003564 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003565
3566 // Create the new block.
3567 Block = createBlock(false);
3568
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003569 if (TryTerminatedBlock)
3570 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003571 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003572 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003573 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003574 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003575
3576 // Add the statement to the block. This may create new blocks if S contains
3577 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003578 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003579}
3580
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003581CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003582 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003583
Peter Szecsi999a25f2017-08-19 11:19:16 +00003584 addLoopExit(D);
3585
Mike Stump8d50b6a2009-07-21 01:27:50 +00003586 // "do...while" is a control-flow statement. Thus we stop processing the
3587 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003588 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003589 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003590 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003591 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003592 } else
3593 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003594
3595 // Because of short-circuit evaluation, the condition of the loop can span
3596 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3597 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003598 CFGBlock *ExitConditionBlock = createBlock(false);
3599 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003600
Ted Kremenek81e14852007-08-27 19:46:09 +00003601 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003602 ExitConditionBlock->setTerminator(D);
3603
3604 // Now add the actual condition to the condition block. Because the condition
3605 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003606 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003607 Block = ExitConditionBlock;
3608 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003609 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003610 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003611 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003612 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003613 }
Mike Stump31feda52009-07-17 01:31:16 +00003614
Ted Kremeneka1523a32008-02-27 07:20:00 +00003615 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003616 Succ = EntryConditionBlock;
3617
Mike Stump773582d2009-07-23 23:25:26 +00003618 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003619 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003620
Ted Kremenek9aae5132007-08-23 21:42:29 +00003621 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003622 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003623 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003624 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003625
Ted Kremenek9aae5132007-08-23 21:42:29 +00003626 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003627 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3628 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3629 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003630
Ted Kremenek9aae5132007-08-23 21:42:29 +00003631 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003632 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003633
Ted Kremenek9aae5132007-08-23 21:42:29 +00003634 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003635 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003636
Ted Kremenek9aae5132007-08-23 21:42:29 +00003637 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003638 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003639
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003640 // If body is not a compound statement create implicit scope
3641 // and add destructors.
3642 if (!isa<CompoundStmt>(D->getBody()))
3643 addLocalScopeAndDtors(D->getBody());
3644
Ted Kremenek9aae5132007-08-23 21:42:29 +00003645 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003646 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003647
Ted Kremeneke9610502007-08-30 18:39:40 +00003648 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003649 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003650 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003651 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003652 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003653 }
Mike Stump31feda52009-07-17 01:31:16 +00003654
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003655 // Add an intermediate block between the BodyBlock and the
3656 // ExitConditionBlock to represent the "loop back" transition. Create an
3657 // empty block to represent the transition block for looping back to the
3658 // head of the loop.
3659 // FIXME: Can we do this more efficiently without adding another block?
3660 Block = nullptr;
3661 Succ = BodyBlock;
3662 CFGBlock *LoopBackBlock = createBlock();
3663 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003664
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003665 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003666 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003667 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003668 else
Craig Topper25542942014-05-20 04:30:07 +00003669 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003670 }
Mike Stump31feda52009-07-17 01:31:16 +00003671
Ted Kremenek30754282009-07-24 04:47:11 +00003672 // Link up the condition block with the code that follows the loop.
3673 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003674 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003675
3676 // There can be no more statements in the body block(s) since we loop back to
3677 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003678 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003679
Ted Kremenek9aae5132007-08-23 21:42:29 +00003680 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003681 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003682 return BodyBlock;
3683}
3684
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003685CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003686 // "continue" is a control-flow statement. Thus we stop processing the
3687 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003688 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003689 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003690
Ted Kremenek9aae5132007-08-23 21:42:29 +00003691 // Now create a new block that ends with the continue statement.
3692 Block = createBlock(false);
3693 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003694
Ted Kremenek9aae5132007-08-23 21:42:29 +00003695 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003696 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003697 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003698 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003699 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003700 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003701 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003702
Ted Kremenek9aae5132007-08-23 21:42:29 +00003703 return Block;
3704}
Mike Stump11289f42009-09-09 15:08:12 +00003705
Peter Collingbournee190dee2011-03-11 19:24:49 +00003706CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3707 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003708 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003709 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003710 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003711 }
Mike Stump11289f42009-09-09 15:08:12 +00003712
Ted Kremenek93668002009-07-17 22:18:43 +00003713 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003714 CFGBlock *lastBlock = Block;
3715
Ted Kremenek93668002009-07-17 22:18:43 +00003716 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003717 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003718 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003719 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003720 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003721 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003722}
Mike Stump11289f42009-09-09 15:08:12 +00003723
Ted Kremenek93668002009-07-17 22:18:43 +00003724/// VisitStmtExpr - Utility method to handle (nested) statement
3725/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003726CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003727 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003728 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003729 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003730 }
Ted Kremenek93668002009-07-17 22:18:43 +00003731 return VisitCompoundStmt(SE->getSubStmt());
3732}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003733
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003734CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003735 // "switch" is a control-flow statement. Thus we stop processing the current
3736 // block.
Craig Topper25542942014-05-20 04:30:07 +00003737 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003738
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003739 // Save local scope position because in case of condition variable ScopePos
3740 // won't be restored when traversing AST.
3741 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3742
Richard Smitha547eb22016-07-14 00:11:03 +00003743 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003744 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003745 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003746
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003747 // Create local scope for possible condition variable.
3748 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003749 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003750 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003751
Matthias Gehre351c2182017-07-12 07:04:19 +00003752 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003753
Ted Kremenek9aae5132007-08-23 21:42:29 +00003754 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003755 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003756 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003757 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003758 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003759
3760 // Save the current "switch" context.
3761 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003762 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003763 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003764
Mike Stump31feda52009-07-17 01:31:16 +00003765 // Set the "default" case to be the block after the switch statement. If the
3766 // switch statement contains a "default:", this value will be overwritten with
3767 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003768 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003769
Ted Kremenek9aae5132007-08-23 21:42:29 +00003770 // Create a new block that will contain the switch statement.
3771 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003772
Ted Kremenek9aae5132007-08-23 21:42:29 +00003773 // Now process the switch body. The code after the switch is the implicit
3774 // successor.
3775 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003776 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003777
3778 // When visiting the body, the case statements should automatically get linked
3779 // up to the switch. We also don't keep a pointer to the body, since all
3780 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003781 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003782 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003783
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003784 // For pruning unreachable case statements, save the current state
3785 // for tracking the condition value.
3786 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3787 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003788
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003789 // Determine if the switch condition can be explicitly evaluated.
3790 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003791 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003792 bool b = tryEvaluate(Terminator->getCond(), result);
3793 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003794 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003795
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003796 // If body is not a compound statement create implicit scope
3797 // and add destructors.
3798 if (!isa<CompoundStmt>(Terminator->getBody()))
3799 addLocalScopeAndDtors(Terminator->getBody());
3800
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003801 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003802 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003803 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003804 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003805 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003806
Mike Stump31feda52009-07-17 01:31:16 +00003807 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003808 // following the switch body. Moreover, take into account if all the
3809 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003810 //
3811 // Note: We add a successor to a switch that is considered covered yet has no
3812 // case statements if the enumeration has no enumerators.
3813 bool SwitchAlwaysHasSuccessor = false;
3814 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3815 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3816 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003817 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3818 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003819
Ted Kremenek81e14852007-08-27 19:46:09 +00003820 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003821 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003822 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003823 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003824
Richard Smitha547eb22016-07-14 00:11:03 +00003825 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003826 // SwitchStmt and the condition variable initialization to the CFG.
3827 if (VarDecl *VD = Terminator->getConditionVariable()) {
3828 if (Expr *Init = VD->getInit()) {
3829 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003830 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003831 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003832 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003833 }
3834 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003835
Richard Smitha547eb22016-07-14 00:11:03 +00003836 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3837 if (Stmt *Init = Terminator->getInit()) {
3838 autoCreateBlock();
3839 LastBlock = addStmt(Init);
3840 }
3841
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003842 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003843}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003844
3845static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003846 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003847 const CaseStmt *CS,
3848 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003849 if (!switchCond)
3850 return true;
3851
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003852 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003853
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003854 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003855 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003856 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003857 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003858 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003859
3860 if (condInt == lhsInt) {
3861 addCase = true;
3862 switchExclusivelyCovered = true;
3863 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003864 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003865 if (const Expr *RHS = CS->getRHS()) {
3866 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003867 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003868 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003869 addCase = true;
3870 switchExclusivelyCovered = true;
3871 }
3872 }
3873 }
3874 }
3875 else
3876 addCase = true;
3877 }
3878 return addCase;
3879}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003880
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003881CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003882 // CaseStmts are essentially labels, so they are the first statement in a
3883 // block.
Craig Topper25542942014-05-20 04:30:07 +00003884 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003885
Ted Kremenek60fa6572010-08-04 23:54:30 +00003886 if (Stmt *Sub = CS->getSubStmt()) {
3887 // For deeply nested chains of CaseStmts, instead of doing a recursion
3888 // (which can blow out the stack), manually unroll and create blocks
3889 // along the way.
3890 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003891 CFGBlock *currentBlock = createBlock(false);
3892 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003893
Ted Kremenek60fa6572010-08-04 23:54:30 +00003894 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003895 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003896 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003897 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003898
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003899 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003900 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003901 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003902 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003903
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003904 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003905 CS = cast<CaseStmt>(Sub);
3906 Sub = CS->getSubStmt();
3907 }
3908
3909 addStmt(Sub);
3910 }
Mike Stump11289f42009-09-09 15:08:12 +00003911
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003912 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003913 if (!CaseBlock)
3914 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003915
3916 // Cases statements partition blocks, so this is the top of the basic block we
3917 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003918 CaseBlock->setLabel(CS);
3919
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003920 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003921 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003922
3923 // Add this block to the list of successors for the block with the switch
3924 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003925 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003926 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003927 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003928 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003929
Ted Kremenek9aae5132007-08-23 21:42:29 +00003930 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003931 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003932
Ted Kremenek60fa6572010-08-04 23:54:30 +00003933 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003934 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003935 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003936 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003937 // This block is now the implicit successor of other blocks.
3938 Succ = CaseBlock;
3939 }
Mike Stump31feda52009-07-17 01:31:16 +00003940
Ted Kremenek60fa6572010-08-04 23:54:30 +00003941 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003942}
Mike Stump31feda52009-07-17 01:31:16 +00003943
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003944CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003945 if (Terminator->getSubStmt())
3946 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003947
Ted Kremenek654c78f2008-02-13 22:05:39 +00003948 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003949
3950 if (!DefaultCaseBlock)
3951 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003952
3953 // Default statements partition blocks, so this is the top of the basic block
3954 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003955 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003956
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003957 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003958 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003959
Mike Stump31feda52009-07-17 01:31:16 +00003960 // Unlike case statements, we don't add the default block to the successors
3961 // for the switch statement immediately. This is done when we finish
3962 // processing the switch statement. This allows for the default case
3963 // (including a fall-through to the code after the switch statement) to always
3964 // be the last successor of a switch-terminated block.
3965
Ted Kremenek654c78f2008-02-13 22:05:39 +00003966 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003967 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003968
Ted Kremenek654c78f2008-02-13 22:05:39 +00003969 // This block is now the implicit successor of other blocks.
3970 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003971
3972 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003973}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003974
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003975CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3976 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3977 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003978 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003979
3980 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003981 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003982 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003983 TrySuccessor = Block;
3984 } else TrySuccessor = Succ;
3985
Mike Stump0bdba6c2010-01-20 01:15:34 +00003986 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003987
3988 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003989 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003990 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003991 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003992
Mike Stump0bdba6c2010-01-20 01:15:34 +00003993 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003994 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3995 // The code after the try is the implicit successor.
3996 Succ = TrySuccessor;
3997 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003998 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003999 HasCatchAll = true;
4000 }
Craig Topper25542942014-05-20 04:30:07 +00004001 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004002 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00004003 if (!CatchBlock)
4004 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004005 // Add this block to the list of successors for the block with the try
4006 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004007 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004008 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00004009 if (!HasCatchAll) {
4010 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004011 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00004012 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004013 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00004014 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004015
4016 // The code after the try is the implicit successor.
4017 Succ = TrySuccessor;
4018
Mike Stump845384a2010-01-20 01:30:58 +00004019 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00004020 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
4021 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00004022
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004023 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004024 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004025 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004026}
4027
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004028CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004029 // CXXCatchStmt are treated like labels, so they are the first statement in a
4030 // block.
4031
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004032 // Save local scope position because in case of exception variable ScopePos
4033 // won't be restored when traversing AST.
4034 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4035
4036 // Create local scope for possible exception variable.
4037 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004038 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004039 LocalScope::const_iterator BeginScopePos = ScopePos;
4040 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004041 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004042 }
4043
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004044 if (CS->getHandlerBlock())
4045 addStmt(CS->getHandlerBlock());
4046
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004047 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004048 if (!CatchBlock)
4049 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004050
4051 // CXXCatchStmt is more than just a label. They have semantic meaning
4052 // as well, as they implicitly "initialize" the catch variable. Add
4053 // it to the CFG as a CFGElement so that the control-flow of these
4054 // semantics gets captured.
4055 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004056
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004057 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4058 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004059 CatchBlock->setLabel(CS);
4060
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004061 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004062 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004063 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004064
4065 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004066 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004067
4068 return CatchBlock;
4069}
4070
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004071CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004072 // C++0x for-range statements are specified as [stmt.ranged]:
4073 //
4074 // {
4075 // auto && __range = range-init;
4076 // for ( auto __begin = begin-expr,
4077 // __end = end-expr;
4078 // __begin != __end;
4079 // ++__begin ) {
4080 // for-range-declaration = *__begin;
4081 // statement
4082 // }
4083 // }
4084
4085 // Save local scope position before the addition of the implicit variables.
4086 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4087
4088 // Create local scopes and destructors for range, begin and end variables.
4089 if (Stmt *Range = S->getRangeStmt())
4090 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004091 if (Stmt *Begin = S->getBeginStmt())
4092 addLocalScopeForStmt(Begin);
4093 if (Stmt *End = S->getEndStmt())
4094 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004095 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004096
4097 LocalScope::const_iterator ContinueScopePos = ScopePos;
4098
4099 // "for" is a control-flow statement. Thus we stop processing the current
4100 // block.
Craig Topper25542942014-05-20 04:30:07 +00004101 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004102 if (Block) {
4103 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004104 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004105 LoopSuccessor = Block;
4106 } else
4107 LoopSuccessor = Succ;
4108
4109 // Save the current value for the break targets.
4110 // All breaks should go to the code following the loop.
4111 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4112 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4113
4114 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004115 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004116 ConditionBlock->setTerminator(S);
4117
4118 // Now add the actual condition to the condition block.
4119 if (Expr *C = S->getCond()) {
4120 Block = ConditionBlock;
4121 CFGBlock *BeginConditionBlock = addStmt(C);
4122 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004123 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004124 assert(BeginConditionBlock == ConditionBlock &&
4125 "condition block in for-range was unexpectedly complex");
4126 (void)BeginConditionBlock;
4127 }
4128
4129 // The condition block is the implicit successor for the loop body as well as
4130 // any code above the loop.
4131 Succ = ConditionBlock;
4132
4133 // See if this is a known constant.
4134 TryResult KnownVal(true);
4135
4136 if (S->getCond())
4137 KnownVal = tryEvaluateBool(S->getCond());
4138
4139 // Now create the loop body.
4140 {
4141 assert(S->getBody());
4142
4143 // Save the current values for Block, Succ, and continue targets.
4144 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4145 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4146
4147 // Generate increment code in its own basic block. This is the target of
4148 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004149 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004150 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004151 if (badCFG)
4152 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004153 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4154
4155 // The starting block for the loop increment is the block that should
4156 // represent the 'loop target' for looping back to the start of the loop.
4157 ContinueJumpTarget.block->setLoopTarget(S);
4158
4159 // Finish up the increment block and prepare to start the loop body.
4160 assert(Block);
4161 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004162 return nullptr;
4163 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004164
4165 // Add implicit scope and dtors for loop variable.
4166 addLocalScopeAndDtors(S->getLoopVarStmt());
4167
4168 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004169 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004170 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004171 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004172 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004173 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004174 return nullptr;
4175
Richard Smith02e85f32011-04-14 22:09:26 +00004176 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004177 addSuccessor(ConditionBlock,
4178 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004179 }
4180
4181 // Link up the condition block with the code that follows the loop (the
4182 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004183 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004184
4185 // Add the initialization statements.
4186 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004187 addStmt(S->getBeginStmt());
4188 addStmt(S->getEndStmt());
Richard Smith0c502d22011-04-18 15:49:25 +00004189 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004190}
4191
John McCall5d413782010-12-06 08:20:24 +00004192CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004193 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004194 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004195 // If adding implicit destructors visit the full expression for adding
4196 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004197 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004198 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004199
4200 // Full expression has to be added as CFGStmt so it will be sequenced
4201 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004202 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004203 }
4204 return Visit(E->getSubExpr(), asc);
4205}
4206
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004207CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4208 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004209 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004210 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004211 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004212
Artem Dergachev783a4572018-02-23 22:20:39 +00004213 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004214 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004215 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004216
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004217 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004218 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004219 }
4220 return Visit(E->getSubExpr(), asc);
4221}
4222
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004223CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4224 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004225 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004226 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004227
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004228 return VisitChildren(C);
4229}
4230
Jordan Rosec9176072014-01-13 17:59:19 +00004231CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4232 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004233 autoCreateBlock();
4234 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004235
Artem Dergachev783a4572018-02-23 22:20:39 +00004236 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004237 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004238 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004239
Jordan Rosec9176072014-01-13 17:59:19 +00004240 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004241 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004242
Jordan Rosec9176072014-01-13 17:59:19 +00004243 if (BuildOpts.AddCXXNewAllocator)
4244 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004245
Jordan Rosec9176072014-01-13 17:59:19 +00004246 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004247 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004248
Jordan Rosec9176072014-01-13 17:59:19 +00004249 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4250 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004251 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004252
Jordan Rosec9176072014-01-13 17:59:19 +00004253 return Block;
4254}
Jordan Rosed2f40792013-09-03 17:00:57 +00004255
4256CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4257 AddStmtChoice asc) {
4258 autoCreateBlock();
4259 appendStmt(Block, DE);
4260 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004261 if (!DTy.isNull()) {
4262 DTy = DTy.getNonReferenceType();
4263 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4264 if (RD) {
4265 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4266 appendDeleteDtor(Block, RD, DE);
4267 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004268 }
4269
4270 return VisitChildren(DE);
4271}
4272
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004273CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4274 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004275 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004276 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004277 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004278 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004279 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004280 }
4281 return Visit(E->getSubExpr(), asc);
4282}
4283
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004284CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4285 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004286 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004287 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004288 return VisitChildren(C);
4289}
4290
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004291CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4292 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004293 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004294 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004295 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004296 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004297 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004298}
4299
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004300CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004301 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004302 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004303
Ted Kremenekeda180e22007-08-28 19:26:49 +00004304 if (!IBlock) {
4305 IBlock = createBlock(false);
4306 cfg->setIndirectGotoBlock(IBlock);
4307 }
Mike Stump31feda52009-07-17 01:31:16 +00004308
Ted Kremenekeda180e22007-08-28 19:26:49 +00004309 // IndirectGoto is a control-flow statement. Thus we stop processing the
4310 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004311 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004312 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004313
Ted Kremenekeda180e22007-08-28 19:26:49 +00004314 Block = createBlock(false);
4315 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004316 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004317 return addStmt(I->getTarget());
4318}
4319
Manuel Klimekb5616c92014-08-07 10:42:17 +00004320CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4321 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004322 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4323
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004324tryAgain:
4325 if (!E) {
4326 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004327 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004328 }
4329 switch (E->getStmtClass()) {
4330 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004331 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004332
4333 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004334 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4335 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004336
4337 case Stmt::CXXBindTemporaryExprClass:
4338 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004339 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004340
John McCallc07a0c72011-02-17 10:25:35 +00004341 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004342 case Stmt::ConditionalOperatorClass:
4343 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004344 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004345
4346 case Stmt::ImplicitCastExprClass:
4347 // For implicit cast we want BindToTemporary to be passed further.
4348 E = cast<CastExpr>(E)->getSubExpr();
4349 goto tryAgain;
4350
Manuel Klimekb0042c42014-07-30 08:34:42 +00004351 case Stmt::CXXFunctionalCastExprClass:
4352 // For functional cast we want BindToTemporary to be passed further.
4353 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4354 goto tryAgain;
4355
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004356 case Stmt::ParenExprClass:
4357 E = cast<ParenExpr>(E)->getSubExpr();
4358 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004359
Manuel Klimekb0042c42014-07-30 08:34:42 +00004360 case Stmt::MaterializeTemporaryExprClass: {
4361 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4362 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4363 SmallVector<const Expr *, 2> CommaLHSs;
4364 SmallVector<SubobjectAdjustment, 2> Adjustments;
4365 // Find the expression whose lifetime needs to be extended.
4366 E = const_cast<Expr *>(
4367 cast<MaterializeTemporaryExpr>(E)
4368 ->GetTemporaryExpr()
4369 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4370 // Visit the skipped comma operator left-hand sides for other temporaries.
4371 for (const Expr *CommaLHS : CommaLHSs) {
4372 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004373 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004374 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004375 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004376 }
Richard Smith4137af22014-07-27 05:12:49 +00004377
4378 case Stmt::BlockExprClass:
4379 // Don't recurse into blocks; their subexpressions don't get evaluated
4380 // here.
4381 return Block;
4382
4383 case Stmt::LambdaExprClass: {
4384 // For lambda expressions, only recurse into the capture initializers,
4385 // and not the body.
4386 auto *LE = cast<LambdaExpr>(E);
4387 CFGBlock *B = Block;
4388 for (Expr *Init : LE->capture_inits()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004389 if (CFGBlock *R = VisitForTemporaryDtors(
4390 Init, /*BindToTemporary=*/false, Context))
Richard Smith4137af22014-07-27 05:12:49 +00004391 B = R;
4392 }
4393 return B;
4394 }
4395
4396 case Stmt::CXXDefaultArgExprClass:
4397 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4398 goto tryAgain;
4399
4400 case Stmt::CXXDefaultInitExprClass:
4401 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4402 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004403 }
4404}
4405
Manuel Klimekb5616c92014-08-07 10:42:17 +00004406CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4407 TempDtorContext &Context) {
4408 if (isa<LambdaExpr>(E)) {
4409 // Do not visit the children of lambdas; they have their own CFGs.
4410 return Block;
4411 }
4412
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004413 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004414 // order that they will appear in the CFG. Because the CFG is built
4415 // bottom-up, this means we visit them in their natural order, which
4416 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004417 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004418 for (Stmt *Child : E->children())
4419 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004420 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004421 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004422
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004423 return B;
4424}
4425
Manuel Klimekb5616c92014-08-07 10:42:17 +00004426CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4427 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004428 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004429 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004430 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4431 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4432 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004433
Manuel Klimekedf925b92014-08-07 18:44:19 +00004434 // We do not know at CFG-construction time whether the right-hand-side was
4435 // executed, thus we add a branch node that depends on the temporary
4436 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004437 TempDtorContext RHSContext(
4438 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004439 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004440 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004441
Manuel Klimekb5616c92014-08-07 10:42:17 +00004442 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004443 }
4444
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004445 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004446 // For assignment operator (=) LHS expression is visited
4447 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004448 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4449 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004450 return LHSBlock ? LHSBlock : RHSBlock;
4451 }
4452
4453 // For any other binary operator RHS expression is visited before
4454 // LHS expression (order of children). For destructors visit them in reverse
4455 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004456 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4457 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004458 return RHSBlock ? RHSBlock : LHSBlock;
4459}
4460
4461CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004462 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004463 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004464 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004465 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004466 // If lifetime of temporary is not prolonged (by assigning to constant
4467 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004468
Chandler Carruthad747252011-09-13 06:09:01 +00004469 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004470
Richard Trieu95a192a2015-05-28 00:14:02 +00004471 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004472 // If the destructor is marked as a no-return destructor, we need to
4473 // create a new block for the destructor which does not have as a
4474 // successor anything built thus far. Control won't flow out of this
4475 // block.
4476 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004477 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004478 } else if (Context.needsTempDtorBranch()) {
4479 // If we need to introduce a branch, we add a new block that we will hook
4480 // up to a decision block later.
4481 if (B) Succ = B;
4482 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004483 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004484 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004485 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004486 if (Context.needsTempDtorBranch()) {
4487 Context.setDecisionPoint(Succ, E);
4488 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004489 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004490
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004491 B = Block;
4492 }
4493 return B;
4494}
4495
Manuel Klimekb5616c92014-08-07 10:42:17 +00004496void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4497 CFGBlock *FalseSucc) {
4498 if (!Context.TerminatorExpr) {
4499 // If no temporary was found, we do not need to insert a decision point.
4500 return;
4501 }
4502 assert(Context.TerminatorExpr);
4503 CFGBlock *Decision = createBlock(false);
4504 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004505 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004506 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004507 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004508 Block = Decision;
4509}
4510
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004511CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004512 AbstractConditionalOperator *E, bool BindToTemporary,
4513 TempDtorContext &Context) {
4514 VisitForTemporaryDtors(E->getCond(), false, Context);
4515 CFGBlock *ConditionBlock = Block;
4516 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004517 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004518 TryResult NegatedVal = ConditionVal;
4519 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004520
Manuel Klimekdeb02622014-08-08 07:37:13 +00004521 TempDtorContext TrueContext(
4522 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004523 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004524 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004525
Manuel Klimekb5616c92014-08-07 10:42:17 +00004526 Block = ConditionBlock;
4527 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004528 TempDtorContext FalseContext(
4529 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004530 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004531
Manuel Klimekb5616c92014-08-07 10:42:17 +00004532 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004533 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004534 } else if (TrueContext.TerminatorExpr) {
4535 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004536 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004537 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004538 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004539 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004540 return Block;
4541}
4542
Mike Stump31feda52009-07-17 01:31:16 +00004543/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4544/// no successors or predecessors. If this is the first block created in the
4545/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004546CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004547 bool first_block = begin() == end();
4548
4549 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004550 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004551 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004552 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004553
4554 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004555 if (first_block)
4556 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004557
4558 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004559 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004560}
4561
David Blaikiee90195c2014-08-29 18:53:26 +00004562/// buildCFG - Constructs a CFG from an AST.
4563std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4564 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004565 CFGBuilder Builder(C, BO);
4566 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004567}
4568
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004569const CXXDestructorDecl *
4570CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004571 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004572 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004573 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004574 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004575 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004576 case CFGElement::Statement:
4577 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004578 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004579 case CFGElement::ScopeBegin:
4580 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004581 llvm_unreachable("getDestructorDecl should only be used with "
4582 "ImplicitDtors");
4583 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004584 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004585 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004586
4587 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4588 //
4589 // Lifetime-extending constructs are handled here. This works for a single
4590 // temporary in an initializer expression.
4591 if (ty->isReferenceType()) {
4592 if (const Expr *Init = var->getInit()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00004593 ty = getReferenceInitTemporaryType(Init);
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004594 }
4595 }
4596
Ted Kremeneke7d78882012-03-19 23:48:41 +00004597 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004598 ty = arrayType->getElementType();
4599 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004600 const RecordType *recordType = ty->getAs<RecordType>();
4601 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004602 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004603 return classDecl->getDestructor();
4604 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004605 case CFGElement::DeleteDtor: {
4606 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4607 QualType DTy = DE->getDestroyedType();
4608 DTy = DTy.getNonReferenceType();
4609 const CXXRecordDecl *classDecl =
4610 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4611 return classDecl->getDestructor();
4612 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004613 case CFGElement::TemporaryDtor: {
4614 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004615 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004616 const CXXTemporary *temp = bindExpr->getTemporary();
4617 return temp->getDestructor();
4618 }
4619 case CFGElement::BaseDtor:
4620 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004621 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004622 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004623 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004624 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004625}
4626
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004627bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004628 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4629 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004630 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004631}
4632
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004633//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004634// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004635//===----------------------------------------------------------------------===//
4636
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004637CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004638 : ReachableBlock(IsReachable ? B : nullptr),
4639 UnreachableBlock(!IsReachable ? B : nullptr,
4640 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004641
4642CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004643 : ReachableBlock(B),
4644 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4645 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004646
4647void CFGBlock::addSuccessor(AdjacentBlock Succ,
4648 BumpVectorContext &C) {
4649 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004650 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004651
4652 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004653 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004654
4655 Succs.push_back(Succ, C);
4656}
4657
Ted Kremenekb0371852010-09-09 00:06:04 +00004658bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004659 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004660 if (F.IgnoreNullPredecessors && !From)
4661 return true;
4662
4663 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004664 // If the 'To' has no label or is labeled but the label isn't a
4665 // CaseStmt then filter this edge.
4666 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004667 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004668 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004669 const Stmt *L = To->getLabel();
4670 if (!L || !isa<CaseStmt>(L))
4671 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004672 }
4673 }
4674 }
4675
4676 return false;
4677}
4678
4679//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004680// CFG pretty printing
4681//===----------------------------------------------------------------------===//
4682
Ted Kremenek7e776b12007-08-22 18:22:34 +00004683namespace {
4684
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004685class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004686 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4687 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4688
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004689 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004690 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004691 signed currentBlock = 0;
4692 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004693 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004694
Eugene Zelenko38c70522017-12-07 21:55:09 +00004695public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004696 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004697 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004698 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4699 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004700 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004701 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004702 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4703 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004704 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004705 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004706
Ted Kremenek96a7a592011-03-01 03:15:10 +00004707 switch (stmt->getStmtClass()) {
4708 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004709 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4710 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004711 case Stmt::IfStmtClass: {
4712 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4713 if (var)
4714 DeclMap[var] = P;
4715 break;
4716 }
4717 case Stmt::ForStmtClass: {
4718 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4719 if (var)
4720 DeclMap[var] = P;
4721 break;
4722 }
4723 case Stmt::WhileStmtClass: {
4724 const VarDecl *var =
4725 cast<WhileStmt>(stmt)->getConditionVariable();
4726 if (var)
4727 DeclMap[var] = P;
4728 break;
4729 }
4730 case Stmt::SwitchStmtClass: {
4731 const VarDecl *var =
4732 cast<SwitchStmt>(stmt)->getConditionVariable();
4733 if (var)
4734 DeclMap[var] = P;
4735 break;
4736 }
4737 case Stmt::CXXCatchStmtClass: {
4738 const VarDecl *var =
4739 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4740 if (var)
4741 DeclMap[var] = P;
4742 break;
4743 }
4744 default:
4745 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004746 }
4747 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004748 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004749 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004750 }
Mike Stump31feda52009-07-17 01:31:16 +00004751
Eugene Zelenko38c70522017-12-07 21:55:09 +00004752 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004753
Chris Lattnerc61089a2009-06-30 01:26:17 +00004754 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004755 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004756 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004757
Craig Topperb45acb82014-03-14 06:02:07 +00004758 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004759 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004760
4761 if (I == StmtMap.end())
4762 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004763
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004764 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004765 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004766 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004767 }
Mike Stump31feda52009-07-17 01:31:16 +00004768
Ted Kremenek60983dc2010-01-19 20:52:05 +00004769 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004770 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004771 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004772
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004773 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004774 DeclMapTy::iterator I = DeclMap.find(D);
4775
4776 if (I == DeclMap.end())
4777 return false;
4778
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004779 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004780 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004781 return false;
4782 }
4783
4784 OS << "[B" << I->second.first << "." << I->second.second << "]";
4785 return true;
4786 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004787};
4788
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004789class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004790 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004791 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004792 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004793 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004794
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004795public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004796 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004797 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004798 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004799 this->Policy.IncludeNewlines = false;
4800 }
Mike Stump31feda52009-07-17 01:31:16 +00004801
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004802 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004803 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004804 if (Stmt *C = I->getCond())
4805 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004806 }
Mike Stump31feda52009-07-17 01:31:16 +00004807
Ted Kremenek9aae5132007-08-23 21:42:29 +00004808 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004809 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004810 Terminator->printPretty(OS, Helper, Policy);
4811 }
4812
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004813 void VisitDeclStmt(DeclStmt *DS) {
4814 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4815 OS << "static init " << VD->getName();
4816 }
4817
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004818 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004819 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004820 if (F->getInit())
4821 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004822 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004823 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004824 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004825 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004826 if (F->getInc())
4827 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004828 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004829 }
Mike Stump31feda52009-07-17 01:31:16 +00004830
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004831 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004832 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004833 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004834 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004835 }
Mike Stump31feda52009-07-17 01:31:16 +00004836
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004837 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004838 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004839 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004840 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004841 }
Mike Stump31feda52009-07-17 01:31:16 +00004842
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004843 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004844 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004845 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004846 }
Mike Stump31feda52009-07-17 01:31:16 +00004847
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004848 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004849 OS << "try ...";
4850 }
4851
Nico Weber699670e2017-08-23 15:33:16 +00004852 void VisitSEHTryStmt(SEHTryStmt *CS) {
4853 OS << "__try ...";
4854 }
4855
John McCallc07a0c72011-02-17 10:25:35 +00004856 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004857 if (Stmt *Cond = C->getCond())
4858 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004859 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004860 }
Mike Stump31feda52009-07-17 01:31:16 +00004861
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004862 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004863 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004864 if (Stmt *Cond = C->getCond())
4865 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004866 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004867 }
Mike Stump31feda52009-07-17 01:31:16 +00004868
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004869 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004870 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004871 if (Stmt *T = I->getTarget())
4872 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004873 }
Mike Stump31feda52009-07-17 01:31:16 +00004874
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004875 void VisitBinaryOperator(BinaryOperator* B) {
4876 if (!B->isLogicalOp()) {
4877 VisitExpr(B);
4878 return;
4879 }
Mike Stump31feda52009-07-17 01:31:16 +00004880
Richard Trieuddd01ce2014-06-09 22:53:25 +00004881 if (B->getLHS())
4882 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004883
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004884 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004885 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004886 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004887 return;
John McCalle3027922010-08-25 11:45:40 +00004888 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004889 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004890 return;
4891 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004892 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004893 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004894 }
Mike Stump31feda52009-07-17 01:31:16 +00004895
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004896 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004897 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004898 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004899
4900public:
4901 void print(CFGTerminator T) {
4902 if (T.isTemporaryDtorsBranch())
4903 OS << "(Temp Dtor) ";
4904 Visit(T.getStmt());
4905 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004906};
Eugene Zelenko38c70522017-12-07 21:55:09 +00004907
4908} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00004909
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004910static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
4911 const CXXCtorInitializer *I) {
4912 if (I->isBaseInitializer())
4913 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
4914 else if (I->isDelegatingInitializer())
4915 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
4916 else
4917 OS << I->getAnyMember()->getName();
4918 OS << "(";
4919 if (Expr *IE = I->getInit())
4920 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
4921 OS << ")";
4922
4923 if (I->isBaseInitializer())
4924 OS << " (Base initializer)";
4925 else if (I->isDelegatingInitializer())
4926 OS << " (Delegating initializer)";
4927 else
4928 OS << " (Member initializer)";
4929}
4930
Artem Dergachev1527dec2018-03-12 23:12:40 +00004931static void print_construction_context(raw_ostream &OS,
4932 StmtPrinterHelper &Helper,
4933 const ConstructionContext *CC) {
4934 const Stmt *S1 = nullptr, *S2 = nullptr;
4935 switch (CC->getKind()) {
Artem Dergachev922455f2018-03-22 22:02:38 +00004936 case ConstructionContext::SimpleConstructorInitializerKind: {
Artem Dergachev1527dec2018-03-12 23:12:40 +00004937 OS << ", ";
Artem Dergachev922455f2018-03-22 22:02:38 +00004938 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC);
4939 print_initializer(OS, Helper, SICC->getCXXCtorInitializer());
4940 break;
4941 }
4942 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: {
4943 OS << ", ";
4944 const auto *CICC =
4945 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC);
4946 print_initializer(OS, Helper, CICC->getCXXCtorInitializer());
4947 S2 = CICC->getCXXBindTemporaryExpr();
Artem Dergachev1527dec2018-03-12 23:12:40 +00004948 break;
4949 }
4950 case ConstructionContext::SimpleVariableKind: {
Artem Dergachev317291e2018-03-22 21:37:39 +00004951 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC);
4952 S1 = SDSCC->getDeclStmt();
4953 break;
4954 }
4955 case ConstructionContext::CXX17ElidedCopyVariableKind: {
4956 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC);
4957 S1 = CDSCC->getDeclStmt();
4958 S2 = CDSCC->getCXXBindTemporaryExpr();
Artem Dergachev1527dec2018-03-12 23:12:40 +00004959 break;
4960 }
4961 case ConstructionContext::NewAllocatedObjectKind: {
4962 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
4963 S1 = NECC->getCXXNewExpr();
4964 break;
4965 }
Artem Dergachev317291e2018-03-22 21:37:39 +00004966 case ConstructionContext::SimpleReturnedValueKind: {
4967 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC);
Artem Dergachev1527dec2018-03-12 23:12:40 +00004968 S1 = RSCC->getReturnStmt();
4969 break;
4970 }
Artem Dergachev317291e2018-03-22 21:37:39 +00004971 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: {
4972 const auto *RSCC =
4973 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC);
4974 S1 = RSCC->getReturnStmt();
4975 S2 = RSCC->getCXXBindTemporaryExpr();
4976 break;
4977 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00004978 case ConstructionContext::TemporaryObjectKind: {
4979 const auto *TOCC = cast<TemporaryObjectConstructionContext>(CC);
4980 S1 = TOCC->getCXXBindTemporaryExpr();
4981 S2 = TOCC->getMaterializedTemporaryExpr();
4982 break;
4983 }
4984 }
4985 if (S1) {
4986 OS << ", ";
4987 Helper.handledStmt(const_cast<Stmt *>(S1), OS);
4988 }
4989 if (S2) {
4990 OS << ", ";
4991 Helper.handledStmt(const_cast<Stmt *>(S2), OS);
4992 }
4993}
4994
Aaron Ballmanff924b02013-11-18 20:11:50 +00004995static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00004996 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004997 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4998 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00004999 assert(S != nullptr && "Expecting non-null Stmt");
5000
Aaron Ballmanff924b02013-11-18 20:11:50 +00005001 // special printing for statement-expressions.
5002 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
5003 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00005004
Benjamin Kramer5733e352015-07-18 17:09:36 +00005005 auto Children = Sub->children();
5006 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005007 OS << "({ ... ; ";
5008 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
5009 OS << " })\n";
5010 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005011 }
5012 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00005013 // special printing for comma expressions.
5014 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
5015 if (B->getOpcode() == BO_Comma) {
5016 OS << "... , ";
5017 Helper.handledStmt(B->getRHS(),OS);
5018 OS << '\n';
5019 return;
5020 }
5021 }
5022 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00005023
Artem Dergachev1527dec2018-03-12 23:12:40 +00005024 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
5025 if (isa<CXXOperatorCallExpr>(S))
5026 OS << " (OperatorCall)";
5027 OS << " (CXXRecordTypedCall";
5028 print_construction_context(OS, Helper, VTC->getConstructionContext());
5029 OS << ")";
5030 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005031 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005032 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005033 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005034 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005035 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005036 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005037 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00005038 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005039 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005040 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00005041 OS << " (" << CE->getStmtClassName() << ", "
5042 << CE->getCastKindName()
5043 << ", " << CE->getType().getAsString()
5044 << ")";
5045 }
Mike Stump31feda52009-07-17 01:31:16 +00005046
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005047 // Expressions need a newline.
5048 if (isa<Expr>(S))
5049 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005050 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005051 print_initializer(OS, Helper, IE->getInitializer());
5052 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005053 } else if (Optional<CFGAutomaticObjDtor> DE =
5054 E.getAs<CFGAutomaticObjDtor>()) {
5055 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005056 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005057
Artem Dergacheva25809f2018-06-04 18:56:25 +00005058 ASTContext &ACtx = VD->getASTContext();
5059 QualType T = VD->getType();
5060 if (T->isReferenceType())
5061 T = getReferenceInitTemporaryType(VD->getInit(), nullptr);
5062 if (const ArrayType *AT = ACtx.getAsArrayType(T))
5063 T = ACtx.getBaseElementType(AT);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005064
5065 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
5066 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00005067 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
5068 const VarDecl *VD = DE->getVarDecl();
5069 Helper.handleDecl(VD, OS);
5070
5071 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00005072 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
5073 const Stmt *LoopStmt = LE->getLoopStmt();
5074 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005075 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
5076 OS << "CFGScopeBegin(";
5077 if (const VarDecl *VD = SB->getVarDecl())
5078 OS << VD->getQualifiedNameAsString();
5079 OS << ")\n";
5080 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
5081 OS << "CFGScopeEnd(";
5082 if (const VarDecl *VD = SE->getVarDecl())
5083 OS << VD->getQualifiedNameAsString();
5084 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00005085 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
5086 OS << "CFGNewAllocator(";
5087 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
5088 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5089 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00005090 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
5091 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
5092 if (!RD)
5093 return;
5094 CXXDeleteExpr *DelExpr =
5095 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005096 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005097 OS << "->~" << RD->getName().str() << "()";
5098 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005099 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5100 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005101 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005102 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005103 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5104 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005105 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005106 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005107 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005108 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005109 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5110 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005111 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005112 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005113 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005114 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005115}
Mike Stump31feda52009-07-17 01:31:16 +00005116
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005117static void print_block(raw_ostream &OS, const CFG* cfg,
5118 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005119 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005120 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005121 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005122
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005123 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005124 if (ShowColors)
5125 OS.changeColor(raw_ostream::YELLOW, true);
5126
5127 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005128
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005129 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005130 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005131 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005132 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005133 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005134 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005135 else if (B.hasNoReturnElement())
5136 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005137 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005138 OS << "]\n";
5139
5140 if (ShowColors)
5141 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005142
Ted Kremenek71eca012007-08-29 23:20:49 +00005143 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005144 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005145 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005146 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005147
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005148 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005149 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005150 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005151 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005152 if (C->getLHS())
5153 C->getLHS()->printPretty(OS, &Helper,
5154 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005155 if (C->getRHS()) {
5156 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005157 C->getRHS()->printPretty(OS, &Helper,
5158 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005159 }
Mike Stump92244b02010-01-19 22:00:14 +00005160 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005161 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005162 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005163 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005164 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005165 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005166 0);
5167 else
5168 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005169 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005170 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5171 OS << "__except (";
5172 ES->getFilterExpr()->printPretty(OS, &Helper,
5173 PrintingPolicy(Helper.getLangOpts()), 0);
5174 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005175 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005176 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005177
Ted Kremenek71eca012007-08-29 23:20:49 +00005178 OS << ":\n";
5179 }
Mike Stump31feda52009-07-17 01:31:16 +00005180
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005181 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005182 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005183
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005184 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5185 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005186 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005187 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005188 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005189
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005190 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005191
Aaron Ballmanff924b02013-11-18 20:11:50 +00005192 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005193
Ted Kremenek72be32a2011-12-22 23:33:52 +00005194 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005195 }
Mike Stump31feda52009-07-17 01:31:16 +00005196
Ted Kremenek71eca012007-08-29 23:20:49 +00005197 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005198 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005199 if (ShowColors)
5200 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005201
Ted Kremenek72be32a2011-12-22 23:33:52 +00005202 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005203
Aaron Ballmanff924b02013-11-18 20:11:50 +00005204 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005205
Aaron Ballmanff924b02013-11-18 20:11:50 +00005206 PrintingPolicy PP(Helper.getLangOpts());
5207 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005208 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005209 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00005210
5211 if (ShowColors)
5212 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005213 }
Mike Stump31feda52009-07-17 01:31:16 +00005214
Ted Kremenek71eca012007-08-29 23:20:49 +00005215 if (print_edges) {
5216 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005217 if (!B.pred_empty()) {
5218 const raw_ostream::Colors Color = raw_ostream::BLUE;
5219 if (ShowColors)
5220 OS.changeColor(Color);
5221 OS << " Preds " ;
5222 if (ShowColors)
5223 OS.resetColor();
5224 OS << '(' << B.pred_size() << "):";
5225 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005226
Ted Kremenek72be32a2011-12-22 23:33:52 +00005227 if (ShowColors)
5228 OS.changeColor(Color);
5229
5230 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5231 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005232 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005233 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005234
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005235 CFGBlock *B = *I;
5236 bool Reachable = true;
5237 if (!B) {
5238 Reachable = false;
5239 B = I->getPossiblyUnreachableBlock();
5240 }
5241
5242 OS << " B" << B->getBlockID();
5243 if (!Reachable)
5244 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005245 }
5246
5247 if (ShowColors)
5248 OS.resetColor();
5249
5250 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005251 }
Mike Stump31feda52009-07-17 01:31:16 +00005252
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005253 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005254 if (!B.succ_empty()) {
5255 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5256 if (ShowColors)
5257 OS.changeColor(Color);
5258 OS << " Succs ";
5259 if (ShowColors)
5260 OS.resetColor();
5261 OS << '(' << B.succ_size() << "):";
5262 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005263
Ted Kremenek72be32a2011-12-22 23:33:52 +00005264 if (ShowColors)
5265 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005266
Ted Kremenek72be32a2011-12-22 23:33:52 +00005267 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5268 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005269 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005270 OS << "\n ";
5271
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005272 CFGBlock *B = *I;
5273
5274 bool Reachable = true;
5275 if (!B) {
5276 Reachable = false;
5277 B = I->getPossiblyUnreachableBlock();
5278 }
5279
5280 if (B) {
5281 OS << " B" << B->getBlockID();
5282 if (!Reachable)
5283 OS << "(Unreachable)";
5284 }
5285 else {
5286 OS << " NULL";
5287 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005288 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005289
Ted Kremenek72be32a2011-12-22 23:33:52 +00005290 if (ShowColors)
5291 OS.resetColor();
5292 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005293 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005294 }
Mike Stump31feda52009-07-17 01:31:16 +00005295}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005296
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005297/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005298void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5299 print(llvm::errs(), LO, ShowColors);
5300}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005301
5302/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005303void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005304 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005305
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005306 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005307 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005308
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005309 // Iterate through the CFGBlocks and print them one by one.
5310 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5311 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005312 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005313 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005314
Aaron Ballmanff924b02013-11-18 20:11:50 +00005315 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005316 }
Mike Stump31feda52009-07-17 01:31:16 +00005317
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005318 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005319 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005320 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005321 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005322}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005323
5324/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005325void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5326 bool ShowColors) const {
5327 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005328}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005329
Yaron Kerencdae9412016-01-29 19:38:18 +00005330LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005331 dump(getParent(), LangOptions(), false);
5332}
5333
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005334/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5335/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005336void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005337 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005338 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005339 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005340 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005341}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005342
Ted Kremenek15647632008-01-30 23:02:42 +00005343/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005344void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005345 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005346 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005347 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005348}
5349
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005350Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00005351 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005352 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005353 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005354
Craig Topper25542942014-05-20 04:30:07 +00005355 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005356
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005357 switch (Terminator->getStmtClass()) {
5358 default:
5359 break;
Mike Stump31feda52009-07-17 01:31:16 +00005360
Jordan Rosecf10ea82013-06-06 21:53:45 +00005361 case Stmt::CXXForRangeStmtClass:
5362 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5363 break;
5364
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005365 case Stmt::ForStmtClass:
5366 E = cast<ForStmt>(Terminator)->getCond();
5367 break;
Mike Stump31feda52009-07-17 01:31:16 +00005368
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005369 case Stmt::WhileStmtClass:
5370 E = cast<WhileStmt>(Terminator)->getCond();
5371 break;
Mike Stump31feda52009-07-17 01:31:16 +00005372
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005373 case Stmt::DoStmtClass:
5374 E = cast<DoStmt>(Terminator)->getCond();
5375 break;
Mike Stump31feda52009-07-17 01:31:16 +00005376
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005377 case Stmt::IfStmtClass:
5378 E = cast<IfStmt>(Terminator)->getCond();
5379 break;
Mike Stump31feda52009-07-17 01:31:16 +00005380
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005381 case Stmt::ChooseExprClass:
5382 E = cast<ChooseExpr>(Terminator)->getCond();
5383 break;
Mike Stump31feda52009-07-17 01:31:16 +00005384
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005385 case Stmt::IndirectGotoStmtClass:
5386 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5387 break;
Mike Stump31feda52009-07-17 01:31:16 +00005388
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005389 case Stmt::SwitchStmtClass:
5390 E = cast<SwitchStmt>(Terminator)->getCond();
5391 break;
Mike Stump31feda52009-07-17 01:31:16 +00005392
John McCallc07a0c72011-02-17 10:25:35 +00005393 case Stmt::BinaryConditionalOperatorClass:
5394 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5395 break;
5396
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005397 case Stmt::ConditionalOperatorClass:
5398 E = cast<ConditionalOperator>(Terminator)->getCond();
5399 break;
Mike Stump31feda52009-07-17 01:31:16 +00005400
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005401 case Stmt::BinaryOperatorClass: // '&&' and '||'
5402 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005403 break;
Mike Stump31feda52009-07-17 01:31:16 +00005404
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005405 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005406 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005407 }
Mike Stump31feda52009-07-17 01:31:16 +00005408
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005409 if (!StripParens)
5410 return E;
5411
Craig Topper25542942014-05-20 04:30:07 +00005412 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005413}
5414
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005415//===----------------------------------------------------------------------===//
5416// CFG Graphviz Visualization
5417//===----------------------------------------------------------------------===//
5418
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005419#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005420static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005421#endif
5422
Chris Lattnerc61089a2009-06-30 01:26:17 +00005423void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005424#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005425 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005426 GraphHelper = &H;
5427 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005428 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005429#endif
5430}
5431
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005432namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005433
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005434template<>
5435struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005436 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005437
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005438 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005439#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005440 std::string OutSStr;
5441 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005442 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005443 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005444
5445 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5446
5447 // Process string output to make it nicer...
5448 for (unsigned i = 0; i != OutStr.length(); ++i)
5449 if (OutStr[i] == '\n') { // Left justify
5450 OutStr[i] = '\\';
5451 OutStr.insert(OutStr.begin()+i+1, 'l');
5452 }
Mike Stump31feda52009-07-17 01:31:16 +00005453
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005454 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005455#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005456 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005457#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005458 }
5459};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005460
5461} // namespace llvm