blob: 98bffde8919190677989ed72049e94ea68755d49 [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)) {
739 const ConstructionContext *CC =
740 ConstructionContext::createFromLayers(cfg->getBumpVectorContext(),
741 Layer);
Artem Dergachev783a4572018-02-23 22:20:39 +0000742 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
743 cleanupConstructionContext(CE);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000744 return;
745 }
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) {
753 if (BuildOpts.AddRichCXXConstructors) {
Artem Dergachev54ed6422018-03-12 23:52:36 +0000754 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(CE, *Context)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +0000755 if (const ConstructionContextLayer *Layer =
756 ConstructionContextMap.lookup(CE)) {
757 const ConstructionContext *CC =
758 ConstructionContext::createFromLayers(cfg->getBumpVectorContext(),
759 Layer);
760 B->appendCXXRecordTypedCall(
761 CE, cast<TemporaryObjectConstructionContext>(CC),
762 cfg->getBumpVectorContext());
763 cleanupConstructionContext(CE);
764 return;
765 }
766 }
767 }
768
769 // No valid construction context found. Fall back to statement.
770 B->appendStmt(CE, cfg->getBumpVectorContext());
771 }
772
Alexis Hunt1d792652011-01-08 20:30:50 +0000773 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000774 B->appendInitializer(I, cfg->getBumpVectorContext());
775 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000776
Jordan Rosec9176072014-01-13 17:59:19 +0000777 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
778 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
779 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000780
Marcin Swiderski20b88732010-10-05 05:37:00 +0000781 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
782 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
783 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000784
Marcin Swiderski20b88732010-10-05 05:37:00 +0000785 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
786 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
787 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000788
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000789 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
790 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
791 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000792
Chandler Carruthad747252011-09-13 06:09:01 +0000793 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
794 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
795 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000796
Matthias Gehre351c2182017-07-12 07:04:19 +0000797 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
798 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
799 }
800
Peter Szecsi999a25f2017-08-19 11:19:16 +0000801 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
802 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
803 }
804
Jordan Rosed2f40792013-09-03 17:00:57 +0000805 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
806 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
807 }
808
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000809 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000810 LocalScope::const_iterator B, LocalScope::const_iterator E);
811
Matthias Gehre351c2182017-07-12 07:04:19 +0000812 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
813 LocalScope::const_iterator B,
814 LocalScope::const_iterator E);
815
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000816 const VarDecl *
817 prependAutomaticObjScopeEndWithTerminator(CFGBlock *Blk,
818 LocalScope::const_iterator B,
819 LocalScope::const_iterator E);
820
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000821 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
822 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
823 cfg->getBumpVectorContext());
824 }
825
826 /// Add a reachable successor to a block, with the alternate variant that is
827 /// unreachable.
828 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
829 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
830 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000831 }
Mike Stump11289f42009-09-09 15:08:12 +0000832
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000833 void appendScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
834 if (BuildOpts.AddScopes)
835 B->appendScopeBegin(VD, S, cfg->getBumpVectorContext());
836 }
837
838 void prependScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
839 if (BuildOpts.AddScopes)
840 B->prependScopeBegin(VD, S, cfg->getBumpVectorContext());
841 }
842
843 void appendScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
844 if (BuildOpts.AddScopes)
845 B->appendScopeEnd(VD, S, cfg->getBumpVectorContext());
846 }
847
848 void prependScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
849 if (BuildOpts.AddScopes)
850 B->prependScopeEnd(VD, S, cfg->getBumpVectorContext());
851 }
852
Richard Trieuf935b562014-04-05 05:17:01 +0000853 /// \brief Find a relational comparison with an expression evaluating to a
854 /// boolean and a constant other than 0 and 1.
855 /// e.g. if ((x < y) == 10)
856 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
857 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
858 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
859
860 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
861 const Expr *BoolExpr = RHSExpr;
862 bool IntFirst = true;
863 if (!IntLiteral) {
864 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
865 BoolExpr = LHSExpr;
866 IntFirst = false;
867 }
868
869 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
870 return TryResult();
871
872 llvm::APInt IntValue = IntLiteral->getValue();
873 if ((IntValue == 1) || (IntValue == 0))
874 return TryResult();
875
876 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
877 !IntValue.isNegative();
878
879 BinaryOperatorKind Bok = B->getOpcode();
880 if (Bok == BO_GT || Bok == BO_GE) {
881 // Always true for 10 > bool and bool > -1
882 // Always false for -1 > bool and bool > 10
883 return TryResult(IntFirst == IntLarger);
884 } else {
885 // Always true for -1 < bool and bool < 10
886 // Always false for 10 < bool and bool < -1
887 return TryResult(IntFirst != IntLarger);
888 }
889 }
890
Jordan Rose7afd71e2014-05-20 17:31:11 +0000891 /// Find an incorrect equality comparison. Either with an expression
892 /// evaluating to a boolean and a constant other than 0 and 1.
893 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
894 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000895 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
896 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
897 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
898
899 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
900 const Expr *BoolExpr = RHSExpr;
901
902 if (!IntLiteral) {
903 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
904 BoolExpr = LHSExpr;
905 }
906
Jordan Rose7afd71e2014-05-20 17:31:11 +0000907 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000908 return TryResult();
909
Jordan Rose7afd71e2014-05-20 17:31:11 +0000910 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
911 if (BitOp && (BitOp->getOpcode() == BO_And ||
912 BitOp->getOpcode() == BO_Or)) {
913 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
914 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
915
916 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
917
918 if (!IntLiteral2)
919 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
920
921 if (!IntLiteral2)
922 return TryResult();
923
924 llvm::APInt L1 = IntLiteral->getValue();
925 llvm::APInt L2 = IntLiteral2->getValue();
926 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
927 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
928 if (BuildOpts.Observer)
929 BuildOpts.Observer->compareBitwiseEquality(B,
930 B->getOpcode() != BO_EQ);
931 TryResult(B->getOpcode() != BO_EQ);
932 }
933 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
934 llvm::APInt IntValue = IntLiteral->getValue();
935 if ((IntValue == 1) || (IntValue == 0)) {
936 return TryResult();
937 }
938 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000939 }
940
Jordan Rose7afd71e2014-05-20 17:31:11 +0000941 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000942 }
943
944 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
945 const llvm::APSInt &Value1,
946 const llvm::APSInt &Value2) {
947 assert(Value1.isSigned() == Value2.isSigned());
948 switch (Relation) {
949 default:
950 return TryResult();
951 case BO_EQ:
952 return TryResult(Value1 == Value2);
953 case BO_NE:
954 return TryResult(Value1 != Value2);
955 case BO_LT:
956 return TryResult(Value1 < Value2);
957 case BO_LE:
958 return TryResult(Value1 <= Value2);
959 case BO_GT:
960 return TryResult(Value1 > Value2);
961 case BO_GE:
962 return TryResult(Value1 >= Value2);
963 }
964 }
965
966 /// \brief Find a pair of comparison expressions with or without parentheses
967 /// with a shared variable and constants and a logical operator between them
968 /// that always evaluates to either true or false.
969 /// e.g. if (x != 3 || x != 4)
970 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
971 assert(B->isLogicalOp());
972 const BinaryOperator *LHS =
973 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
974 const BinaryOperator *RHS =
975 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
976 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000977 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000978
979 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000980 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000981
George Burgess IVced56e62015-10-01 18:47:52 +0000982 const DeclRefExpr *Decl1;
983 const Expr *Expr1;
984 BinaryOperatorKind BO1;
985 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000986
George Burgess IVced56e62015-10-01 18:47:52 +0000987 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000988 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000989
George Burgess IVced56e62015-10-01 18:47:52 +0000990 const DeclRefExpr *Decl2;
991 const Expr *Expr2;
992 BinaryOperatorKind BO2;
993 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000994
George Burgess IVced56e62015-10-01 18:47:52 +0000995 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000996 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000997
998 // Check that it is the same variable on both sides.
999 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001000 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001001
George Burgess IVced56e62015-10-01 18:47:52 +00001002 // Make sure the user's intent is clear (e.g. they're comparing against two
1003 // int literals, or two things from the same enum)
1004 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001005 return {};
George Burgess IVced56e62015-10-01 18:47:52 +00001006
Richard Trieuf935b562014-04-05 05:17:01 +00001007 llvm::APSInt L1, L2;
1008
George Burgess IVced56e62015-10-01 18:47:52 +00001009 if (!Expr1->EvaluateAsInt(L1, *Context) ||
1010 !Expr2->EvaluateAsInt(L2, *Context))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001011 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001012
1013 // Can't compare signed with unsigned or with different bit width.
1014 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001015 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001016
1017 // Values that will be used to determine if result of logical
1018 // operator is always true/false
1019 const llvm::APSInt Values[] = {
1020 // Value less than both Value1 and Value2
1021 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
1022 // L1
1023 L1,
1024 // Value between Value1 and Value2
1025 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
1026 L1.isUnsigned()),
1027 // L2
1028 L2,
1029 // Value greater than both Value1 and Value2
1030 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
1031 };
1032
1033 // Check whether expression is always true/false by evaluating the following
1034 // * variable x is less than the smallest literal.
1035 // * variable x is equal to the smallest literal.
1036 // * Variable x is between smallest and largest literal.
1037 // * Variable x is equal to the largest literal.
1038 // * Variable x is greater than largest literal.
1039 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001040 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +00001041 TryResult Res1, Res2;
1042 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
1043 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
1044
1045 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001046 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001047
1048 if (B->getOpcode() == BO_LAnd) {
1049 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
1050 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
1051 } else {
1052 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
1053 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
1054 }
1055 }
1056
1057 if (AlwaysTrue || AlwaysFalse) {
1058 if (BuildOpts.Observer)
1059 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
1060 return TryResult(AlwaysTrue);
1061 }
Eugene Zelenko38c70522017-12-07 21:55:09 +00001062 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001063 }
1064
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001065 /// Try and evaluate an expression to an integer constant.
1066 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
1067 if (!BuildOpts.PruneTriviallyFalseEdges)
1068 return false;
1069 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001070 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001071 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001072 }
Mike Stump11289f42009-09-09 15:08:12 +00001073
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001074 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001075 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001076 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001077 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001078 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001079 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001080
1081 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1082 if (Bop->isLogicalOp()) {
1083 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001084 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1085 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001086 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001087
1088 // Retrieve result at first, or the map might be updated.
1089 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1090 CachedBoolEvals[S] = Result; // update or insert
1091 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001092 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001093 else {
1094 switch (Bop->getOpcode()) {
1095 default: break;
1096 // For 'x & 0' and 'x * 0', we can determine that
1097 // the value is always false.
1098 case BO_Mul:
1099 case BO_And: {
1100 // If either operand is zero, we know the value
1101 // must be false.
1102 llvm::APSInt IntVal;
1103 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001104 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001105 return TryResult(false);
1106 }
1107 }
1108 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001109 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001110 return TryResult(false);
1111 }
1112 }
1113 }
1114 break;
1115 }
1116 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001117 }
1118
1119 return evaluateAsBooleanConditionNoCache(S);
1120 }
1121
1122 /// \brief Evaluate as boolean \param E without using the cache.
1123 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1124 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1125 if (Bop->isLogicalOp()) {
1126 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1127 if (LHS.isKnown()) {
1128 // We were able to evaluate the LHS, see if we can get away with not
1129 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1130 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1131 return LHS.isTrue();
1132
1133 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1134 if (RHS.isKnown()) {
1135 if (Bop->getOpcode() == BO_LOr)
1136 return LHS.isTrue() || RHS.isTrue();
1137 else
1138 return LHS.isTrue() && RHS.isTrue();
1139 }
1140 } else {
1141 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1142 if (RHS.isKnown()) {
1143 // We can't evaluate the LHS; however, sometimes the result
1144 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1145 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1146 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001147 } else {
1148 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1149 if (BopRes.isKnown())
1150 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001151 }
1152 }
1153
Eugene Zelenko38c70522017-12-07 21:55:09 +00001154 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001155 } else if (Bop->isEqualityOp()) {
1156 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1157 if (BopRes.isKnown())
1158 return BopRes.isTrue();
1159 } else if (Bop->isRelationalOp()) {
1160 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1161 if (BopRes.isKnown())
1162 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001163 }
1164 }
1165
1166 bool Result;
1167 if (E->EvaluateAsBooleanCondition(Result, *Context))
1168 return Result;
1169
Eugene Zelenko38c70522017-12-07 21:55:09 +00001170 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001171 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001172
1173 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001174};
Mike Stump31feda52009-07-17 01:31:16 +00001175
Eugene Zelenko38c70522017-12-07 21:55:09 +00001176} // namespace
1177
Ted Kremeneka099c592011-03-10 03:50:34 +00001178inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1179 const Stmt *stmt) const {
1180 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1181}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001182
Ted Kremeneka099c592011-03-10 03:50:34 +00001183bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001184 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
1185
Ted Kremeneka099c592011-03-10 03:50:34 +00001186 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001187 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001188
1189 if (lastLookup == stmt) {
1190 if (cachedEntry) {
1191 assert(cachedEntry->first == stmt);
1192 return true;
1193 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001194 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001195 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001196
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001197 lastLookup = stmt;
1198
1199 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001200 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1201
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001202 if (!fb) {
1203 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001204 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001205 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001206 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001207
1208 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001209 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001210 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001211 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001212 }
1213
Ted Kremeneka099c592011-03-10 03:50:34 +00001214 cachedEntry = &*itr;
1215 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001216}
1217
Douglas Gregor4619e432008-12-05 23:32:09 +00001218// FIXME: Add support for dependent-sized array types in C++?
1219// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001220static const VariableArrayType *FindVA(const Type *t) {
1221 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1222 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001223 if (vat->getSizeExpr())
1224 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001225
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001226 t = vt->getElementType().getTypePtr();
1227 }
Mike Stump31feda52009-07-17 01:31:16 +00001228
Craig Topper25542942014-05-20 04:30:07 +00001229 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001230}
Mike Stump31feda52009-07-17 01:31:16 +00001231
Artem Dergachev40684812018-02-27 20:03:35 +00001232void CFGBuilder::consumeConstructionContext(
Artem Dergachev1527dec2018-03-12 23:12:40 +00001233 const ConstructionContextLayer *Layer, Expr *E) {
Artem Dergachev40684812018-02-27 20:03:35 +00001234 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachev1527dec2018-03-12 23:12:40 +00001235 ConstructionContextMap.lookup(E)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001236 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001237 // We might have visited this child when we were finding construction
1238 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001239 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001240 "Already within a different construction context!");
1241 } else {
Artem Dergachev1527dec2018-03-12 23:12:40 +00001242 ConstructionContextMap[E] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001243 }
1244}
1245
Artem Dergachev783a4572018-02-23 22:20:39 +00001246void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001247 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001248 if (!BuildOpts.AddRichCXXConstructors)
1249 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001250
Artem Dergachev41ffb302018-02-08 22:58:15 +00001251 if (!Child)
1252 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001253
1254 switch(Child->getStmtClass()) {
1255 case Stmt::CXXConstructExprClass:
1256 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachev40684812018-02-27 20:03:35 +00001257 consumeConstructionContext(Layer, cast<CXXConstructExpr>(Child));
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001258 break;
1259 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00001260 // FIXME: This, like the main visit, doesn't support CUDAKernelCallExpr.
1261 // FIXME: An isa<> would look much better but this whole switch is a
1262 // workaround for an internal compiler error in MSVC 2015 (see r326021).
1263 case Stmt::CallExprClass:
1264 case Stmt::CXXMemberCallExprClass:
1265 case Stmt::CXXOperatorCallExprClass:
1266 case Stmt::UserDefinedLiteralClass: {
1267 auto *CE = cast<CallExpr>(Child);
Artem Dergachev54ed6422018-03-12 23:52:36 +00001268 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(CE, *Context))
Artem Dergachev1527dec2018-03-12 23:12:40 +00001269 consumeConstructionContext(Layer, CE);
1270 break;
1271 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001272 case Stmt::ExprWithCleanupsClass: {
1273 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001274 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001275 break;
1276 }
1277 case Stmt::CXXFunctionalCastExprClass: {
1278 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001279 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001280 break;
1281 }
1282 case Stmt::ImplicitCastExprClass: {
1283 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev66030522018-03-01 01:09:24 +00001284 // TODO: We need to support CK_ConstructorConversion, maybe other kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001285 switch (Cast->getCastKind()) {
1286 case CK_NoOp:
1287 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001288 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev13f96642018-03-09 01:39:59 +00001289 default:
1290 break;
1291 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001292 break;
1293 }
1294 case Stmt::CXXBindTemporaryExprClass: {
1295 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachev783a4572018-02-23 22:20:39 +00001296 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001297 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
1298 BTE, Layer),
Artem Dergachev783a4572018-02-23 22:20:39 +00001299 BTE->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001300 break;
1301 }
1302 case Stmt::ConditionalOperatorClass: {
1303 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001304 findConstructionContexts(Layer, CO->getLHS());
1305 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001306 break;
1307 }
1308 default:
1309 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001310 }
1311}
1312
Artem Dergachev1527dec2018-03-12 23:12:40 +00001313void CFGBuilder::cleanupConstructionContext(Expr *E) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001314 assert(BuildOpts.AddRichCXXConstructors &&
1315 "We should not be managing construction contexts!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001316 assert(ConstructionContextMap.count(E) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001317 "Cannot exit construction context without the context!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001318 ConstructionContextMap.erase(E);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001319}
1320
1321
Mike Stump31feda52009-07-17 01:31:16 +00001322/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1323/// arbitrary statement. Examples include a single expression or a function
1324/// body (compound statement). The ownership of the returned CFG is
1325/// transferred to the caller. If CFG construction fails, this method returns
1326/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001327std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001328 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001329 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001330 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001331
Mike Stump31feda52009-07-17 01:31:16 +00001332 // Create an empty block that will serve as the exit block for the CFG. Since
1333 // this is the first block added to the CFG, it will be implicitly registered
1334 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001335 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001336 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001337 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001338
Matthias Gehre351c2182017-07-12 07:04:19 +00001339 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1340 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1341
Marcin Swiderski20b88732010-10-05 05:37:00 +00001342 if (BuildOpts.AddImplicitDtors)
1343 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1344 addImplicitDtorsForDestructor(DD);
1345
Ted Kremenek9aae5132007-08-23 21:42:29 +00001346 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001347 CFGBlock *B = addStmt(Statement);
1348
1349 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001350 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001351
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001352 // For C++ constructor add initializers to CFG.
1353 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001354 for (auto *I : llvm::reverse(CD->inits())) {
1355 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001356 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001357 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001358 }
1359 }
1360
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001361 if (B)
1362 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001363
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001364 // Backpatch the gotos whose label -> block mappings we didn't know when we
1365 // encountered them.
1366 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1367 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001368
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001369 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001370 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001371 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001372
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001373 // If there is no target for the goto, then we are looking at an
1374 // incomplete AST. Handle this by not registering a successor.
1375 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001376
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001377 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001378 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1379 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001380 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1381 JT.scopePosition);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001382 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1383 B, I->scopePosition, JT.scopePosition);
1384 appendScopeBegin(JT.block, VD, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001385 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001386 }
1387
1388 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001389 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001390 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1391 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001392 // Lookup the target block.
1393 LabelMapTy::iterator LI = LabelMap.find(*I);
1394
1395 // If there is no target block that contains label, then we are looking
1396 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001397 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001398
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001399 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001400 }
Mike Stump31feda52009-07-17 01:31:16 +00001401
Mike Stump31feda52009-07-17 01:31:16 +00001402 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001403 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001404
Artem Dergachev783a4572018-02-23 22:20:39 +00001405 if (BuildOpts.AddRichCXXConstructors)
1406 assert(ConstructionContextMap.empty() &&
1407 "Not all construction contexts were cleaned up!");
1408
David Blaikiee90195c2014-08-29 18:53:26 +00001409 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001410}
Mike Stump31feda52009-07-17 01:31:16 +00001411
Ted Kremenek9aae5132007-08-23 21:42:29 +00001412/// createBlock - Used to lazily create blocks that are connected
1413/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001414CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1415 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001416 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001417 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001418 return B;
1419}
Mike Stump31feda52009-07-17 01:31:16 +00001420
Chandler Carrutha70991b2011-09-13 09:13:49 +00001421/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1422/// CFG. It is *not* connected to the current (global) successor, and instead
1423/// directly tied to the exit block in order to be reachable.
1424CFGBlock *CFGBuilder::createNoReturnBlock() {
1425 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001426 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001427 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001428 return B;
1429}
1430
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001431/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001432CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001433 if (!BuildOpts.AddInitializers)
1434 return Block;
1435
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001436 bool HasTemporaries = false;
1437
1438 // Destructors of temporaries in initialization expression should be called
1439 // after initialization finishes.
1440 Expr *Init = I->getInit();
1441 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001442 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001443
Jordan Rose6d671cc2012-09-05 22:55:23 +00001444 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001445 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001446 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001447 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1448 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001449 }
1450 }
1451
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001452 autoCreateBlock();
1453 appendInitializer(Block, I);
1454
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001455 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001456 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001457 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001458 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001459
Ted Kremenek8219b822010-12-16 07:46:53 +00001460 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001461 // For expression with temporaries go directly to subexpression to omit
1462 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001463 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1464 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001465 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1466 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1467 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1468 // may cause the same Expr to appear more than once in the CFG. Doing it
1469 // here is safe because there's only one initializer per field.
1470 autoCreateBlock();
1471 appendStmt(Block, Default);
1472 if (Stmt *Child = Default->getExpr())
1473 if (CFGBlock *R = Visit(Child))
1474 Block = R;
1475 return Block;
1476 }
1477 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001478 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001479 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001480
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001481 return Block;
1482}
1483
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001484/// \brief Retrieve the type of the temporary object whose lifetime was
1485/// extended by a local reference with the given initializer.
1486static QualType getReferenceInitTemporaryType(ASTContext &Context,
Richard Smithb8c0f552016-12-09 18:49:13 +00001487 const Expr *Init,
1488 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001489 while (true) {
1490 // Skip parentheses.
1491 Init = Init->IgnoreParens();
1492
1493 // Skip through cleanups.
1494 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1495 Init = EWC->getSubExpr();
1496 continue;
1497 }
1498
1499 // Skip through the temporary-materialization expression.
1500 if (const MaterializeTemporaryExpr *MTE
1501 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1502 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001503 if (FoundMTE)
1504 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001505 continue;
1506 }
1507
1508 // Skip derived-to-base and no-op casts.
1509 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) {
1510 if ((CE->getCastKind() == CK_DerivedToBase ||
1511 CE->getCastKind() == CK_UncheckedDerivedToBase ||
1512 CE->getCastKind() == CK_NoOp) &&
1513 Init->getType()->isRecordType()) {
1514 Init = CE->getSubExpr();
1515 continue;
1516 }
1517 }
1518
1519 // Skip member accesses into rvalues.
1520 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) {
1521 if (!ME->isArrow() && ME->getBase()->isRValue()) {
1522 Init = ME->getBase();
1523 continue;
1524 }
1525 }
1526
1527 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()) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001675 Ty = getReferenceInitTemporaryType(*Context, (*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();
1788 if (QT.getTypePtr()->isReferenceType()) {
1789 // 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();
1798 if (!Init)
1799 return true;
1800
1801 // Lifetime-extending a temporary.
1802 bool FoundMTE = false;
1803 QT = getReferenceInitTemporaryType(*Context, Init, &FoundMTE);
1804 if (!FoundMTE)
1805 return true;
1806 }
1807
1808 // Check for constant size array. Set type to array element type.
1809 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1810 if (AT->getSize() == 0)
1811 return true;
1812 QT = AT->getElementType();
1813 }
1814
1815 // Check if type is a C++ class with non-trivial destructor.
1816 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1817 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1818 return true;
1819}
1820
Marcin Swiderski5e415732010-09-30 23:05:00 +00001821/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1822/// create add scope for automatic objects and temporary objects bound to
1823/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001824LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001825 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001826 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1827 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001828 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1829 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001830 return Scope;
1831
1832 // Check if variable is local.
1833 switch (VD->getStorageClass()) {
1834 case SC_None:
1835 case SC_Auto:
1836 case SC_Register:
1837 break;
1838 default: return Scope;
1839 }
1840
Matthias Gehre351c2182017-07-12 07:04:19 +00001841 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001842 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001843 // Add the variable to scope
1844 Scope = createOrReuseLocalScope(Scope);
1845 Scope->addVar(VD);
1846 ScopePos = Scope->begin();
1847 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001848 return Scope;
1849 }
1850
1851 assert(BuildOpts.AddLifetime);
1852 // Add the variable to scope
1853 Scope = createOrReuseLocalScope(Scope);
1854 Scope->addVar(VD);
1855 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001856 return Scope;
1857}
1858
1859/// addLocalScopeAndDtors - For given statement add local scope for it and
1860/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001861void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001862 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001863 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001864 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001865}
1866
Marcin Swiderski321a7072010-09-30 22:54:37 +00001867/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1868/// variables with automatic storage duration to CFGBlock's elements vector.
1869/// Elements will be prepended to physical beginning of the vector which
1870/// happens to be logical end. Use blocks terminator as statement that specifies
1871/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001872/// FIXME: This mechanism for adding automatic destructors doesn't handle
1873/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001874void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001875 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001876 if (!BuildOpts.AddImplicitDtors)
1877 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001878 BumpVectorContext &C = cfg->getBumpVectorContext();
1879 CFGBlock::iterator InsertPos
1880 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1881 for (LocalScope::const_iterator I = B; I != E; ++I)
1882 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1883 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001884}
1885
Matthias Gehre351c2182017-07-12 07:04:19 +00001886/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1887/// variables with automatic storage duration to CFGBlock's elements vector.
1888/// Elements will be prepended to physical beginning of the vector which
1889/// happens to be logical end. Use blocks terminator as statement that specifies
1890/// where lifetime ends.
1891void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1892 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1893 if (!BuildOpts.AddLifetime)
1894 return;
1895 BumpVectorContext &C = cfg->getBumpVectorContext();
1896 CFGBlock::iterator InsertPos =
1897 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1898 for (LocalScope::const_iterator I = B; I != E; ++I)
1899 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1900}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001901
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001902/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
1903/// variables with automatic storage duration to CFGBlock's elements vector.
1904/// Elements will be prepended to physical beginning of the vector which
1905/// happens to be logical end. Use blocks terminator as statement that specifies
1906/// where scope ends.
1907const VarDecl *
1908CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
1909 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1910 if (!BuildOpts.AddScopes)
1911 return nullptr;
1912 BumpVectorContext &C = cfg->getBumpVectorContext();
1913 CFGBlock::iterator InsertPos =
1914 Blk->beginScopeEndInsert(Blk->end(), 1, C);
1915 LocalScope::const_iterator PlaceToInsert = B;
1916 for (LocalScope::const_iterator I = B; I != E; ++I)
1917 PlaceToInsert = I;
1918 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminator());
1919 return *PlaceToInsert;
1920}
1921
Ted Kremenek93668002009-07-17 22:18:43 +00001922/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001923/// blocks for ternary operators, &&, and ||. We also process "," and
1924/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001925CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001926 if (!S) {
1927 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001928 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001929 }
Jordy Rose17347372011-06-10 08:49:37 +00001930
1931 if (Expr *E = dyn_cast<Expr>(S))
1932 S = E->IgnoreParens();
1933
Ted Kremenek93668002009-07-17 22:18:43 +00001934 switch (S->getStmtClass()) {
1935 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001936 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001937
1938 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001939 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001940
John McCallc07a0c72011-02-17 10:25:35 +00001941 case Stmt::BinaryConditionalOperatorClass:
1942 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1943
Ted Kremenek93668002009-07-17 22:18:43 +00001944 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001945 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001946
Ted Kremenek93668002009-07-17 22:18:43 +00001947 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00001948 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001949
Ted Kremenek93668002009-07-17 22:18:43 +00001950 case Stmt::BreakStmtClass:
1951 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001952
Ted Kremenek93668002009-07-17 22:18:43 +00001953 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001954 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001955 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001956 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001957 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001958
Ted Kremenek93668002009-07-17 22:18:43 +00001959 case Stmt::CaseStmtClass:
1960 return VisitCaseStmt(cast<CaseStmt>(S));
1961
1962 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001963 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001964
Ted Kremenek93668002009-07-17 22:18:43 +00001965 case Stmt::CompoundStmtClass:
1966 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001967
Ted Kremenek93668002009-07-17 22:18:43 +00001968 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001969 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001970
Ted Kremenek93668002009-07-17 22:18:43 +00001971 case Stmt::ContinueStmtClass:
1972 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001973
Ted Kremenekb27378c2010-01-19 20:40:33 +00001974 case Stmt::CXXCatchStmtClass:
1975 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1976
John McCall5d413782010-12-06 08:20:24 +00001977 case Stmt::ExprWithCleanupsClass:
1978 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001979
Jordan Rosee5d53932012-08-23 18:10:53 +00001980 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001981 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001982 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1983 // called function's declaration, not by the caller. If we simply add
1984 // this expression to the CFG, we could end up with the same Expr
1985 // appearing multiple times.
1986 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001987 //
1988 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1989 // expression to be used in the same function (through aggregate
1990 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00001991 return VisitStmt(S, asc);
1992
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001993 case Stmt::CXXBindTemporaryExprClass:
1994 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
1995
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001996 case Stmt::CXXConstructExprClass:
1997 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
1998
Jordan Rosec9176072014-01-13 17:59:19 +00001999 case Stmt::CXXNewExprClass:
2000 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2001
Jordan Rosed2f40792013-09-03 17:00:57 +00002002 case Stmt::CXXDeleteExprClass:
2003 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2004
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002005 case Stmt::CXXFunctionalCastExprClass:
2006 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2007
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002008 case Stmt::CXXTemporaryObjectExprClass:
2009 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2010
Ted Kremenekb27378c2010-01-19 20:40:33 +00002011 case Stmt::CXXThrowExprClass:
2012 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002013
Ted Kremenekb27378c2010-01-19 20:40:33 +00002014 case Stmt::CXXTryStmtClass:
2015 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002016
Richard Smith02e85f32011-04-14 22:09:26 +00002017 case Stmt::CXXForRangeStmtClass:
2018 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2019
Ted Kremenek93668002009-07-17 22:18:43 +00002020 case Stmt::DeclStmtClass:
2021 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002022
Ted Kremenek93668002009-07-17 22:18:43 +00002023 case Stmt::DefaultStmtClass:
2024 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002025
Ted Kremenek93668002009-07-17 22:18:43 +00002026 case Stmt::DoStmtClass:
2027 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002028
Ted Kremenek93668002009-07-17 22:18:43 +00002029 case Stmt::ForStmtClass:
2030 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002031
Ted Kremenek93668002009-07-17 22:18:43 +00002032 case Stmt::GotoStmtClass:
2033 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002034
Ted Kremenek93668002009-07-17 22:18:43 +00002035 case Stmt::IfStmtClass:
2036 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002037
Ted Kremenek8219b822010-12-16 07:46:53 +00002038 case Stmt::ImplicitCastExprClass:
2039 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002040
Ted Kremenek93668002009-07-17 22:18:43 +00002041 case Stmt::IndirectGotoStmtClass:
2042 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002043
Ted Kremenek93668002009-07-17 22:18:43 +00002044 case Stmt::LabelStmtClass:
2045 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002046
Ted Kremenekda76a942012-04-12 20:34:52 +00002047 case Stmt::LambdaExprClass:
2048 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2049
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002050 case Stmt::MaterializeTemporaryExprClass:
2051 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2052 asc);
2053
Ted Kremenek5868ec62010-04-11 17:02:10 +00002054 case Stmt::MemberExprClass:
2055 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2056
Ted Kremenek04268232011-11-05 00:10:15 +00002057 case Stmt::NullStmtClass:
2058 return Block;
2059
Ted Kremenek93668002009-07-17 22:18:43 +00002060 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002061 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2062
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002063 case Stmt::ObjCAutoreleasePoolStmtClass:
2064 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2065
Ted Kremenek93668002009-07-17 22:18:43 +00002066 case Stmt::ObjCAtSynchronizedStmtClass:
2067 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002068
Ted Kremenek93668002009-07-17 22:18:43 +00002069 case Stmt::ObjCAtThrowStmtClass:
2070 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002071
Ted Kremenek93668002009-07-17 22:18:43 +00002072 case Stmt::ObjCAtTryStmtClass:
2073 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002074
Ted Kremenek93668002009-07-17 22:18:43 +00002075 case Stmt::ObjCForCollectionStmtClass:
2076 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002077
Ted Kremenek04268232011-11-05 00:10:15 +00002078 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002079 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002080
John McCallfe96e0b2011-11-06 09:01:30 +00002081 case Stmt::PseudoObjectExprClass:
2082 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2083
Ted Kremenek93668002009-07-17 22:18:43 +00002084 case Stmt::ReturnStmtClass:
2085 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002086
Nico Weber699670e2017-08-23 15:33:16 +00002087 case Stmt::SEHExceptStmtClass:
2088 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2089
2090 case Stmt::SEHFinallyStmtClass:
2091 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2092
2093 case Stmt::SEHLeaveStmtClass:
2094 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2095
2096 case Stmt::SEHTryStmtClass:
2097 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2098
Peter Collingbournee190dee2011-03-11 19:24:49 +00002099 case Stmt::UnaryExprOrTypeTraitExprClass:
2100 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2101 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002102
Ted Kremenek93668002009-07-17 22:18:43 +00002103 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002104 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002105
Ted Kremenek93668002009-07-17 22:18:43 +00002106 case Stmt::SwitchStmtClass:
2107 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002108
Zhanyong Wan6dace612010-11-22 08:45:56 +00002109 case Stmt::UnaryOperatorClass:
2110 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2111
Ted Kremenek93668002009-07-17 22:18:43 +00002112 case Stmt::WhileStmtClass:
2113 return VisitWhileStmt(cast<WhileStmt>(S));
2114 }
2115}
Mike Stump11289f42009-09-09 15:08:12 +00002116
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002117CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002118 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002119 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002120 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002121 }
Mike Stump11289f42009-09-09 15:08:12 +00002122
Ted Kremenek93668002009-07-17 22:18:43 +00002123 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002124}
Mike Stump31feda52009-07-17 01:31:16 +00002125
Ted Kremenek93668002009-07-17 22:18:43 +00002126/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002127CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2128 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002129
Ted Kremenek8ae67872013-02-05 22:00:19 +00002130 // Visit the children in their reverse order so that they appear in
2131 // left-to-right (natural) order in the CFG.
2132 reverse_children RChildren(S);
2133 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2134 I != E; ++I) {
2135 if (Stmt *Child = *I)
2136 if (CFGBlock *R = Visit(Child))
2137 B = R;
2138 }
2139 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002140}
Mike Stump11289f42009-09-09 15:08:12 +00002141
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002142CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2143 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002144 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002145
Ted Kremenek7c58d352011-03-10 01:14:11 +00002146 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002147 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002148 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002149 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002150
Ted Kremenek9aae5132007-08-23 21:42:29 +00002151 return Block;
2152}
Mike Stump11289f42009-09-09 15:08:12 +00002153
Zhanyong Wan6dace612010-11-22 08:45:56 +00002154CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002155 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002156 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002157 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002158 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002159 }
2160
Ted Kremenek8219b822010-12-16 07:46:53 +00002161 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002162}
2163
Ted Kremeneka16436f2012-07-14 05:04:06 +00002164CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2165 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2166 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002167
Ted Kremeneka16436f2012-07-14 05:04:06 +00002168 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002169 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002170
Craig Topper25542942014-05-20 04:30:07 +00002171 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2172 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002173}
2174
2175std::pair<CFGBlock*, CFGBlock*>
2176CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2177 Stmt *Term,
2178 CFGBlock *TrueBlock,
2179 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002180 // Introspect the RHS. If it is a nested logical operation, we recursively
2181 // build the CFG using this function. Otherwise, resort to default
2182 // CFG construction behavior.
2183 Expr *RHS = B->getRHS()->IgnoreParens();
2184 CFGBlock *RHSBlock, *ExitBlock;
2185
2186 do {
2187 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2188 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002189 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002190 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2191 break;
2192 }
2193
2194 // The RHS is not a nested logical operation. Don't push the terminator
2195 // down further, but instead visit RHS and construct the respective
2196 // pieces of the CFG, and link up the RHSBlock with the terminator
2197 // we have been provided.
2198 ExitBlock = RHSBlock = createBlock(false);
2199
Richard Trieu6a6af522017-01-04 00:46:30 +00002200 // Even though KnownVal is only used in the else branch of the next
2201 // conditional, tryEvaluateBool performs additional checking on the
2202 // Expr, so it should be called unconditionally.
2203 TryResult KnownVal = tryEvaluateBool(RHS);
2204 if (!KnownVal.isKnown())
2205 KnownVal = tryEvaluateBool(B);
2206
Ted Kremenekb50e7162012-07-14 05:04:10 +00002207 if (!Term) {
2208 assert(TrueBlock == FalseBlock);
2209 addSuccessor(RHSBlock, TrueBlock);
2210 }
2211 else {
2212 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002213 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2214 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002215 }
2216
2217 Block = RHSBlock;
2218 RHSBlock = addStmt(RHS);
2219 }
2220 while (false);
2221
2222 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002223 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002224
2225 // Generate the blocks for evaluating the LHS.
2226 Expr *LHS = B->getLHS()->IgnoreParens();
2227
2228 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2229 if (B_LHS->isLogicalOp()) {
2230 if (B->getOpcode() == BO_LOr)
2231 FalseBlock = RHSBlock;
2232 else
2233 TrueBlock = RHSBlock;
2234
2235 // For the LHS, treat 'B' as the terminator that we want to sink
2236 // into the nested branch. The RHS always gets the top-most
2237 // terminator.
2238 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2239 }
2240
2241 // Create the block evaluating the LHS.
2242 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002243 CFGBlock *LHSBlock = createBlock(false);
2244 LHSBlock->setTerminator(B);
2245
Ted Kremeneka16436f2012-07-14 05:04:06 +00002246 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002247 CFGBlock *EntryLHSBlock = addStmt(LHS);
2248
2249 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002250 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002251
2252 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002253 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002254
2255 // Now link the LHSBlock with RHSBlock.
2256 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002257 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2258 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002259 } else {
2260 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002261 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2262 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002263 }
2264
Ted Kremenekb50e7162012-07-14 05:04:10 +00002265 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002266}
2267
2268CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2269 AddStmtChoice asc) {
2270 // && or ||
2271 if (B->isLogicalOp())
2272 return VisitLogicalOperator(B);
2273
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002274 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002275 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002276 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002277 addStmt(B->getRHS());
2278 return addStmt(B->getLHS());
2279 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002280
2281 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002282 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002283 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002284 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002285 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002286 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002287 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002288 }
Mike Stump11289f42009-09-09 15:08:12 +00002289
Ted Kremenek7c58d352011-03-10 01:14:11 +00002290 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002291 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002292 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002293 }
2294
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002295 CFGBlock *RBlock = Visit(B->getRHS());
2296 CFGBlock *LBlock = Visit(B->getLHS());
2297 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2298 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2299 // return RBlock. Otherwise we'll incorrectly return NULL.
2300 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002301}
2302
Ted Kremeneke2499842012-04-12 20:03:44 +00002303CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002304 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002305 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002306 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002307 }
2308 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002309}
2310
Ted Kremenek93668002009-07-17 22:18:43 +00002311CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2312 // "break" is a control-flow statement. Thus we stop processing the current
2313 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002314 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002315 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002316
Ted Kremenek93668002009-07-17 22:18:43 +00002317 // Now create a new block that ends with the break statement.
2318 Block = createBlock(false);
2319 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002320
Ted Kremenek93668002009-07-17 22:18:43 +00002321 // If there is no target for the break, then we are looking at an incomplete
2322 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002323 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002324 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002325 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002326 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002327 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002328
Ted Kremenek9aae5132007-08-23 21:42:29 +00002329 return Block;
2330}
Mike Stump11289f42009-09-09 15:08:12 +00002331
Sebastian Redl31ad7542011-03-13 17:09:40 +00002332static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002333 QualType Ty = E->getType();
2334 if (Ty->isFunctionPointerType())
2335 Ty = Ty->getAs<PointerType>()->getPointeeType();
2336 else if (Ty->isBlockPointerType())
2337 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002338
Mike Stump04c68512010-01-21 15:20:48 +00002339 const FunctionType *FT = Ty->getAs<FunctionType>();
2340 if (FT) {
2341 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002342 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smithf623c962012-04-17 00:58:00 +00002343 Proto->isNothrow(Ctx))
Mike Stump04c68512010-01-21 15:20:48 +00002344 return false;
2345 }
2346 return true;
2347}
2348
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002349CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002350 // Compute the callee type.
2351 QualType calleeType = C->getCallee()->getType();
2352 if (calleeType == Context->BoundMemberTy) {
2353 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2354
2355 // We should only get a null bound type if processing a dependent
2356 // CFG. Recover by assuming nothing.
2357 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002358 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002359
John McCallc67067f2011-05-11 07:19:11 +00002360 // If this is a call to a no-return function, this stops the block here.
2361 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2362
Mike Stump04c68512010-01-21 15:20:48 +00002363 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002364
2365 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002366 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002367 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002368 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002369 }
2370
Jordan Rose5374c072013-08-19 16:27:28 +00002371 // If this is a call to a builtin function, it might not actually evaluate
2372 // its arguments. Don't add them to the CFG if this is the case.
2373 bool OmitArguments = false;
2374
Mike Stump92244b02010-01-19 22:00:14 +00002375 if (FunctionDecl *FD = C->getDirectCallee()) {
Nico Weber758fbac2018-02-13 21:31:47 +00002376 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002377 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002378 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002379 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00002380 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
2381 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002382 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002383
Sebastian Redl31ad7542011-03-13 17:09:40 +00002384 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002385 AddEHEdge = false;
2386
Jordan Rose5374c072013-08-19 16:27:28 +00002387 if (OmitArguments) {
2388 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2389 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2390 autoCreateBlock();
2391 appendStmt(Block, C);
2392 return Visit(C->getCallee());
2393 }
2394
2395 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002396 autoCreateBlock();
2397 appendCall(Block, C);
2398
2399 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002400 }
Mike Stump11289f42009-09-09 15:08:12 +00002401
Mike Stump92244b02010-01-19 22:00:14 +00002402 if (Block) {
2403 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002404 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002405 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002406 }
Mike Stump11289f42009-09-09 15:08:12 +00002407
Chandler Carrutha70991b2011-09-13 09:13:49 +00002408 if (NoReturn)
2409 Block = createNoReturnBlock();
2410 else
2411 Block = createBlock();
2412
Artem Dergachev1527dec2018-03-12 23:12:40 +00002413 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002414
Mike Stump04c68512010-01-21 15:20:48 +00002415 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002416 // Add exceptional edges.
2417 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002418 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002419 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002420 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002421 }
Mike Stump11289f42009-09-09 15:08:12 +00002422
Mike Stump8c5d7992009-07-25 21:26:53 +00002423 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002424}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002425
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002426CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2427 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002428 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002429 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002430 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002431 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002432
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002433 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002434 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002435 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002436 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002437 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002438 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002439
Ted Kremenek21822592009-07-17 18:20:32 +00002440 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002441 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002442 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002443 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002444 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002445
Ted Kremenek21822592009-07-17 18:20:32 +00002446 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002447 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002448 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002449 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2450 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002451 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002452 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002453}
Mike Stump11289f42009-09-09 15:08:12 +00002454
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002455CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002456 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002457 addLocalScopeForStmt(C);
2458
Matthias Gehre09a134e2015-11-14 00:36:50 +00002459 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002460 // If the body ends with a ReturnStmt, the dtors will be added in
2461 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002462 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002463 }
2464
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002465 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002466
2467 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2468 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002469 // If we hit a segment of code just containing ';' (NullStmts), we can
2470 // get a null block back. In such cases, just use the LastBlock
2471 if (CFGBlock *newBlock = addStmt(*I))
2472 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002473
Ted Kremenekce499c22009-08-27 23:16:26 +00002474 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002475 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002476 }
Mike Stump92244b02010-01-19 22:00:14 +00002477
Ted Kremenek93668002009-07-17 22:18:43 +00002478 return LastBlock;
2479}
Mike Stump11289f42009-09-09 15:08:12 +00002480
John McCallc07a0c72011-02-17 10:25:35 +00002481CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002482 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002483 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002484 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002485
Ted Kremenek51d40b02009-07-17 18:15:54 +00002486 // Create the confluence block that will "merge" the results of the ternary
2487 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002488 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002489 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002490 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002491 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002492
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002493 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002494
Ted Kremenek51d40b02009-07-17 18:15:54 +00002495 // Create a block for the LHS expression if there is an LHS expression. A
2496 // GCC extension allows LHS to be NULL, causing the condition to be the
2497 // value that is returned instead.
2498 // e.g: x ?: y is shorthand for: x ? x : y;
2499 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002500 Block = nullptr;
2501 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002502 const Expr *trueExpr = C->getTrueExpr();
2503 if (trueExpr != opaqueValue) {
2504 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002505 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002506 return nullptr;
2507 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002508 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002509 else
2510 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002511
Ted Kremenek51d40b02009-07-17 18:15:54 +00002512 // Create the block for the RHS expression.
2513 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002514 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002515 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002516 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002517
Richard Smithf676e452012-07-24 21:02:14 +00002518 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2519 if (BinaryOperator *Cond =
2520 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2521 if (Cond->isLogicalOp())
2522 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2523
Ted Kremenek51d40b02009-07-17 18:15:54 +00002524 // Create the block that will contain the condition.
2525 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002526
Mike Stump773582d2009-07-23 23:25:26 +00002527 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002528 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002529 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2530 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002531 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002532 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002533
Ted Kremenekd8138012011-02-24 03:09:15 +00002534 if (opaqueValue) {
2535 // Run the condition expression if it's not trivially expressed in
2536 // terms of the opaque value (or if there is no opaque value).
2537 if (condExpr != opaqueValue)
2538 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002539
Ted Kremenekd8138012011-02-24 03:09:15 +00002540 // Before that, run the common subexpression if there was one.
2541 // At least one of this or the above will be run.
2542 return addStmt(BCO->getCommon());
2543 }
2544
2545 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002546}
2547
Ted Kremenek93668002009-07-17 22:18:43 +00002548CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002549 // Check if the Decl is for an __label__. If so, elide it from the
2550 // CFG entirely.
2551 if (isa<LabelDecl>(*DS->decl_begin()))
2552 return Block;
2553
Ted Kremenek3a601142011-05-24 20:41:31 +00002554 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002555 if (DS->isSingleDecl())
2556 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002557
Craig Topper25542942014-05-20 04:30:07 +00002558 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002559
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002560 // Build an individual DeclStmt for each decl.
2561 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2562 E = DS->decl_rend();
2563 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00002564 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
Benjamin Kramerc3f89252016-10-20 14:27:22 +00002565 unsigned A = alignof(DeclStmt) < 8 ? 8 : alignof(DeclStmt);
Mike Stump11289f42009-09-09 15:08:12 +00002566
Ted Kremenek93668002009-07-17 22:18:43 +00002567 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2568 // automatically freed with the CFG.
2569 DeclGroupRef DG(*I);
2570 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00002571 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00002572 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002573 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002574
Ted Kremenek93668002009-07-17 22:18:43 +00002575 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002576 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002577 }
Mike Stump11289f42009-09-09 15:08:12 +00002578
2579 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002580}
Mike Stump11289f42009-09-09 15:08:12 +00002581
Ted Kremenek93668002009-07-17 22:18:43 +00002582/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002583/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002584CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002585 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002586 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002587
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002588 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002589 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2590 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002591 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002592 }
Mike Stump11289f42009-09-09 15:08:12 +00002593
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002594 bool HasTemporaries = false;
2595
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002596 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002597 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002598
2599 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2600 // For static variables, we need to create a branch to track
2601 // whether or not they are initialized.
2602 if (Block) {
2603 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002604 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002605 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002606 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002607 }
2608 blockAfterStaticInit = Succ;
2609 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002610
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002611 // Destructors of temporaries in initialization expression should be called
2612 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002613 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002614 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002615 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002616
Jordan Rose6d671cc2012-09-05 22:55:23 +00002617 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002618 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002619 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002620 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2621 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002622 }
2623 }
2624
2625 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002626 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002627
Artem Dergachev783a4572018-02-23 22:20:39 +00002628 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002629 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002630 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002631
Ted Kremenek213d0532012-03-22 05:57:43 +00002632 // Keep track of the last non-null block, as 'Block' can be nulled out
2633 // if the initializer expression is something like a 'while' in a
2634 // statement-expression.
2635 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002636
Ted Kremenek93668002009-07-17 22:18:43 +00002637 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002638 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002639 // For expression with temporaries go directly to subexpression to omit
2640 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002641 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2642 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2643 LastBlock = newBlock;
2644 }
2645 else {
2646 if (CFGBlock *newBlock = Visit(Init))
2647 LastBlock = newBlock;
2648 }
Ted Kremenek93668002009-07-17 22:18:43 +00002649 }
Mike Stump11289f42009-09-09 15:08:12 +00002650
Ted Kremenek93668002009-07-17 22:18:43 +00002651 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002652 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002653 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002654 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2655 LastBlock = newBlock;
2656 }
Mike Stump11289f42009-09-09 15:08:12 +00002657
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002658 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2659
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002660 // Remove variable from local scope.
2661 if (ScopePos && VD == *ScopePos)
2662 ++ScopePos;
2663
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002664 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002665 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002666 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002667 Block = createBlock(false);
2668 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002669 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002670 addSuccessor(Block, B);
2671 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002672 }
2673
2674 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002675}
2676
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002677CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002678 // We may see an if statement in the middle of a basic block, or it may be the
2679 // first statement we are processing. In either case, we create a new basic
2680 // block. First, we create the blocks for the then...else statements, and
2681 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002682 // middle of a block, we stop processing that block. That block is then the
2683 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002684
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002685 // Save local scope position because in case of condition variable ScopePos
2686 // won't be restored when traversing AST.
2687 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2688
Richard Smitha547eb22016-07-14 00:11:03 +00002689 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002690 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002691 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002692
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002693 // Create local scope for possible condition variable.
2694 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002695 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002696 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002697
Matthias Gehre351c2182017-07-12 07:04:19 +00002698 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002699
Chris Lattner57540c52011-04-15 05:22:18 +00002700 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002701 // block.
2702 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002703 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002704 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002705 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002706 }
Mike Stump31feda52009-07-17 01:31:16 +00002707
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002708 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002709 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002710
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002711 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002712 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002713
Ted Kremenek9aae5132007-08-23 21:42:29 +00002714 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002715 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002716 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002717
2718 // If branch is not a compound statement create implicit scope
2719 // and add destructors.
2720 if (!isa<CompoundStmt>(Else))
2721 addLocalScopeAndDtors(Else);
2722
Ted Kremenek93668002009-07-17 22:18:43 +00002723 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002724
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002725 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2726 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002727 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002728 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002729 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002730 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002731 }
Mike Stump31feda52009-07-17 01:31:16 +00002732
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002733 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002734 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002735 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002736 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002737 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002738 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002739 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002740
2741 // If branch is not a compound statement create implicit scope
2742 // and add destructors.
2743 if (!isa<CompoundStmt>(Then))
2744 addLocalScopeAndDtors(Then);
2745
Ted Kremenek93668002009-07-17 22:18:43 +00002746 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002747
Ted Kremenek1b379512009-04-01 03:52:47 +00002748 if (!ThenBlock) {
2749 // We can reach here if the "then" body has all NullStmts.
2750 // Create an empty block so we can distinguish between true and false
2751 // branches in path-sensitive analyses.
2752 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002753 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002754 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002755 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002756 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002757 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002758 }
2759
Ted Kremenekb50e7162012-07-14 05:04:10 +00002760 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2761 // having these handle the actual control-flow jump. Note that
2762 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2763 // we resort to the old control-flow behavior. This special handling
2764 // removes infeasible paths from the control-flow graph by having the
2765 // control-flow transfer of '&&' or '||' go directly into the then/else
2766 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002767 BinaryOperator *Cond =
2768 I->getConditionVariable()
2769 ? nullptr
2770 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2771 CFGBlock *LastBlock;
2772 if (Cond && Cond->isLogicalOp())
2773 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2774 else {
2775 // Now create a new block containing the if statement.
2776 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002777
Richard Smith509bbd12017-01-13 22:16:41 +00002778 // Set the terminator of the new block to the If statement.
2779 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002780
Richard Smith509bbd12017-01-13 22:16:41 +00002781 // See if this is a known constant.
2782 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002783
Richard Smith509bbd12017-01-13 22:16:41 +00002784 // Add the successors. If we know that specific branches are
2785 // unreachable, inform addSuccessor() of that knowledge.
2786 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2787 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002788
Richard Smith509bbd12017-01-13 22:16:41 +00002789 // Add the condition as the last statement in the new block. This may
2790 // create new blocks as the condition may contain control-flow. Any newly
2791 // created blocks will be pointed to be "Block".
2792 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002793
Richard Smith509bbd12017-01-13 22:16:41 +00002794 // If the IfStmt contains a condition variable, add it and its
2795 // initializer to the CFG.
2796 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2797 autoCreateBlock();
2798 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2799 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002800 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002801
Richard Smitha547eb22016-07-14 00:11:03 +00002802 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2803 if (Stmt *Init = I->getInit()) {
2804 autoCreateBlock();
2805 LastBlock = addStmt(Init);
2806 }
2807
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002808 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002809}
Mike Stump31feda52009-07-17 01:31:16 +00002810
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002811CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002812 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002813 //
Mike Stump31feda52009-07-17 01:31:16 +00002814 // NOTE: If a "return" appears in the middle of a block, this means that the
2815 // code afterwards is DEAD (unreachable). We still keep a basic block
2816 // for that code; a simple "mark-and-sweep" from the entry block will be
2817 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002818
2819 // Create the new block.
2820 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002821
Matthias Gehre351c2182017-07-12 07:04:19 +00002822 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002823
Artem Dergachev783a4572018-02-23 22:20:39 +00002824 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002825 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
Artem Dergachev783a4572018-02-23 22:20:39 +00002826 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002827
Pavel Labath921e7652013-09-06 08:12:48 +00002828 // If the one of the destructors does not return, we already have the Exit
2829 // block as a successor.
2830 if (!Block->hasNoReturnElement())
2831 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002832
2833 // Add the return statement to the block. This may create new blocks if R
2834 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002835 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002836}
2837
Nico Weber699670e2017-08-23 15:33:16 +00002838CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2839 // SEHExceptStmt are treated like labels, so they are the first statement in a
2840 // block.
2841
2842 // Save local scope position because in case of exception variable ScopePos
2843 // won't be restored when traversing AST.
2844 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2845
2846 addStmt(ES->getBlock());
2847 CFGBlock *SEHExceptBlock = Block;
2848 if (!SEHExceptBlock)
2849 SEHExceptBlock = createBlock();
2850
2851 appendStmt(SEHExceptBlock, ES);
2852
2853 // Also add the SEHExceptBlock as a label, like with regular labels.
2854 SEHExceptBlock->setLabel(ES);
2855
2856 // Bail out if the CFG is bad.
2857 if (badCFG)
2858 return nullptr;
2859
2860 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2861 Block = nullptr;
2862
2863 return SEHExceptBlock;
2864}
2865
2866CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2867 return VisitCompoundStmt(FS->getBlock());
2868}
2869
2870CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2871 // "__leave" is a control-flow statement. Thus we stop processing the current
2872 // block.
2873 if (badCFG)
2874 return nullptr;
2875
2876 // Now create a new block that ends with the __leave statement.
2877 Block = createBlock(false);
2878 Block->setTerminator(LS);
2879
2880 // If there is no target for the __leave, then we are looking at an incomplete
2881 // AST. This means that the CFG cannot be constructed.
2882 if (SEHLeaveJumpTarget.block) {
2883 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2884 addSuccessor(Block, SEHLeaveJumpTarget.block);
2885 } else
2886 badCFG = true;
2887
2888 return Block;
2889}
2890
2891CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2892 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2893 // processing the current block.
2894 CFGBlock *SEHTrySuccessor = nullptr;
2895
2896 if (Block) {
2897 if (badCFG)
2898 return nullptr;
2899 SEHTrySuccessor = Block;
2900 } else SEHTrySuccessor = Succ;
2901
2902 // FIXME: Implement __finally support.
2903 if (Terminator->getFinallyHandler())
2904 return NYS();
2905
2906 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2907
2908 // Create a new block that will contain the __try statement.
2909 CFGBlock *NewTryTerminatedBlock = createBlock(false);
2910
2911 // Add the terminator in the __try block.
2912 NewTryTerminatedBlock->setTerminator(Terminator);
2913
2914 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
2915 // The code after the try is the implicit successor if there's an __except.
2916 Succ = SEHTrySuccessor;
2917 Block = nullptr;
2918 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
2919 if (!ExceptBlock)
2920 return nullptr;
2921 // Add this block to the list of successors for the block with the try
2922 // statement.
2923 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
2924 }
2925 if (PrevSEHTryTerminatedBlock)
2926 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
2927 else
2928 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
2929
2930 // The code after the try is the implicit successor.
2931 Succ = SEHTrySuccessor;
2932
2933 // Save the current "__try" context.
2934 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
2935 NewTryTerminatedBlock);
2936 cfg->addTryDispatchBlock(TryTerminatedBlock);
2937
2938 // Save the current value for the __leave target.
2939 // All __leaves should go to the code following the __try
2940 // (FIXME: or if the __try has a __finally, to the __finally.)
2941 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
2942 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
2943
2944 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
2945 Block = nullptr;
2946 return addStmt(Terminator->getTryBlock());
2947}
2948
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002949CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002950 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002951 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002952 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002953
Ted Kremenek93668002009-07-17 22:18:43 +00002954 if (!LabelBlock) // This can happen when the body is empty, i.e.
2955 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002956
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002957 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2958 "label already in map");
2959 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002960
2961 // Labels partition blocks, so this is the end of the basic block we were
2962 // processing (L is the block's label). Because this is label (and we have
2963 // already processed the substatement) there is no extra control-flow to worry
2964 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002965 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002966 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002967 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002968
2969 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002970 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002971
Ted Kremenek9aae5132007-08-23 21:42:29 +00002972 // This block is now the implicit successor of other blocks.
2973 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002974
Ted Kremenek9aae5132007-08-23 21:42:29 +00002975 return LabelBlock;
2976}
2977
Devin Coughlinb6029b72015-11-25 22:35:37 +00002978CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
2979 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2980 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
2981 if (Expr *CopyExpr = CI.getCopyExpr()) {
2982 CFGBlock *Tmp = Visit(CopyExpr);
2983 if (Tmp)
2984 LastBlock = Tmp;
2985 }
2986 }
2987 return LastBlock;
2988}
2989
Ted Kremenekda76a942012-04-12 20:34:52 +00002990CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
2991 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2992 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
2993 et = E->capture_init_end(); it != et; ++it) {
2994 if (Expr *Init = *it) {
2995 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00002996 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00002997 LastBlock = Tmp;
2998 }
2999 }
3000 return LastBlock;
3001}
3002
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003003CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003004 // Goto is a control-flow statement. Thus we stop processing the current
3005 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003006
Ted Kremenek9aae5132007-08-23 21:42:29 +00003007 Block = createBlock(false);
3008 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003009
3010 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003011 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003012
Ted Kremenek9aae5132007-08-23 21:42:29 +00003013 if (I == LabelMap.end())
3014 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003015 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3016 else {
3017 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003018 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003019 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003020 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003021
Mike Stump31feda52009-07-17 01:31:16 +00003022 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003023}
3024
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003025CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003026 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003027
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003028 // Save local scope position because in case of condition variable ScopePos
3029 // won't be restored when traversing AST.
3030 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3031
3032 // Create local scope for init statement and possible condition variable.
3033 // Add destructor for init statement and condition variable.
3034 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003035 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003036 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003037 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3038
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003039 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003040 addLocalScopeForVarDecl(VD);
3041 LocalScope::const_iterator ContinueScopePos = ScopePos;
3042
Matthias Gehre351c2182017-07-12 07:04:19 +00003043 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003044
Peter Szecsi999a25f2017-08-19 11:19:16 +00003045 addLoopExit(F);
3046
Mike Stump014b3ea2009-07-21 01:12:51 +00003047 // "for" is a control-flow statement. Thus we stop processing the current
3048 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003049 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003050 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003051 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003052 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003053 } else
3054 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003055
Ted Kremenek304a9532010-05-21 20:30:15 +00003056 // Save the current value for the break targets.
3057 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003058 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003059 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003060
Craig Topper25542942014-05-20 04:30:07 +00003061 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003062
Ted Kremenek9aae5132007-08-23 21:42:29 +00003063 // Now create the loop body.
3064 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003065 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003066
Ted Kremenekb50e7162012-07-14 05:04:10 +00003067 // Save the current values for Block, Succ, continue and break targets.
3068 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3069 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003070
Ted Kremenekb50e7162012-07-14 05:04:10 +00003071 // Create an empty block to represent the transition block for looping back
3072 // to the head of the loop. If we have increment code, it will
3073 // go in this block as well.
3074 Block = Succ = TransitionBlock = createBlock(false);
3075 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003076
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003077 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003078 // Generate increment code in its own basic block. This is the target of
3079 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003080 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003081 }
Mike Stump31feda52009-07-17 01:31:16 +00003082
Ted Kremenek902393b2009-04-28 00:51:56 +00003083 // Finish up the increment (or empty) block if it hasn't been already.
3084 if (Block) {
3085 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003086 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003087 return nullptr;
3088 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003089 }
Mike Stump31feda52009-07-17 01:31:16 +00003090
Ted Kremenekb50e7162012-07-14 05:04:10 +00003091 // The starting block for the loop increment is the block that should
3092 // represent the 'loop target' for looping back to the start of the loop.
3093 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3094 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003095
Ted Kremenekb50e7162012-07-14 05:04:10 +00003096 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003097 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003098
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003099 // If body is not a compound statement create implicit scope
3100 // and add destructors.
3101 if (!isa<CompoundStmt>(F->getBody()))
3102 addLocalScopeAndDtors(F->getBody());
3103
Mike Stump31feda52009-07-17 01:31:16 +00003104 // Now populate the body block, and in the process create new blocks as we
3105 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003106 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003107
Ted Kremenekb50e7162012-07-14 05:04:10 +00003108 if (!BodyBlock) {
3109 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3110 // Use the continue jump target as the proxy for the body.
3111 BodyBlock = ContinueJumpTarget.block;
3112 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003113 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003114 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003115 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00003116
3117 // Because of short-circuit evaluation, the condition of the loop can span
3118 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3119 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003120 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003121
Ted Kremenekb50e7162012-07-14 05:04:10 +00003122 do {
3123 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003124 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003125
3126 // Specially handle logical operators, which have a slightly
3127 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003128 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003129 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003130 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003131 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003132 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3133 break;
3134 }
3135
3136 // The default case when not handling logical operators.
3137 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3138 ExitConditionBlock->setTerminator(F);
3139
3140 // See if this is a known constant.
3141 TryResult KnownVal(true);
3142
3143 if (C) {
3144 // Now add the actual condition to the condition block.
3145 // Because the condition itself may contain control-flow, new blocks may
3146 // be created. Thus we update "Succ" after adding the condition.
3147 Block = ExitConditionBlock;
3148 EntryConditionBlock = addStmt(C);
3149
3150 // If this block contains a condition variable, add both the condition
3151 // variable and initializer to the CFG.
3152 if (VarDecl *VD = F->getConditionVariable()) {
3153 if (Expr *Init = VD->getInit()) {
3154 autoCreateBlock();
3155 appendStmt(Block, F->getConditionVariableDeclStmt());
3156 EntryConditionBlock = addStmt(Init);
3157 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003158 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003159 }
3160 }
3161
3162 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003163 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003164
3165 KnownVal = tryEvaluateBool(C);
3166 }
3167
3168 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003169 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003170 // Link up the condition block with the code that follows the loop. (the
3171 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003172 addSuccessor(ExitConditionBlock,
3173 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003174 } while (false);
3175
3176 // Link up the loop-back block to the entry condition block.
3177 addSuccessor(TransitionBlock, EntryConditionBlock);
3178
3179 // The condition block is the implicit successor for any code above the loop.
3180 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003181
Ted Kremenek9aae5132007-08-23 21:42:29 +00003182 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003183 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003184 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003185 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3186 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003187 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003188 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003189 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003190
3191 // There is no loop initialization. We are thus basically a while loop.
3192 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003193 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003194 Succ = EntryConditionBlock;
3195 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003196}
3197
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003198CFGBlock *
3199CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3200 AddStmtChoice asc) {
3201 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003202 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003203 MTE->getTemporary());
3204
3205 return VisitStmt(MTE, asc);
3206}
3207
Ted Kremenek5868ec62010-04-11 17:02:10 +00003208CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003209 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003210 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003211 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003212 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003213 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003214}
3215
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003216CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003217 // Objective-C fast enumeration 'for' statements:
3218 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3219 //
3220 // for ( Type newVariable in collection_expression ) { statements }
3221 //
3222 // becomes:
3223 //
3224 // prologue:
3225 // 1. collection_expression
3226 // T. jump to loop_entry
3227 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003228 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003229 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3230 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3231 // TB:
3232 // statements
3233 // T. jump to loop_entry
3234 // FB:
3235 // what comes after
3236 //
3237 // and
3238 //
3239 // Type existingItem;
3240 // for ( existingItem in expression ) { statements }
3241 //
3242 // becomes:
3243 //
Mike Stump31feda52009-07-17 01:31:16 +00003244 // the same with newVariable replaced with existingItem; the binding works
3245 // the same except that for one ObjCForCollectionStmt::getElement() returns
3246 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003247
Craig Topper25542942014-05-20 04:30:07 +00003248 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003249
Ted Kremenek9d56e642008-11-11 17:10:00 +00003250 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003251 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003252 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003253 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003254 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003255 } else
3256 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003257
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003258 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003259 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003260
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003261 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003262 ExitConditionBlock->setTerminator(S);
3263
3264 // The last statement in the block should be the ObjCForCollectionStmt, which
3265 // performs the actual binding to 'element' and determines if there are any
3266 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003267 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003268 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003269
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003270 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003271 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003272 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003273 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3274 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003275 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003276 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003277 return nullptr;
3278 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003279 }
Mike Stump31feda52009-07-17 01:31:16 +00003280
3281 // The condition block is the implicit successor for the loop body as well as
3282 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003283 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003284
Ted Kremenek9d56e642008-11-11 17:10:00 +00003285 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003286 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003287 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003288 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003289 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003290 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003291
Anna Zaks56b49752013-06-22 00:23:20 +00003292 // Add an intermediate block between the BodyBlock and the
3293 // EntryConditionBlock to represent the "loop back" transition, for looping
3294 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003295 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003296 Succ = LoopBackBlock = createBlock();
3297 LoopBackBlock->setLoopTarget(S);
3298
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003299 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003300 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003301
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003302 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003303
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003304 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003305 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003306 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003307 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003308 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003309 }
Mike Stump31feda52009-07-17 01:31:16 +00003310
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003311 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003312 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003313 }
Mike Stump31feda52009-07-17 01:31:16 +00003314
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003315 // Link up the condition block with the code that follows the loop.
3316 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003317 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003318
Ted Kremenek9d56e642008-11-11 17:10:00 +00003319 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003320 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003321 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003322}
3323
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003324CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3325 // Inline the body.
3326 return addStmt(S->getSubStmt());
3327 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3328}
3329
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003330CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003331 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003332
Ted Kremenek49805452009-05-02 01:49:13 +00003333 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003334 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003335
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003336 // The sync body starts its own basic block. This makes it a little easier
3337 // for diagnostic clients.
3338 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003339 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003340 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003341
Craig Topper25542942014-05-20 04:30:07 +00003342 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003343 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003344 }
Mike Stump31feda52009-07-17 01:31:16 +00003345
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003346 // Add the @synchronized to the CFG.
3347 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003348 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003349
Ted Kremenek49805452009-05-02 01:49:13 +00003350 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003351 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003352}
Mike Stump31feda52009-07-17 01:31:16 +00003353
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003354CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003355 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003356 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003357}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003358
John McCallfe96e0b2011-11-06 09:01:30 +00003359CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3360 autoCreateBlock();
3361
3362 // Add the PseudoObject as the last thing.
3363 appendStmt(Block, E);
3364
3365 CFGBlock *lastBlock = Block;
3366
3367 // Before that, evaluate all of the semantics in order. In
3368 // CFG-land, that means appending them in reverse order.
3369 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3370 Expr *Semantic = E->getSemanticExpr(--i);
3371
3372 // If the semantic is an opaque value, we're being asked to bind
3373 // it to its source expression.
3374 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3375 Semantic = OVE->getSourceExpr();
3376
3377 if (CFGBlock *B = Visit(Semantic))
3378 lastBlock = B;
3379 }
3380
3381 return lastBlock;
3382}
3383
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003384CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003385 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003386
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003387 // Save local scope position because in case of condition variable ScopePos
3388 // won't be restored when traversing AST.
3389 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3390
3391 // Create local scope for possible condition variable.
3392 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003393 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003394 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003395 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003396 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003397 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003398 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003399
Mike Stump014b3ea2009-07-21 01:12:51 +00003400 // "while" is a control-flow statement. Thus we stop processing the current
3401 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003402 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003403 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003404 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003405 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003406 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003407 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003408 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003409 }
Mike Stump31feda52009-07-17 01:31:16 +00003410
Craig Topper25542942014-05-20 04:30:07 +00003411 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003412
Ted Kremenek9aae5132007-08-23 21:42:29 +00003413 // Process the loop body.
3414 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003415 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003416
Ted Kremenekb50e7162012-07-14 05:04:10 +00003417 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003418 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3419 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003420 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003421
Mike Stump31feda52009-07-17 01:31:16 +00003422 // Create an empty block to represent the transition block for looping back
3423 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003424 Succ = TransitionBlock = createBlock(false);
3425 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003426 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003427
Ted Kremenek9aae5132007-08-23 21:42:29 +00003428 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003429 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003430
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003431 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003432 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003433
3434 // If body is not a compound statement create implicit scope
3435 // and add destructors.
3436 if (!isa<CompoundStmt>(W->getBody()))
3437 addLocalScopeAndDtors(W->getBody());
3438
Ted Kremenek9aae5132007-08-23 21:42:29 +00003439 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003440 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003441
Ted Kremeneke9610502007-08-30 18:39:40 +00003442 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003443 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003444 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003445 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003446 }
3447
3448 // Because of short-circuit evaluation, the condition of the loop can span
3449 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3450 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003451 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003452
3453 do {
3454 Expr *C = W->getCond();
3455
3456 // Specially handle logical operators, which have a slightly
3457 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003458 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003459 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003460 std::tie(EntryConditionBlock, ExitConditionBlock) =
3461 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003462 break;
3463 }
3464
3465 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003466 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003467 ExitConditionBlock->setTerminator(W);
3468
3469 // Now add the actual condition to the condition block.
3470 // Because the condition itself may contain control-flow, new blocks may
3471 // be created. Thus we update "Succ" after adding the condition.
3472 Block = ExitConditionBlock;
3473 Block = EntryConditionBlock = addStmt(C);
3474
3475 // If this block contains a condition variable, add both the condition
3476 // variable and initializer to the CFG.
3477 if (VarDecl *VD = W->getConditionVariable()) {
3478 if (Expr *Init = VD->getInit()) {
3479 autoCreateBlock();
3480 appendStmt(Block, W->getConditionVariableDeclStmt());
3481 EntryConditionBlock = addStmt(Init);
3482 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003483 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003484 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003485 }
Mike Stump31feda52009-07-17 01:31:16 +00003486
Ted Kremenekb50e7162012-07-14 05:04:10 +00003487 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003488 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003489
3490 // See if this is a known constant.
3491 const TryResult& KnownVal = tryEvaluateBool(C);
3492
Ted Kremenek30754282009-07-24 04:47:11 +00003493 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003494 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003495 // Link up the condition block with the code that follows the loop. (the
3496 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003497 addSuccessor(ExitConditionBlock,
3498 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003499 } while(false);
3500
3501 // Link up the loop-back block to the entry condition block.
3502 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003503
3504 // There can be no more statements in the condition block since we loop back
3505 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003506 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003507
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003508 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003509 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003510 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003511}
Mike Stump11289f42009-09-09 15:08:12 +00003512
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003513CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003514 // FIXME: For now we pretend that @catch and the code it contains does not
3515 // exit.
3516 return Block;
3517}
Mike Stump31feda52009-07-17 01:31:16 +00003518
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003519CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003520 // FIXME: This isn't complete. We basically treat @throw like a return
3521 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003522
Ted Kremenek0868eea2009-09-24 18:45:41 +00003523 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003524 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003525 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003526
Ted Kremenek93041ba2008-12-09 20:20:09 +00003527 // Create the new block.
3528 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003529
Ted Kremenek93041ba2008-12-09 20:20:09 +00003530 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003531 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003532
3533 // Add the statement to the block. This may create new blocks if S contains
3534 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003535 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003536}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003537
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003538CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003539 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003540 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003541 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003542
3543 // Create the new block.
3544 Block = createBlock(false);
3545
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003546 if (TryTerminatedBlock)
3547 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003548 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003549 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003550 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003551 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003552
3553 // Add the statement to the block. This may create new blocks if S contains
3554 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003555 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003556}
3557
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003558CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003559 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003560
Peter Szecsi999a25f2017-08-19 11:19:16 +00003561 addLoopExit(D);
3562
Mike Stump8d50b6a2009-07-21 01:27:50 +00003563 // "do...while" is a control-flow statement. Thus we stop processing the
3564 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003565 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003566 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003567 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003568 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003569 } else
3570 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003571
3572 // Because of short-circuit evaluation, the condition of the loop can span
3573 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3574 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003575 CFGBlock *ExitConditionBlock = createBlock(false);
3576 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003577
Ted Kremenek81e14852007-08-27 19:46:09 +00003578 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003579 ExitConditionBlock->setTerminator(D);
3580
3581 // Now add the actual condition to the condition block. Because the condition
3582 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003583 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003584 Block = ExitConditionBlock;
3585 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003586 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003587 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003588 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003589 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003590 }
Mike Stump31feda52009-07-17 01:31:16 +00003591
Ted Kremeneka1523a32008-02-27 07:20:00 +00003592 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003593 Succ = EntryConditionBlock;
3594
Mike Stump773582d2009-07-23 23:25:26 +00003595 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003596 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003597
Ted Kremenek9aae5132007-08-23 21:42:29 +00003598 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003599 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003600 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003601 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003602
Ted Kremenek9aae5132007-08-23 21:42:29 +00003603 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003604 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3605 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3606 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003607
Ted Kremenek9aae5132007-08-23 21:42:29 +00003608 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003609 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003610
Ted Kremenek9aae5132007-08-23 21:42:29 +00003611 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003612 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003613
Ted Kremenek9aae5132007-08-23 21:42:29 +00003614 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003615 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003616
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003617 // If body is not a compound statement create implicit scope
3618 // and add destructors.
3619 if (!isa<CompoundStmt>(D->getBody()))
3620 addLocalScopeAndDtors(D->getBody());
3621
Ted Kremenek9aae5132007-08-23 21:42:29 +00003622 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003623 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003624
Ted Kremeneke9610502007-08-30 18:39:40 +00003625 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003626 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003627 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003628 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003629 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003630 }
Mike Stump31feda52009-07-17 01:31:16 +00003631
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003632 // Add an intermediate block between the BodyBlock and the
3633 // ExitConditionBlock to represent the "loop back" transition. Create an
3634 // empty block to represent the transition block for looping back to the
3635 // head of the loop.
3636 // FIXME: Can we do this more efficiently without adding another block?
3637 Block = nullptr;
3638 Succ = BodyBlock;
3639 CFGBlock *LoopBackBlock = createBlock();
3640 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003641
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003642 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003643 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003644 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003645 else
Craig Topper25542942014-05-20 04:30:07 +00003646 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003647 }
Mike Stump31feda52009-07-17 01:31:16 +00003648
Ted Kremenek30754282009-07-24 04:47:11 +00003649 // Link up the condition block with the code that follows the loop.
3650 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003651 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003652
3653 // There can be no more statements in the body block(s) since we loop back to
3654 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003655 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003656
Ted Kremenek9aae5132007-08-23 21:42:29 +00003657 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003658 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003659 return BodyBlock;
3660}
3661
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003662CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003663 // "continue" is a control-flow statement. Thus we stop processing the
3664 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003665 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003666 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003667
Ted Kremenek9aae5132007-08-23 21:42:29 +00003668 // Now create a new block that ends with the continue statement.
3669 Block = createBlock(false);
3670 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003671
Ted Kremenek9aae5132007-08-23 21:42:29 +00003672 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003673 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003674 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003675 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003676 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003677 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003678 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003679
Ted Kremenek9aae5132007-08-23 21:42:29 +00003680 return Block;
3681}
Mike Stump11289f42009-09-09 15:08:12 +00003682
Peter Collingbournee190dee2011-03-11 19:24:49 +00003683CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3684 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003685 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003686 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003687 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003688 }
Mike Stump11289f42009-09-09 15:08:12 +00003689
Ted Kremenek93668002009-07-17 22:18:43 +00003690 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003691 CFGBlock *lastBlock = Block;
3692
Ted Kremenek93668002009-07-17 22:18:43 +00003693 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003694 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003695 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003696 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003697 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003698 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003699}
Mike Stump11289f42009-09-09 15:08:12 +00003700
Ted Kremenek93668002009-07-17 22:18:43 +00003701/// VisitStmtExpr - Utility method to handle (nested) statement
3702/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003703CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003704 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003705 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003706 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003707 }
Ted Kremenek93668002009-07-17 22:18:43 +00003708 return VisitCompoundStmt(SE->getSubStmt());
3709}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003710
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003711CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003712 // "switch" is a control-flow statement. Thus we stop processing the current
3713 // block.
Craig Topper25542942014-05-20 04:30:07 +00003714 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003715
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003716 // Save local scope position because in case of condition variable ScopePos
3717 // won't be restored when traversing AST.
3718 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3719
Richard Smitha547eb22016-07-14 00:11:03 +00003720 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003721 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003722 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003723
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003724 // Create local scope for possible condition variable.
3725 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003726 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003727 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003728
Matthias Gehre351c2182017-07-12 07:04:19 +00003729 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003730
Ted Kremenek9aae5132007-08-23 21:42:29 +00003731 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003732 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003733 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003734 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003735 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003736
3737 // Save the current "switch" context.
3738 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003739 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003740 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003741
Mike Stump31feda52009-07-17 01:31:16 +00003742 // Set the "default" case to be the block after the switch statement. If the
3743 // switch statement contains a "default:", this value will be overwritten with
3744 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003745 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003746
Ted Kremenek9aae5132007-08-23 21:42:29 +00003747 // Create a new block that will contain the switch statement.
3748 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003749
Ted Kremenek9aae5132007-08-23 21:42:29 +00003750 // Now process the switch body. The code after the switch is the implicit
3751 // successor.
3752 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003753 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003754
3755 // When visiting the body, the case statements should automatically get linked
3756 // up to the switch. We also don't keep a pointer to the body, since all
3757 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003758 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003759 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003760
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003761 // For pruning unreachable case statements, save the current state
3762 // for tracking the condition value.
3763 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3764 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003765
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003766 // Determine if the switch condition can be explicitly evaluated.
3767 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003768 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003769 bool b = tryEvaluate(Terminator->getCond(), result);
3770 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003771 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003772
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003773 // If body is not a compound statement create implicit scope
3774 // and add destructors.
3775 if (!isa<CompoundStmt>(Terminator->getBody()))
3776 addLocalScopeAndDtors(Terminator->getBody());
3777
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003778 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003779 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003780 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003781 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003782 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003783
Mike Stump31feda52009-07-17 01:31:16 +00003784 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003785 // following the switch body. Moreover, take into account if all the
3786 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003787 //
3788 // Note: We add a successor to a switch that is considered covered yet has no
3789 // case statements if the enumeration has no enumerators.
3790 bool SwitchAlwaysHasSuccessor = false;
3791 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3792 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3793 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003794 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3795 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003796
Ted Kremenek81e14852007-08-27 19:46:09 +00003797 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003798 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003799 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003800 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003801
Richard Smitha547eb22016-07-14 00:11:03 +00003802 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003803 // SwitchStmt and the condition variable initialization to the CFG.
3804 if (VarDecl *VD = Terminator->getConditionVariable()) {
3805 if (Expr *Init = VD->getInit()) {
3806 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003807 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003808 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003809 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003810 }
3811 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003812
Richard Smitha547eb22016-07-14 00:11:03 +00003813 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3814 if (Stmt *Init = Terminator->getInit()) {
3815 autoCreateBlock();
3816 LastBlock = addStmt(Init);
3817 }
3818
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003819 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003820}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003821
3822static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003823 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003824 const CaseStmt *CS,
3825 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003826 if (!switchCond)
3827 return true;
3828
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003829 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003830
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003831 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003832 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003833 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003834 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003835 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003836
3837 if (condInt == lhsInt) {
3838 addCase = true;
3839 switchExclusivelyCovered = true;
3840 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003841 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003842 if (const Expr *RHS = CS->getRHS()) {
3843 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003844 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003845 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003846 addCase = true;
3847 switchExclusivelyCovered = true;
3848 }
3849 }
3850 }
3851 }
3852 else
3853 addCase = true;
3854 }
3855 return addCase;
3856}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003857
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003858CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003859 // CaseStmts are essentially labels, so they are the first statement in a
3860 // block.
Craig Topper25542942014-05-20 04:30:07 +00003861 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003862
Ted Kremenek60fa6572010-08-04 23:54:30 +00003863 if (Stmt *Sub = CS->getSubStmt()) {
3864 // For deeply nested chains of CaseStmts, instead of doing a recursion
3865 // (which can blow out the stack), manually unroll and create blocks
3866 // along the way.
3867 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003868 CFGBlock *currentBlock = createBlock(false);
3869 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003870
Ted Kremenek60fa6572010-08-04 23:54:30 +00003871 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003872 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003873 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003874 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003875
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003876 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003877 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003878 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003879 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003880
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003881 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003882 CS = cast<CaseStmt>(Sub);
3883 Sub = CS->getSubStmt();
3884 }
3885
3886 addStmt(Sub);
3887 }
Mike Stump11289f42009-09-09 15:08:12 +00003888
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003889 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003890 if (!CaseBlock)
3891 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003892
3893 // Cases statements partition blocks, so this is the top of the basic block we
3894 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003895 CaseBlock->setLabel(CS);
3896
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003897 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003898 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003899
3900 // Add this block to the list of successors for the block with the switch
3901 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003902 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003903 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003904 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003905 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003906
Ted Kremenek9aae5132007-08-23 21:42:29 +00003907 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003908 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003909
Ted Kremenek60fa6572010-08-04 23:54:30 +00003910 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003911 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003912 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003913 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003914 // This block is now the implicit successor of other blocks.
3915 Succ = CaseBlock;
3916 }
Mike Stump31feda52009-07-17 01:31:16 +00003917
Ted Kremenek60fa6572010-08-04 23:54:30 +00003918 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003919}
Mike Stump31feda52009-07-17 01:31:16 +00003920
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003921CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003922 if (Terminator->getSubStmt())
3923 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003924
Ted Kremenek654c78f2008-02-13 22:05:39 +00003925 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003926
3927 if (!DefaultCaseBlock)
3928 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003929
3930 // Default statements partition blocks, so this is the top of the basic block
3931 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003932 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003933
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003934 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003935 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003936
Mike Stump31feda52009-07-17 01:31:16 +00003937 // Unlike case statements, we don't add the default block to the successors
3938 // for the switch statement immediately. This is done when we finish
3939 // processing the switch statement. This allows for the default case
3940 // (including a fall-through to the code after the switch statement) to always
3941 // be the last successor of a switch-terminated block.
3942
Ted Kremenek654c78f2008-02-13 22:05:39 +00003943 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003944 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003945
Ted Kremenek654c78f2008-02-13 22:05:39 +00003946 // This block is now the implicit successor of other blocks.
3947 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003948
3949 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003950}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003951
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003952CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3953 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3954 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003955 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003956
3957 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003958 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003959 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003960 TrySuccessor = Block;
3961 } else TrySuccessor = Succ;
3962
Mike Stump0bdba6c2010-01-20 01:15:34 +00003963 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003964
3965 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003966 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003967 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003968 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003969
Mike Stump0bdba6c2010-01-20 01:15:34 +00003970 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003971 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3972 // The code after the try is the implicit successor.
3973 Succ = TrySuccessor;
3974 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003975 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003976 HasCatchAll = true;
3977 }
Craig Topper25542942014-05-20 04:30:07 +00003978 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003979 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00003980 if (!CatchBlock)
3981 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003982 // Add this block to the list of successors for the block with the try
3983 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003984 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003985 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00003986 if (!HasCatchAll) {
3987 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003988 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00003989 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003990 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00003991 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003992
3993 // The code after the try is the implicit successor.
3994 Succ = TrySuccessor;
3995
Mike Stump845384a2010-01-20 01:30:58 +00003996 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00003997 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
3998 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00003999
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004000 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004001 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004002 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004003}
4004
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004005CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004006 // CXXCatchStmt are treated like labels, so they are the first statement in a
4007 // block.
4008
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004009 // Save local scope position because in case of exception variable ScopePos
4010 // won't be restored when traversing AST.
4011 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4012
4013 // Create local scope for possible exception variable.
4014 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004015 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004016 LocalScope::const_iterator BeginScopePos = ScopePos;
4017 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004018 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004019 }
4020
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004021 if (CS->getHandlerBlock())
4022 addStmt(CS->getHandlerBlock());
4023
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004024 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004025 if (!CatchBlock)
4026 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004027
4028 // CXXCatchStmt is more than just a label. They have semantic meaning
4029 // as well, as they implicitly "initialize" the catch variable. Add
4030 // it to the CFG as a CFGElement so that the control-flow of these
4031 // semantics gets captured.
4032 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004033
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004034 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4035 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004036 CatchBlock->setLabel(CS);
4037
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004038 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004039 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004040 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004041
4042 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004043 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004044
4045 return CatchBlock;
4046}
4047
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004048CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004049 // C++0x for-range statements are specified as [stmt.ranged]:
4050 //
4051 // {
4052 // auto && __range = range-init;
4053 // for ( auto __begin = begin-expr,
4054 // __end = end-expr;
4055 // __begin != __end;
4056 // ++__begin ) {
4057 // for-range-declaration = *__begin;
4058 // statement
4059 // }
4060 // }
4061
4062 // Save local scope position before the addition of the implicit variables.
4063 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4064
4065 // Create local scopes and destructors for range, begin and end variables.
4066 if (Stmt *Range = S->getRangeStmt())
4067 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004068 if (Stmt *Begin = S->getBeginStmt())
4069 addLocalScopeForStmt(Begin);
4070 if (Stmt *End = S->getEndStmt())
4071 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004072 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004073
4074 LocalScope::const_iterator ContinueScopePos = ScopePos;
4075
4076 // "for" is a control-flow statement. Thus we stop processing the current
4077 // block.
Craig Topper25542942014-05-20 04:30:07 +00004078 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004079 if (Block) {
4080 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004081 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004082 LoopSuccessor = Block;
4083 } else
4084 LoopSuccessor = Succ;
4085
4086 // Save the current value for the break targets.
4087 // All breaks should go to the code following the loop.
4088 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4089 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4090
4091 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004092 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004093 ConditionBlock->setTerminator(S);
4094
4095 // Now add the actual condition to the condition block.
4096 if (Expr *C = S->getCond()) {
4097 Block = ConditionBlock;
4098 CFGBlock *BeginConditionBlock = addStmt(C);
4099 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004100 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004101 assert(BeginConditionBlock == ConditionBlock &&
4102 "condition block in for-range was unexpectedly complex");
4103 (void)BeginConditionBlock;
4104 }
4105
4106 // The condition block is the implicit successor for the loop body as well as
4107 // any code above the loop.
4108 Succ = ConditionBlock;
4109
4110 // See if this is a known constant.
4111 TryResult KnownVal(true);
4112
4113 if (S->getCond())
4114 KnownVal = tryEvaluateBool(S->getCond());
4115
4116 // Now create the loop body.
4117 {
4118 assert(S->getBody());
4119
4120 // Save the current values for Block, Succ, and continue targets.
4121 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4122 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4123
4124 // Generate increment code in its own basic block. This is the target of
4125 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004126 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004127 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004128 if (badCFG)
4129 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004130 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4131
4132 // The starting block for the loop increment is the block that should
4133 // represent the 'loop target' for looping back to the start of the loop.
4134 ContinueJumpTarget.block->setLoopTarget(S);
4135
4136 // Finish up the increment block and prepare to start the loop body.
4137 assert(Block);
4138 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004139 return nullptr;
4140 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004141
4142 // Add implicit scope and dtors for loop variable.
4143 addLocalScopeAndDtors(S->getLoopVarStmt());
4144
4145 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004146 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004147 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004148 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004149 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004150 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004151 return nullptr;
4152
Richard Smith02e85f32011-04-14 22:09:26 +00004153 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004154 addSuccessor(ConditionBlock,
4155 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004156 }
4157
4158 // Link up the condition block with the code that follows the loop (the
4159 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004160 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004161
4162 // Add the initialization statements.
4163 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004164 addStmt(S->getBeginStmt());
4165 addStmt(S->getEndStmt());
Richard Smith0c502d22011-04-18 15:49:25 +00004166 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004167}
4168
John McCall5d413782010-12-06 08:20:24 +00004169CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004170 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004171 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004172 // If adding implicit destructors visit the full expression for adding
4173 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004174 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004175 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004176
4177 // Full expression has to be added as CFGStmt so it will be sequenced
4178 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004179 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004180 }
4181 return Visit(E->getSubExpr(), asc);
4182}
4183
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004184CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4185 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004186 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004187 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004188 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004189
Artem Dergachev783a4572018-02-23 22:20:39 +00004190 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004191 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004192 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004193
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004194 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004195 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004196 }
4197 return Visit(E->getSubExpr(), asc);
4198}
4199
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004200CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4201 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004202 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004203 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004204
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004205 return VisitChildren(C);
4206}
4207
Jordan Rosec9176072014-01-13 17:59:19 +00004208CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4209 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004210 autoCreateBlock();
4211 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004212
Artem Dergachev783a4572018-02-23 22:20:39 +00004213 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004214 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004215 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004216
Jordan Rosec9176072014-01-13 17:59:19 +00004217 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004218 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004219
Jordan Rosec9176072014-01-13 17:59:19 +00004220 if (BuildOpts.AddCXXNewAllocator)
4221 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004222
Jordan Rosec9176072014-01-13 17:59:19 +00004223 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004224 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004225
Jordan Rosec9176072014-01-13 17:59:19 +00004226 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4227 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004228 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004229
Jordan Rosec9176072014-01-13 17:59:19 +00004230 return Block;
4231}
Jordan Rosed2f40792013-09-03 17:00:57 +00004232
4233CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4234 AddStmtChoice asc) {
4235 autoCreateBlock();
4236 appendStmt(Block, DE);
4237 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004238 if (!DTy.isNull()) {
4239 DTy = DTy.getNonReferenceType();
4240 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4241 if (RD) {
4242 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4243 appendDeleteDtor(Block, RD, DE);
4244 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004245 }
4246
4247 return VisitChildren(DE);
4248}
4249
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004250CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4251 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004252 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004253 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004254 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004255 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004256 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004257 }
4258 return Visit(E->getSubExpr(), asc);
4259}
4260
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004261CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4262 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004263 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004264 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004265 return VisitChildren(C);
4266}
4267
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004268CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4269 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004270 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004271 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004272 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004273 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004274 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004275}
4276
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004277CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004278 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004279 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004280
Ted Kremenekeda180e22007-08-28 19:26:49 +00004281 if (!IBlock) {
4282 IBlock = createBlock(false);
4283 cfg->setIndirectGotoBlock(IBlock);
4284 }
Mike Stump31feda52009-07-17 01:31:16 +00004285
Ted Kremenekeda180e22007-08-28 19:26:49 +00004286 // IndirectGoto is a control-flow statement. Thus we stop processing the
4287 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004288 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004289 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004290
Ted Kremenekeda180e22007-08-28 19:26:49 +00004291 Block = createBlock(false);
4292 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004293 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004294 return addStmt(I->getTarget());
4295}
4296
Manuel Klimekb5616c92014-08-07 10:42:17 +00004297CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4298 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004299 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4300
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004301tryAgain:
4302 if (!E) {
4303 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004304 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004305 }
4306 switch (E->getStmtClass()) {
4307 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004308 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004309
4310 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004311 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4312 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004313
4314 case Stmt::CXXBindTemporaryExprClass:
4315 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004316 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004317
John McCallc07a0c72011-02-17 10:25:35 +00004318 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004319 case Stmt::ConditionalOperatorClass:
4320 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004321 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004322
4323 case Stmt::ImplicitCastExprClass:
4324 // For implicit cast we want BindToTemporary to be passed further.
4325 E = cast<CastExpr>(E)->getSubExpr();
4326 goto tryAgain;
4327
Manuel Klimekb0042c42014-07-30 08:34:42 +00004328 case Stmt::CXXFunctionalCastExprClass:
4329 // For functional cast we want BindToTemporary to be passed further.
4330 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4331 goto tryAgain;
4332
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004333 case Stmt::ParenExprClass:
4334 E = cast<ParenExpr>(E)->getSubExpr();
4335 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004336
Manuel Klimekb0042c42014-07-30 08:34:42 +00004337 case Stmt::MaterializeTemporaryExprClass: {
4338 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4339 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4340 SmallVector<const Expr *, 2> CommaLHSs;
4341 SmallVector<SubobjectAdjustment, 2> Adjustments;
4342 // Find the expression whose lifetime needs to be extended.
4343 E = const_cast<Expr *>(
4344 cast<MaterializeTemporaryExpr>(E)
4345 ->GetTemporaryExpr()
4346 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4347 // Visit the skipped comma operator left-hand sides for other temporaries.
4348 for (const Expr *CommaLHS : CommaLHSs) {
4349 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004350 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004351 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004352 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004353 }
Richard Smith4137af22014-07-27 05:12:49 +00004354
4355 case Stmt::BlockExprClass:
4356 // Don't recurse into blocks; their subexpressions don't get evaluated
4357 // here.
4358 return Block;
4359
4360 case Stmt::LambdaExprClass: {
4361 // For lambda expressions, only recurse into the capture initializers,
4362 // and not the body.
4363 auto *LE = cast<LambdaExpr>(E);
4364 CFGBlock *B = Block;
4365 for (Expr *Init : LE->capture_inits()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004366 if (CFGBlock *R = VisitForTemporaryDtors(
4367 Init, /*BindToTemporary=*/false, Context))
Richard Smith4137af22014-07-27 05:12:49 +00004368 B = R;
4369 }
4370 return B;
4371 }
4372
4373 case Stmt::CXXDefaultArgExprClass:
4374 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4375 goto tryAgain;
4376
4377 case Stmt::CXXDefaultInitExprClass:
4378 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4379 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004380 }
4381}
4382
Manuel Klimekb5616c92014-08-07 10:42:17 +00004383CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4384 TempDtorContext &Context) {
4385 if (isa<LambdaExpr>(E)) {
4386 // Do not visit the children of lambdas; they have their own CFGs.
4387 return Block;
4388 }
4389
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004390 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004391 // order that they will appear in the CFG. Because the CFG is built
4392 // bottom-up, this means we visit them in their natural order, which
4393 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004394 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004395 for (Stmt *Child : E->children())
4396 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004397 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004398 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004399
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004400 return B;
4401}
4402
Manuel Klimekb5616c92014-08-07 10:42:17 +00004403CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4404 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004405 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004406 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004407 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4408 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4409 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004410
Manuel Klimekedf925b92014-08-07 18:44:19 +00004411 // We do not know at CFG-construction time whether the right-hand-side was
4412 // executed, thus we add a branch node that depends on the temporary
4413 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004414 TempDtorContext RHSContext(
4415 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004416 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004417 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004418
Manuel Klimekb5616c92014-08-07 10:42:17 +00004419 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004420 }
4421
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004422 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004423 // For assignment operator (=) LHS expression is visited
4424 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004425 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4426 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004427 return LHSBlock ? LHSBlock : RHSBlock;
4428 }
4429
4430 // For any other binary operator RHS expression is visited before
4431 // LHS expression (order of children). For destructors visit them in reverse
4432 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004433 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4434 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004435 return RHSBlock ? RHSBlock : LHSBlock;
4436}
4437
4438CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004439 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004440 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004441 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004442 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004443 // If lifetime of temporary is not prolonged (by assigning to constant
4444 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004445
Chandler Carruthad747252011-09-13 06:09:01 +00004446 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004447
Richard Trieu95a192a2015-05-28 00:14:02 +00004448 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004449 // If the destructor is marked as a no-return destructor, we need to
4450 // create a new block for the destructor which does not have as a
4451 // successor anything built thus far. Control won't flow out of this
4452 // block.
4453 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004454 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004455 } else if (Context.needsTempDtorBranch()) {
4456 // If we need to introduce a branch, we add a new block that we will hook
4457 // up to a decision block later.
4458 if (B) Succ = B;
4459 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004460 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004461 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004462 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004463 if (Context.needsTempDtorBranch()) {
4464 Context.setDecisionPoint(Succ, E);
4465 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004466 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004467
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004468 B = Block;
4469 }
4470 return B;
4471}
4472
Manuel Klimekb5616c92014-08-07 10:42:17 +00004473void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4474 CFGBlock *FalseSucc) {
4475 if (!Context.TerminatorExpr) {
4476 // If no temporary was found, we do not need to insert a decision point.
4477 return;
4478 }
4479 assert(Context.TerminatorExpr);
4480 CFGBlock *Decision = createBlock(false);
4481 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004482 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004483 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004484 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004485 Block = Decision;
4486}
4487
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004488CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004489 AbstractConditionalOperator *E, bool BindToTemporary,
4490 TempDtorContext &Context) {
4491 VisitForTemporaryDtors(E->getCond(), false, Context);
4492 CFGBlock *ConditionBlock = Block;
4493 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004494 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004495 TryResult NegatedVal = ConditionVal;
4496 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004497
Manuel Klimekdeb02622014-08-08 07:37:13 +00004498 TempDtorContext TrueContext(
4499 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004500 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004501 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004502
Manuel Klimekb5616c92014-08-07 10:42:17 +00004503 Block = ConditionBlock;
4504 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004505 TempDtorContext FalseContext(
4506 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004507 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004508
Manuel Klimekb5616c92014-08-07 10:42:17 +00004509 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004510 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004511 } else if (TrueContext.TerminatorExpr) {
4512 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004513 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004514 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004515 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004516 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004517 return Block;
4518}
4519
Mike Stump31feda52009-07-17 01:31:16 +00004520/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4521/// no successors or predecessors. If this is the first block created in the
4522/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004523CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004524 bool first_block = begin() == end();
4525
4526 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004527 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004528 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004529 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004530
4531 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004532 if (first_block)
4533 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004534
4535 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004536 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004537}
4538
David Blaikiee90195c2014-08-29 18:53:26 +00004539/// buildCFG - Constructs a CFG from an AST.
4540std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4541 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004542 CFGBuilder Builder(C, BO);
4543 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004544}
4545
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004546const CXXDestructorDecl *
4547CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004548 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004549 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004550 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004551 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004552 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004553 case CFGElement::Statement:
4554 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004555 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004556 case CFGElement::ScopeBegin:
4557 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004558 llvm_unreachable("getDestructorDecl should only be used with "
4559 "ImplicitDtors");
4560 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004561 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004562 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004563
4564 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4565 //
4566 // Lifetime-extending constructs are handled here. This works for a single
4567 // temporary in an initializer expression.
4568 if (ty->isReferenceType()) {
4569 if (const Expr *Init = var->getInit()) {
4570 ty = getReferenceInitTemporaryType(astContext, Init);
4571 }
4572 }
4573
Ted Kremeneke7d78882012-03-19 23:48:41 +00004574 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004575 ty = arrayType->getElementType();
4576 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004577 const RecordType *recordType = ty->getAs<RecordType>();
4578 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004579 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004580 return classDecl->getDestructor();
4581 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004582 case CFGElement::DeleteDtor: {
4583 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4584 QualType DTy = DE->getDestroyedType();
4585 DTy = DTy.getNonReferenceType();
4586 const CXXRecordDecl *classDecl =
4587 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4588 return classDecl->getDestructor();
4589 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004590 case CFGElement::TemporaryDtor: {
4591 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004592 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004593 const CXXTemporary *temp = bindExpr->getTemporary();
4594 return temp->getDestructor();
4595 }
4596 case CFGElement::BaseDtor:
4597 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004598 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004599 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004600 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004601 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004602}
4603
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004604bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004605 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4606 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004607 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004608}
4609
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004610//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004611// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004612//===----------------------------------------------------------------------===//
4613
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004614CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004615 : ReachableBlock(IsReachable ? B : nullptr),
4616 UnreachableBlock(!IsReachable ? B : nullptr,
4617 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004618
4619CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004620 : ReachableBlock(B),
4621 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4622 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004623
4624void CFGBlock::addSuccessor(AdjacentBlock Succ,
4625 BumpVectorContext &C) {
4626 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004627 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004628
4629 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004630 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004631
4632 Succs.push_back(Succ, C);
4633}
4634
Ted Kremenekb0371852010-09-09 00:06:04 +00004635bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004636 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004637 if (F.IgnoreNullPredecessors && !From)
4638 return true;
4639
4640 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004641 // If the 'To' has no label or is labeled but the label isn't a
4642 // CaseStmt then filter this edge.
4643 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004644 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004645 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004646 const Stmt *L = To->getLabel();
4647 if (!L || !isa<CaseStmt>(L))
4648 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004649 }
4650 }
4651 }
4652
4653 return false;
4654}
4655
4656//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004657// CFG pretty printing
4658//===----------------------------------------------------------------------===//
4659
Ted Kremenek7e776b12007-08-22 18:22:34 +00004660namespace {
4661
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004662class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004663 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4664 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4665
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004666 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004667 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004668 signed currentBlock = 0;
4669 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004670 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004671
Eugene Zelenko38c70522017-12-07 21:55:09 +00004672public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004673 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004674 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004675 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4676 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004677 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004678 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004679 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4680 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004681 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004682 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004683
Ted Kremenek96a7a592011-03-01 03:15:10 +00004684 switch (stmt->getStmtClass()) {
4685 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004686 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4687 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004688 case Stmt::IfStmtClass: {
4689 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4690 if (var)
4691 DeclMap[var] = P;
4692 break;
4693 }
4694 case Stmt::ForStmtClass: {
4695 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4696 if (var)
4697 DeclMap[var] = P;
4698 break;
4699 }
4700 case Stmt::WhileStmtClass: {
4701 const VarDecl *var =
4702 cast<WhileStmt>(stmt)->getConditionVariable();
4703 if (var)
4704 DeclMap[var] = P;
4705 break;
4706 }
4707 case Stmt::SwitchStmtClass: {
4708 const VarDecl *var =
4709 cast<SwitchStmt>(stmt)->getConditionVariable();
4710 if (var)
4711 DeclMap[var] = P;
4712 break;
4713 }
4714 case Stmt::CXXCatchStmtClass: {
4715 const VarDecl *var =
4716 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4717 if (var)
4718 DeclMap[var] = P;
4719 break;
4720 }
4721 default:
4722 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004723 }
4724 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004725 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004726 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004727 }
Mike Stump31feda52009-07-17 01:31:16 +00004728
Eugene Zelenko38c70522017-12-07 21:55:09 +00004729 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004730
Chris Lattnerc61089a2009-06-30 01:26:17 +00004731 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004732 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004733 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004734
Craig Topperb45acb82014-03-14 06:02:07 +00004735 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004736 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004737
4738 if (I == StmtMap.end())
4739 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004740
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004741 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004742 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004743 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004744 }
Mike Stump31feda52009-07-17 01:31:16 +00004745
Ted Kremenek60983dc2010-01-19 20:52:05 +00004746 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004747 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004748 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004749
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004750 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004751 DeclMapTy::iterator I = DeclMap.find(D);
4752
4753 if (I == DeclMap.end())
4754 return false;
4755
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004756 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004757 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004758 return false;
4759 }
4760
4761 OS << "[B" << I->second.first << "." << I->second.second << "]";
4762 return true;
4763 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004764};
4765
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004766class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004767 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004768 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004769 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004770 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004771
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004772public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004773 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004774 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004775 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004776 this->Policy.IncludeNewlines = false;
4777 }
Mike Stump31feda52009-07-17 01:31:16 +00004778
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004779 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004780 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004781 if (Stmt *C = I->getCond())
4782 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004783 }
Mike Stump31feda52009-07-17 01:31:16 +00004784
Ted Kremenek9aae5132007-08-23 21:42:29 +00004785 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004786 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004787 Terminator->printPretty(OS, Helper, Policy);
4788 }
4789
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004790 void VisitDeclStmt(DeclStmt *DS) {
4791 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4792 OS << "static init " << VD->getName();
4793 }
4794
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004795 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004796 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004797 if (F->getInit())
4798 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004799 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004800 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004801 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004802 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004803 if (F->getInc())
4804 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004805 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004806 }
Mike Stump31feda52009-07-17 01:31:16 +00004807
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004808 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004809 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004810 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004811 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004812 }
Mike Stump31feda52009-07-17 01:31:16 +00004813
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004814 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004815 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004816 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004817 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004818 }
Mike Stump31feda52009-07-17 01:31:16 +00004819
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004820 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004821 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004822 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004823 }
Mike Stump31feda52009-07-17 01:31:16 +00004824
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004825 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004826 OS << "try ...";
4827 }
4828
Nico Weber699670e2017-08-23 15:33:16 +00004829 void VisitSEHTryStmt(SEHTryStmt *CS) {
4830 OS << "__try ...";
4831 }
4832
John McCallc07a0c72011-02-17 10:25:35 +00004833 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004834 if (Stmt *Cond = C->getCond())
4835 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004836 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004837 }
Mike Stump31feda52009-07-17 01:31:16 +00004838
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004839 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004840 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004841 if (Stmt *Cond = C->getCond())
4842 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004843 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004844 }
Mike Stump31feda52009-07-17 01:31:16 +00004845
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004846 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004847 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004848 if (Stmt *T = I->getTarget())
4849 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004850 }
Mike Stump31feda52009-07-17 01:31:16 +00004851
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004852 void VisitBinaryOperator(BinaryOperator* B) {
4853 if (!B->isLogicalOp()) {
4854 VisitExpr(B);
4855 return;
4856 }
Mike Stump31feda52009-07-17 01:31:16 +00004857
Richard Trieuddd01ce2014-06-09 22:53:25 +00004858 if (B->getLHS())
4859 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004860
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004861 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004862 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004863 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004864 return;
John McCalle3027922010-08-25 11:45:40 +00004865 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004866 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004867 return;
4868 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004869 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004870 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004871 }
Mike Stump31feda52009-07-17 01:31:16 +00004872
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004873 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004874 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004875 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004876
4877public:
4878 void print(CFGTerminator T) {
4879 if (T.isTemporaryDtorsBranch())
4880 OS << "(Temp Dtor) ";
4881 Visit(T.getStmt());
4882 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004883};
Eugene Zelenko38c70522017-12-07 21:55:09 +00004884
4885} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00004886
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004887static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
4888 const CXXCtorInitializer *I) {
4889 if (I->isBaseInitializer())
4890 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
4891 else if (I->isDelegatingInitializer())
4892 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
4893 else
4894 OS << I->getAnyMember()->getName();
4895 OS << "(";
4896 if (Expr *IE = I->getInit())
4897 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
4898 OS << ")";
4899
4900 if (I->isBaseInitializer())
4901 OS << " (Base initializer)";
4902 else if (I->isDelegatingInitializer())
4903 OS << " (Delegating initializer)";
4904 else
4905 OS << " (Member initializer)";
4906}
4907
Artem Dergachev1527dec2018-03-12 23:12:40 +00004908static void print_construction_context(raw_ostream &OS,
4909 StmtPrinterHelper &Helper,
4910 const ConstructionContext *CC) {
4911 const Stmt *S1 = nullptr, *S2 = nullptr;
4912 switch (CC->getKind()) {
4913 case ConstructionContext::ConstructorInitializerKind: {
4914 OS << ", ";
4915 const auto *ICC = cast<ConstructorInitializerConstructionContext>(CC);
4916 print_initializer(OS, Helper, ICC->getCXXCtorInitializer());
4917 break;
4918 }
4919 case ConstructionContext::SimpleVariableKind: {
4920 const auto *DSCC = cast<SimpleVariableConstructionContext>(CC);
4921 S1 = DSCC->getDeclStmt();
4922 break;
4923 }
4924 case ConstructionContext::NewAllocatedObjectKind: {
4925 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
4926 S1 = NECC->getCXXNewExpr();
4927 break;
4928 }
4929 case ConstructionContext::ReturnedValueKind: {
4930 const auto *RSCC = cast<ReturnedValueConstructionContext>(CC);
4931 S1 = RSCC->getReturnStmt();
4932 break;
4933 }
4934 case ConstructionContext::TemporaryObjectKind: {
4935 const auto *TOCC = cast<TemporaryObjectConstructionContext>(CC);
4936 S1 = TOCC->getCXXBindTemporaryExpr();
4937 S2 = TOCC->getMaterializedTemporaryExpr();
4938 break;
4939 }
4940 }
4941 if (S1) {
4942 OS << ", ";
4943 Helper.handledStmt(const_cast<Stmt *>(S1), OS);
4944 }
4945 if (S2) {
4946 OS << ", ";
4947 Helper.handledStmt(const_cast<Stmt *>(S2), OS);
4948 }
4949}
4950
Aaron Ballmanff924b02013-11-18 20:11:50 +00004951static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00004952 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004953 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4954 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00004955 assert(S != nullptr && "Expecting non-null Stmt");
4956
Aaron Ballmanff924b02013-11-18 20:11:50 +00004957 // special printing for statement-expressions.
4958 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
4959 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00004960
Benjamin Kramer5733e352015-07-18 17:09:36 +00004961 auto Children = Sub->children();
4962 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00004963 OS << "({ ... ; ";
4964 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
4965 OS << " })\n";
4966 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004967 }
4968 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00004969 // special printing for comma expressions.
4970 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
4971 if (B->getOpcode() == BO_Comma) {
4972 OS << "... , ";
4973 Helper.handledStmt(B->getRHS(),OS);
4974 OS << '\n';
4975 return;
4976 }
4977 }
4978 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00004979
Artem Dergachev1527dec2018-03-12 23:12:40 +00004980 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
4981 if (isa<CXXOperatorCallExpr>(S))
4982 OS << " (OperatorCall)";
4983 OS << " (CXXRecordTypedCall";
4984 print_construction_context(OS, Helper, VTC->getConstructionContext());
4985 OS << ")";
4986 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004987 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004988 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004989 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004990 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00004991 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004992 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00004993 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004994 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00004995 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004996 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00004997 OS << " (" << CE->getStmtClassName() << ", "
4998 << CE->getCastKindName()
4999 << ", " << CE->getType().getAsString()
5000 << ")";
5001 }
Mike Stump31feda52009-07-17 01:31:16 +00005002
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005003 // Expressions need a newline.
5004 if (isa<Expr>(S))
5005 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005006 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005007 print_initializer(OS, Helper, IE->getInitializer());
5008 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005009 } else if (Optional<CFGAutomaticObjDtor> DE =
5010 E.getAs<CFGAutomaticObjDtor>()) {
5011 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005012 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005013
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00005014 const Type* T = VD->getType().getTypePtr();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005015 if (const ReferenceType* RT = T->getAs<ReferenceType>())
5016 T = RT->getPointeeType().getTypePtr();
Richard Smithf676e452012-07-24 21:02:14 +00005017 T = T->getBaseElementTypeUnsafe();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005018
5019 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
5020 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00005021 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
5022 const VarDecl *VD = DE->getVarDecl();
5023 Helper.handleDecl(VD, OS);
5024
5025 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00005026 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
5027 const Stmt *LoopStmt = LE->getLoopStmt();
5028 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005029 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
5030 OS << "CFGScopeBegin(";
5031 if (const VarDecl *VD = SB->getVarDecl())
5032 OS << VD->getQualifiedNameAsString();
5033 OS << ")\n";
5034 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
5035 OS << "CFGScopeEnd(";
5036 if (const VarDecl *VD = SE->getVarDecl())
5037 OS << VD->getQualifiedNameAsString();
5038 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00005039 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
5040 OS << "CFGNewAllocator(";
5041 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
5042 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5043 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00005044 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
5045 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
5046 if (!RD)
5047 return;
5048 CXXDeleteExpr *DelExpr =
5049 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005050 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005051 OS << "->~" << RD->getName().str() << "()";
5052 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005053 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5054 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005055 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005056 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005057 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5058 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005059 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005060 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005061 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005062 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005063 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5064 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005065 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005066 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005067 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005068 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005069}
Mike Stump31feda52009-07-17 01:31:16 +00005070
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005071static void print_block(raw_ostream &OS, const CFG* cfg,
5072 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005073 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005074 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005075 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005076
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005077 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005078 if (ShowColors)
5079 OS.changeColor(raw_ostream::YELLOW, true);
5080
5081 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005082
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005083 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005084 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005085 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005086 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005087 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005088 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005089 else if (B.hasNoReturnElement())
5090 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005091 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005092 OS << "]\n";
5093
5094 if (ShowColors)
5095 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005096
Ted Kremenek71eca012007-08-29 23:20:49 +00005097 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005098 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005099 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005100 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005101
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005102 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005103 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005104 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005105 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005106 if (C->getLHS())
5107 C->getLHS()->printPretty(OS, &Helper,
5108 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005109 if (C->getRHS()) {
5110 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005111 C->getRHS()->printPretty(OS, &Helper,
5112 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005113 }
Mike Stump92244b02010-01-19 22:00:14 +00005114 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005115 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005116 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005117 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005118 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005119 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005120 0);
5121 else
5122 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005123 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005124 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5125 OS << "__except (";
5126 ES->getFilterExpr()->printPretty(OS, &Helper,
5127 PrintingPolicy(Helper.getLangOpts()), 0);
5128 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005129 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005130 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005131
Ted Kremenek71eca012007-08-29 23:20:49 +00005132 OS << ":\n";
5133 }
Mike Stump31feda52009-07-17 01:31:16 +00005134
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005135 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005136 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005137
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005138 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5139 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005140 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005141 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005142 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005143
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005144 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005145
Aaron Ballmanff924b02013-11-18 20:11:50 +00005146 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005147
Ted Kremenek72be32a2011-12-22 23:33:52 +00005148 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005149 }
Mike Stump31feda52009-07-17 01:31:16 +00005150
Ted Kremenek71eca012007-08-29 23:20:49 +00005151 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005152 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005153 if (ShowColors)
5154 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005155
Ted Kremenek72be32a2011-12-22 23:33:52 +00005156 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005157
Aaron Ballmanff924b02013-11-18 20:11:50 +00005158 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005159
Aaron Ballmanff924b02013-11-18 20:11:50 +00005160 PrintingPolicy PP(Helper.getLangOpts());
5161 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005162 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005163 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00005164
5165 if (ShowColors)
5166 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005167 }
Mike Stump31feda52009-07-17 01:31:16 +00005168
Ted Kremenek71eca012007-08-29 23:20:49 +00005169 if (print_edges) {
5170 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005171 if (!B.pred_empty()) {
5172 const raw_ostream::Colors Color = raw_ostream::BLUE;
5173 if (ShowColors)
5174 OS.changeColor(Color);
5175 OS << " Preds " ;
5176 if (ShowColors)
5177 OS.resetColor();
5178 OS << '(' << B.pred_size() << "):";
5179 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005180
Ted Kremenek72be32a2011-12-22 23:33:52 +00005181 if (ShowColors)
5182 OS.changeColor(Color);
5183
5184 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5185 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005186 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005187 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005188
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005189 CFGBlock *B = *I;
5190 bool Reachable = true;
5191 if (!B) {
5192 Reachable = false;
5193 B = I->getPossiblyUnreachableBlock();
5194 }
5195
5196 OS << " B" << B->getBlockID();
5197 if (!Reachable)
5198 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005199 }
5200
5201 if (ShowColors)
5202 OS.resetColor();
5203
5204 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005205 }
Mike Stump31feda52009-07-17 01:31:16 +00005206
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005207 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005208 if (!B.succ_empty()) {
5209 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5210 if (ShowColors)
5211 OS.changeColor(Color);
5212 OS << " Succs ";
5213 if (ShowColors)
5214 OS.resetColor();
5215 OS << '(' << B.succ_size() << "):";
5216 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005217
Ted Kremenek72be32a2011-12-22 23:33:52 +00005218 if (ShowColors)
5219 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005220
Ted Kremenek72be32a2011-12-22 23:33:52 +00005221 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5222 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005223 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005224 OS << "\n ";
5225
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005226 CFGBlock *B = *I;
5227
5228 bool Reachable = true;
5229 if (!B) {
5230 Reachable = false;
5231 B = I->getPossiblyUnreachableBlock();
5232 }
5233
5234 if (B) {
5235 OS << " B" << B->getBlockID();
5236 if (!Reachable)
5237 OS << "(Unreachable)";
5238 }
5239 else {
5240 OS << " NULL";
5241 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005242 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005243
Ted Kremenek72be32a2011-12-22 23:33:52 +00005244 if (ShowColors)
5245 OS.resetColor();
5246 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005247 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005248 }
Mike Stump31feda52009-07-17 01:31:16 +00005249}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005250
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005251/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005252void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5253 print(llvm::errs(), LO, ShowColors);
5254}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005255
5256/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005257void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005258 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005259
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005260 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005261 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005262
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005263 // Iterate through the CFGBlocks and print them one by one.
5264 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5265 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005266 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005267 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005268
Aaron Ballmanff924b02013-11-18 20:11:50 +00005269 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005270 }
Mike Stump31feda52009-07-17 01:31:16 +00005271
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005272 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005273 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005274 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005275 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005276}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005277
5278/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005279void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5280 bool ShowColors) const {
5281 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005282}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005283
Yaron Kerencdae9412016-01-29 19:38:18 +00005284LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005285 dump(getParent(), LangOptions(), false);
5286}
5287
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005288/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5289/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005290void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005291 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005292 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005293 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005294 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005295}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005296
Ted Kremenek15647632008-01-30 23:02:42 +00005297/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005298void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005299 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005300 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005301 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005302}
5303
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005304Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00005305 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005306 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005307 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005308
Craig Topper25542942014-05-20 04:30:07 +00005309 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005310
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005311 switch (Terminator->getStmtClass()) {
5312 default:
5313 break;
Mike Stump31feda52009-07-17 01:31:16 +00005314
Jordan Rosecf10ea82013-06-06 21:53:45 +00005315 case Stmt::CXXForRangeStmtClass:
5316 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5317 break;
5318
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005319 case Stmt::ForStmtClass:
5320 E = cast<ForStmt>(Terminator)->getCond();
5321 break;
Mike Stump31feda52009-07-17 01:31:16 +00005322
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005323 case Stmt::WhileStmtClass:
5324 E = cast<WhileStmt>(Terminator)->getCond();
5325 break;
Mike Stump31feda52009-07-17 01:31:16 +00005326
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005327 case Stmt::DoStmtClass:
5328 E = cast<DoStmt>(Terminator)->getCond();
5329 break;
Mike Stump31feda52009-07-17 01:31:16 +00005330
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005331 case Stmt::IfStmtClass:
5332 E = cast<IfStmt>(Terminator)->getCond();
5333 break;
Mike Stump31feda52009-07-17 01:31:16 +00005334
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005335 case Stmt::ChooseExprClass:
5336 E = cast<ChooseExpr>(Terminator)->getCond();
5337 break;
Mike Stump31feda52009-07-17 01:31:16 +00005338
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005339 case Stmt::IndirectGotoStmtClass:
5340 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5341 break;
Mike Stump31feda52009-07-17 01:31:16 +00005342
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005343 case Stmt::SwitchStmtClass:
5344 E = cast<SwitchStmt>(Terminator)->getCond();
5345 break;
Mike Stump31feda52009-07-17 01:31:16 +00005346
John McCallc07a0c72011-02-17 10:25:35 +00005347 case Stmt::BinaryConditionalOperatorClass:
5348 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5349 break;
5350
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005351 case Stmt::ConditionalOperatorClass:
5352 E = cast<ConditionalOperator>(Terminator)->getCond();
5353 break;
Mike Stump31feda52009-07-17 01:31:16 +00005354
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005355 case Stmt::BinaryOperatorClass: // '&&' and '||'
5356 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005357 break;
Mike Stump31feda52009-07-17 01:31:16 +00005358
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005359 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005360 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005361 }
Mike Stump31feda52009-07-17 01:31:16 +00005362
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005363 if (!StripParens)
5364 return E;
5365
Craig Topper25542942014-05-20 04:30:07 +00005366 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005367}
5368
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005369//===----------------------------------------------------------------------===//
5370// CFG Graphviz Visualization
5371//===----------------------------------------------------------------------===//
5372
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005373#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005374static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005375#endif
5376
Chris Lattnerc61089a2009-06-30 01:26:17 +00005377void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005378#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005379 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005380 GraphHelper = &H;
5381 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005382 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005383#endif
5384}
5385
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005386namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005387
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005388template<>
5389struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005390 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005391
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005392 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005393#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005394 std::string OutSStr;
5395 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005396 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005397 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005398
5399 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5400
5401 // Process string output to make it nicer...
5402 for (unsigned i = 0; i != OutStr.length(); ++i)
5403 if (OutStr[i] == '\n') { // Left justify
5404 OutStr[i] = '\\';
5405 OutStr.insert(OutStr.begin()+i+1, 'l');
5406 }
Mike Stump31feda52009-07-17 01:31:16 +00005407
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005408 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005409#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005410 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005411#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005412 }
5413};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005414
5415} // namespace llvm