blob: 34d40162275711ba19507dbacfab14517b0b2ae4 [file] [log] [blame]
Eugene Zelenko38c70522017-12-07 21:55:09 +00001//===- CFG.cpp - Classes for representing and building CFGs ---------------===//
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the CFG and CFGBuilder classes for representing and
11// building Control-Flow Graphs (CFGs) from ASTs.
12//
13//===----------------------------------------------------------------------===//
14
Ted Kremenek6796fbd2009-07-16 18:13:04 +000015#include "clang/Analysis/CFG.h"
Benjamin Kramer1ea8e092012-07-04 17:04:04 +000016#include "clang/AST/ASTContext.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000017#include "clang/AST/Attr.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000018#include "clang/AST/Decl.h"
19#include "clang/AST/DeclBase.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000020#include "clang/AST/DeclCXX.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000021#include "clang/AST/DeclGroup.h"
22#include "clang/AST/Expr.h"
23#include "clang/AST/ExprCXX.h"
24#include "clang/AST/OperationKinds.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000025#include "clang/AST/PrettyPrinter.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000026#include "clang/AST/Stmt.h"
27#include "clang/AST/StmtCXX.h"
28#include "clang/AST/StmtObjC.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000029#include "clang/AST/StmtVisitor.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000030#include "clang/AST/Type.h"
31#include "clang/Analysis/Support/BumpVector.h"
Artem Dergachev40684812018-02-27 20:03:35 +000032#include "clang/Analysis/ConstructionContext.h"
Jordan Rose5374c072013-08-19 16:27:28 +000033#include "clang/Basic/Builtins.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000034#include "clang/Basic/ExceptionSpecificationType.h"
35#include "clang/Basic/LLVM.h"
36#include "clang/Basic/LangOptions.h"
37#include "clang/Basic/SourceLocation.h"
38#include "clang/Basic/Specifiers.h"
39#include "llvm/ADT/APInt.h"
40#include "llvm/ADT/APSInt.h"
41#include "llvm/ADT/ArrayRef.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000042#include "llvm/ADT/DenseMap.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000043#include "llvm/ADT/Optional.h"
44#include "llvm/ADT/STLExtras.h"
45#include "llvm/ADT/SetVector.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000046#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000047#include "llvm/ADT/SmallVector.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000048#include "llvm/Support/Allocator.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000049#include "llvm/Support/Casting.h"
50#include "llvm/Support/Compiler.h"
51#include "llvm/Support/DOTGraphTraits.h"
52#include "llvm/Support/ErrorHandling.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000053#include "llvm/Support/Format.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000054#include "llvm/Support/GraphWriter.h"
55#include "llvm/Support/SaveAndRestore.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000056#include "llvm/Support/raw_ostream.h"
57#include <cassert>
58#include <memory>
59#include <string>
60#include <tuple>
61#include <utility>
62#include <vector>
Ted Kremeneke5ccf9a2008-01-11 00:40:29 +000063
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +000064using namespace clang;
65
Ted Kremenek5ef32db2011-08-12 23:37:29 +000066static SourceLocation GetEndLoc(Decl *D) {
67 if (VarDecl *VD = dyn_cast<VarDecl>(D))
68 if (Expr *Ex = VD->getInit())
Ted Kremenek8889bb32008-08-06 23:20:50 +000069 return Ex->getSourceRange().getEnd();
Mike Stump31feda52009-07-17 01:31:16 +000070 return D->getLocation();
Ted Kremenek8889bb32008-08-06 23:20:50 +000071}
Ted Kremenekdc03bd02010-08-02 23:46:59 +000072
George Burgess IVced56e62015-10-01 18:47:52 +000073/// Helper for tryNormalizeBinaryOperator. Attempts to extract an IntegerLiteral
74/// or EnumConstantDecl from the given Expr. If it fails, returns nullptr.
Eugene Zelenko38c70522017-12-07 21:55:09 +000075static const Expr *tryTransformToIntOrEnumConstant(const Expr *E) {
George Burgess IVced56e62015-10-01 18:47:52 +000076 E = E->IgnoreParens();
77 if (isa<IntegerLiteral>(E))
78 return E;
79 if (auto *DR = dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
80 return isa<EnumConstantDecl>(DR->getDecl()) ? DR : nullptr;
81 return nullptr;
82}
83
84/// Tries to interpret a binary operator into `Decl Op Expr` form, if Expr is
85/// an integer literal or an enum constant.
86///
87/// If this fails, at least one of the returned DeclRefExpr or Expr will be
88/// null.
89static std::tuple<const DeclRefExpr *, BinaryOperatorKind, const Expr *>
90tryNormalizeBinaryOperator(const BinaryOperator *B) {
91 BinaryOperatorKind Op = B->getOpcode();
92
93 const Expr *MaybeDecl = B->getLHS();
94 const Expr *Constant = tryTransformToIntOrEnumConstant(B->getRHS());
95 // Expr looked like `0 == Foo` instead of `Foo == 0`
96 if (Constant == nullptr) {
97 // Flip the operator
98 if (Op == BO_GT)
99 Op = BO_LT;
100 else if (Op == BO_GE)
101 Op = BO_LE;
102 else if (Op == BO_LT)
103 Op = BO_GT;
104 else if (Op == BO_LE)
105 Op = BO_GE;
106
107 MaybeDecl = B->getRHS();
108 Constant = tryTransformToIntOrEnumConstant(B->getLHS());
109 }
110
111 auto *D = dyn_cast<DeclRefExpr>(MaybeDecl->IgnoreParenImpCasts());
112 return std::make_tuple(D, Op, Constant);
113}
114
115/// For an expression `x == Foo && x == Bar`, this determines whether the
116/// `Foo` and `Bar` are either of the same enumeration type, or both integer
117/// literals.
118///
119/// It's an error to pass this arguments that are not either IntegerLiterals
120/// or DeclRefExprs (that have decls of type EnumConstantDecl)
121static bool areExprTypesCompatible(const Expr *E1, const Expr *E2) {
122 // User intent isn't clear if they're mixing int literals with enum
123 // constants.
124 if (isa<IntegerLiteral>(E1) != isa<IntegerLiteral>(E2))
125 return false;
126
127 // Integer literal comparisons, regardless of literal type, are acceptable.
128 if (isa<IntegerLiteral>(E1))
129 return true;
130
131 // IntegerLiterals are handled above and only EnumConstantDecls are expected
132 // beyond this point
133 assert(isa<DeclRefExpr>(E1) && isa<DeclRefExpr>(E2));
134 auto *Decl1 = cast<DeclRefExpr>(E1)->getDecl();
135 auto *Decl2 = cast<DeclRefExpr>(E2)->getDecl();
136
137 assert(isa<EnumConstantDecl>(Decl1) && isa<EnumConstantDecl>(Decl2));
138 const DeclContext *DC1 = Decl1->getDeclContext();
139 const DeclContext *DC2 = Decl2->getDeclContext();
140
141 assert(isa<EnumDecl>(DC1) && isa<EnumDecl>(DC2));
142 return DC1 == DC2;
143}
144
Eugene Zelenko38c70522017-12-07 21:55:09 +0000145namespace {
146
Ted Kremenek7c58d352011-03-10 01:14:11 +0000147class CFGBuilder;
148
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000149/// The CFG builder uses a recursive algorithm to build the CFG. When
150/// we process an expression, sometimes we know that we must add the
151/// subexpressions as block-level expressions. For example:
152///
153/// exp1 || exp2
154///
155/// When processing the '||' expression, we know that exp1 and exp2
156/// need to be added as block-level expressions, even though they
157/// might not normally need to be. AddStmtChoice records this
158/// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then
159/// the builder has an option not to add a subexpression as a
160/// block-level expression.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000161class AddStmtChoice {
162public:
Ted Kremenek8219b822010-12-16 07:46:53 +0000163 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 };
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000164
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000165 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000166
Ted Kremenek7c58d352011-03-10 01:14:11 +0000167 bool alwaysAdd(CFGBuilder &builder,
168 const Stmt *stmt) const;
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000169
170 /// Return a copy of this object, except with the 'always-add' bit
171 /// set as specified.
172 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const {
Ted Kremenek7c58d352011-03-10 01:14:11 +0000173 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000174 }
175
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000176private:
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000177 Kind kind;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000178};
Mike Stump31feda52009-07-17 01:31:16 +0000179
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000180/// LocalScope - Node in tree of local scopes created for C++ implicit
181/// destructor calls generation. It contains list of automatic variables
182/// declared in the scope and link to position in previous scope this scope
183/// began in.
184///
185/// The process of creating local scopes is as follows:
186/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
187/// - Before processing statements in scope (e.g. CompoundStmt) create
188/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
189/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000190/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000191/// at this VarDecl,
192/// - For every normal (without jump) end of scope add to CFGBlock destructors
193/// for objects in the current scope,
194/// - For every jump add to CFGBlock destructors for objects
195/// between CFGBuilder::ScopePos and local scope position saved for jump
196/// target. Thanks to C++ restrictions on goto jumps we can be sure that
197/// jump target position will be on the path to root from CFGBuilder::ScopePos
198/// (adding any variable that doesn't need constructor to be called to
199/// LocalScope can break this assumption),
200///
201class LocalScope {
202public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000203 friend class const_iterator;
204
205 using AutomaticVarsTy = BumpVector<VarDecl *>;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000206
207 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000208 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000209 class const_iterator {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000210 const LocalScope* Scope = nullptr;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000211
212 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
213 /// Invalid iterator (with null Scope) has VarIter equal to 0.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000214 unsigned VarIter = 0;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000215
216 public:
217 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
218 /// Incrementing invalid iterator is allowed and will result in invalid
219 /// iterator.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000220 const_iterator() = default;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000221
222 /// Create valid iterator. In case when S.Prev is an invalid iterator and
223 /// I is equal to 0, this will create invalid iterator.
224 const_iterator(const LocalScope& S, unsigned I)
225 : Scope(&S), VarIter(I) {
226 // Iterator to "end" of scope is not allowed. Handle it by going up
227 // in scopes tree possibly up to invalid iterator in the root.
228 if (VarIter == 0 && Scope)
229 *this = Scope->Prev;
230 }
231
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000232 VarDecl *const* operator->() const {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000233 assert(Scope && "Dereferencing invalid iterator is not allowed");
234 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000235 return &Scope->Vars[VarIter - 1];
236 }
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000237
238 const VarDecl *getFirstVarInScope() const {
239 assert(Scope && "Dereferencing invalid iterator is not allowed");
240 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
241 return Scope->Vars[0];
242 }
243
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000244 VarDecl *operator*() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000245 return *this->operator->();
246 }
247
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000248 const_iterator &operator++() {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000249 if (!Scope)
250 return *this;
251
Eugene Zelenko38c70522017-12-07 21:55:09 +0000252 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000253 --VarIter;
254 if (VarIter == 0)
255 *this = Scope->Prev;
256 return *this;
257 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000258 const_iterator operator++(int) {
259 const_iterator P = *this;
260 ++*this;
261 return P;
262 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000263
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000264 bool operator==(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000265 return Scope == rhs.Scope && VarIter == rhs.VarIter;
266 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000267 bool operator!=(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000268 return !(*this == rhs);
269 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000270
Aaron Ballman67347662015-02-15 22:00:28 +0000271 explicit operator bool() const {
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000272 return *this != const_iterator();
273 }
274
275 int distance(const_iterator L);
Matthias Gehre351c2182017-07-12 07:04:19 +0000276 const_iterator shared_parent(const_iterator L);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000277 bool pointsToFirstDeclaredVar() { return VarIter == 1; }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000278 };
279
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000280private:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000281 BumpVectorContext ctx;
282
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000283 /// Automatic variables in order of declaration.
284 AutomaticVarsTy Vars;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000285
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000286 /// Iterator to variable in previous scope that was declared just before
287 /// begin of this scope.
288 const_iterator Prev;
289
290public:
291 /// Constructs empty scope linked to previous scope in specified place.
David Blaikiec1334cc2015-08-13 22:12:21 +0000292 LocalScope(BumpVectorContext ctx, const_iterator P)
293 : ctx(std::move(ctx)), Vars(this->ctx, 4), Prev(P) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000294
295 /// Begin of scope in direction of CFG building (backwards).
296 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000297
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000298 void addVar(VarDecl *VD) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000299 Vars.push_back(VD, ctx);
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000300 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000301};
302
Eugene Zelenko38c70522017-12-07 21:55:09 +0000303} // namespace
304
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000305/// distance - Calculates distance from this to L. L must be reachable from this
306/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
307/// number of scopes between this and L.
308int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
309 int D = 0;
310 const_iterator F = *this;
311 while (F.Scope != L.Scope) {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000312 assert(F != const_iterator() &&
313 "L iterator is not reachable from F iterator.");
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000314 D += F.VarIter;
315 F = F.Scope->Prev;
316 }
317 D += F.VarIter - L.VarIter;
318 return D;
319}
320
Matthias Gehre351c2182017-07-12 07:04:19 +0000321/// Calculates the closest parent of this iterator
322/// that is in a scope reachable through the parents of L.
323/// I.e. when using 'goto' from this to L, the lifetime of all variables
324/// between this and shared_parent(L) end.
325LocalScope::const_iterator
326LocalScope::const_iterator::shared_parent(LocalScope::const_iterator L) {
327 llvm::SmallPtrSet<const LocalScope *, 4> ScopesOfL;
328 while (true) {
329 ScopesOfL.insert(L.Scope);
330 if (L == const_iterator())
331 break;
332 L = L.Scope->Prev;
333 }
334
335 const_iterator F = *this;
336 while (true) {
337 if (ScopesOfL.count(F.Scope))
338 return F;
339 assert(F != const_iterator() &&
340 "L iterator is not reachable from F iterator.");
341 F = F.Scope->Prev;
342 }
343}
344
Eugene Zelenko38c70522017-12-07 21:55:09 +0000345namespace {
346
Jonathan Roelofs99bdd982015-05-19 18:51:56 +0000347/// Structure for specifying position in CFG during its build process. It
348/// consists of CFGBlock that specifies position in CFG and
349/// LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000350struct BlockScopePosPair {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000351 CFGBlock *block = nullptr;
352 LocalScope::const_iterator scopePosition;
353
354 BlockScopePosPair() = default;
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000355 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos)
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000356 : block(b), scopePosition(scopePos) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000357};
358
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000359/// TryResult - a class representing a variant over the values
360/// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool,
361/// and is used by the CFGBuilder to decide if a branch condition
362/// can be decided up front during CFG construction.
363class TryResult {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000364 int X = -1;
365
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000366public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000367 TryResult() = default;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000368 TryResult(bool b) : X(b ? 1 : 0) {}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000369
370 bool isTrue() const { return X == 1; }
371 bool isFalse() const { return X == 0; }
372 bool isKnown() const { return X >= 0; }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000373
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000374 void negate() {
375 assert(isKnown());
376 X ^= 0x1;
377 }
378};
379
Eugene Zelenko38c70522017-12-07 21:55:09 +0000380} // namespace
381
382static TryResult bothKnownTrue(TryResult R1, TryResult R2) {
Manuel Klimekdeb02622014-08-08 07:37:13 +0000383 if (!R1.isKnown() || !R2.isKnown())
384 return TryResult();
385 return TryResult(R1.isTrue() && R2.isTrue());
386}
387
Eugene Zelenko38c70522017-12-07 21:55:09 +0000388namespace {
389
Ted Kremenek8ae67872013-02-05 22:00:19 +0000390class reverse_children {
391 llvm::SmallVector<Stmt *, 12> childrenBuf;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000392 ArrayRef<Stmt *> children;
393
Ted Kremenek8ae67872013-02-05 22:00:19 +0000394public:
395 reverse_children(Stmt *S);
396
Eugene Zelenko38c70522017-12-07 21:55:09 +0000397 using iterator = ArrayRef<Stmt *>::reverse_iterator;
398
Ted Kremenek8ae67872013-02-05 22:00:19 +0000399 iterator begin() const { return children.rbegin(); }
400 iterator end() const { return children.rend(); }
401};
402
Eugene Zelenko38c70522017-12-07 21:55:09 +0000403} // namespace
Ted Kremenek8ae67872013-02-05 22:00:19 +0000404
405reverse_children::reverse_children(Stmt *S) {
406 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
407 children = CE->getRawSubExprs();
408 return;
409 }
410 switch (S->getStmtClass()) {
Ted Kremenek7d86b9c2013-02-05 22:03:14 +0000411 // Note: Fill in this switch with more cases we want to optimize.
Ted Kremenek8ae67872013-02-05 22:00:19 +0000412 case Stmt::InitListExprClass: {
413 InitListExpr *IE = cast<InitListExpr>(S);
414 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()),
415 IE->getNumInits());
416 return;
417 }
418 default:
419 break;
420 }
421
422 // Default case for all other statements.
Benjamin Kramer642f1732015-07-02 21:03:14 +0000423 for (Stmt *SubStmt : S->children())
424 childrenBuf.push_back(SubStmt);
Ted Kremenek8ae67872013-02-05 22:00:19 +0000425
426 // This needs to be done *after* childrenBuf has been populated.
427 children = childrenBuf;
428}
429
Eugene Zelenko38c70522017-12-07 21:55:09 +0000430namespace {
431
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000432/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000433/// The builder is stateful: an instance of the builder should be used to only
434/// construct a single CFG.
435///
436/// Example usage:
437///
438/// CFGBuilder builder;
Jonathan Roelofsab046c52015-07-27 16:05:36 +0000439/// std::unique_ptr<CFG> cfg = builder.buildCFG(decl, stmt1);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000440///
Mike Stump31feda52009-07-17 01:31:16 +0000441/// CFG construction is done via a recursive walk of an AST. We actually parse
442/// the AST in reverse order so that the successor of a basic block is
443/// constructed prior to its predecessor. This allows us to nicely capture
444/// implicit fall-throughs without extra basic blocks.
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000445class CFGBuilder {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000446 using JumpTarget = BlockScopePosPair;
447 using JumpSource = BlockScopePosPair;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000448
Mike Stump0d76d072009-07-20 23:24:15 +0000449 ASTContext *Context;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000450 std::unique_ptr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000451
Eugene Zelenko38c70522017-12-07 21:55:09 +0000452 // Current block.
453 CFGBlock *Block = nullptr;
454
455 // Block after the current block.
456 CFGBlock *Succ = nullptr;
457
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000458 JumpTarget ContinueJumpTarget;
459 JumpTarget BreakJumpTarget;
Nico Weber699670e2017-08-23 15:33:16 +0000460 JumpTarget SEHLeaveJumpTarget;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000461 CFGBlock *SwitchTerminatedBlock = nullptr;
462 CFGBlock *DefaultCaseBlock = nullptr;
Nico Weber699670e2017-08-23 15:33:16 +0000463
464 // This can point either to a try or a __try block. The frontend forbids
465 // mixing both kinds in one function, so having one for both is enough.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000466 CFGBlock *TryTerminatedBlock = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000467
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000468 // Current position in local scope.
469 LocalScope::const_iterator ScopePos;
470
471 // LabelMap records the mapping from Label expressions to their jump targets.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000472 using LabelMapTy = llvm::DenseMap<LabelDecl *, JumpTarget>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000473 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000474
475 // A list of blocks that end with a "goto" that must be backpatched to their
476 // resolved targets upon completion of CFG construction.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000477 using BackpatchBlocksTy = std::vector<JumpSource>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000478 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000479
Ted Kremenekeda180e22007-08-28 19:26:49 +0000480 // A list of labels whose address has been taken (for indirect gotos).
Eugene Zelenko38c70522017-12-07 21:55:09 +0000481 using LabelSetTy = llvm::SmallSetVector<LabelDecl *, 8>;
Ted Kremenekeda180e22007-08-28 19:26:49 +0000482 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000483
Artem Dergachev41ffb302018-02-08 22:58:15 +0000484 // Information about the currently visited C++ object construction site.
485 // This is set in the construction trigger and read when the constructor
Artem Dergachev1527dec2018-03-12 23:12:40 +0000486 // or a function that returns an object by value is being visited.
487 llvm::DenseMap<Expr *, const ConstructionContextLayer *>
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000488 ConstructionContextMap;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000489
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000490 using DeclsWithEndedScopeSetTy = llvm::SmallSetVector<VarDecl *, 16>;
491 DeclsWithEndedScopeSetTy DeclsWithEndedScope;
492
Eugene Zelenko38c70522017-12-07 21:55:09 +0000493 bool badCFG = false;
Ted Kremenekf9d82902011-03-10 01:14:05 +0000494 const CFG::BuildOptions &BuildOpts;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000495
496 // State to track for building switch statements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000497 bool switchExclusivelyCovered = false;
498 Expr::EvalResult *switchCond = nullptr;
Ted Kremeneka099c592011-03-10 03:50:34 +0000499
Eugene Zelenko38c70522017-12-07 21:55:09 +0000500 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry = nullptr;
501 const Stmt *lastLookup = nullptr;
Zhongxing Xud38fb842010-09-16 03:28:18 +0000502
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000503 // Caches boolean evaluations of expressions to avoid multiple re-evaluations
504 // during construction of branches for chained logical operators.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000505 using CachedBoolEvalsTy = llvm::DenseMap<Expr *, TryResult>;
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000506 CachedBoolEvalsTy CachedBoolEvals;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000507
Mike Stump31feda52009-07-17 01:31:16 +0000508public:
Ted Kremenekf9d82902011-03-10 01:14:05 +0000509 explicit CFGBuilder(ASTContext *astContext,
Nico Weber699670e2017-08-23 15:33:16 +0000510 const CFG::BuildOptions &buildOpts)
511 : Context(astContext), cfg(new CFG()), // crew a new CFG
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000512 ConstructionContextMap(), BuildOpts(buildOpts) {}
513
Mike Stump31feda52009-07-17 01:31:16 +0000514
Ted Kremenek9aae5132007-08-23 21:42:29 +0000515 // buildCFG - Used by external clients to construct the CFG.
David Blaikiee90195c2014-08-29 18:53:26 +0000516 std::unique_ptr<CFG> buildCFG(const Decl *D, Stmt *Statement);
Mike Stump31feda52009-07-17 01:31:16 +0000517
Ted Kremeneka099c592011-03-10 03:50:34 +0000518 bool alwaysAdd(const Stmt *stmt);
519
Ted Kremenek93668002009-07-17 22:18:43 +0000520private:
521 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000522 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
523 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000524 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000525 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000526 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000527 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000528 CFGBlock *VisitCompoundStmt(CompoundStmt *C);
John McCallc07a0c72011-02-17 10:25:35 +0000529 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C,
530 AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000531 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek6f400242012-07-14 05:04:01 +0000532 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
533 AddStmtChoice asc);
534 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
535 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc);
Jordan Rosec9176072014-01-13 17:59:19 +0000536 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc);
Jordan Rosed2f40792013-09-03 17:00:57 +0000537 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000538 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S);
539 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
540 AddStmtChoice asc);
541 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
542 AddStmtChoice asc);
543 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
544 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000545 CFGBlock *VisitDeclStmt(DeclStmt *DS);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000546 CFGBlock *VisitDeclSubExpr(DeclStmt *DS);
Ted Kremenek21822592009-07-17 18:20:32 +0000547 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
548 CFGBlock *VisitDoStmt(DoStmt *D);
Ted Kremenek6f400242012-07-14 05:04:01 +0000549 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000550 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000551 CFGBlock *VisitGotoStmt(GotoStmt *G);
Ted Kremenek93668002009-07-17 22:18:43 +0000552 CFGBlock *VisitIfStmt(IfStmt *I);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +0000553 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *E, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000554 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I);
555 CFGBlock *VisitLabelStmt(LabelStmt *L);
Devin Coughlinb6029b72015-11-25 22:35:37 +0000556 CFGBlock *VisitBlockExpr(BlockExpr *E, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000557 CFGBlock *VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc);
Ted Kremeneka16436f2012-07-14 05:04:06 +0000558 CFGBlock *VisitLogicalOperator(BinaryOperator *B);
Ted Kremenekb50e7162012-07-14 05:04:10 +0000559 std::pair<CFGBlock *, CFGBlock *> VisitLogicalOperator(BinaryOperator *B,
560 Stmt *Term,
561 CFGBlock *TrueBlock,
562 CFGBlock *FalseBlock);
Artem Dergachevf43ac4c2018-02-24 02:00:30 +0000563 CFGBlock *VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
564 AddStmtChoice asc);
Ted Kremenek5868ec62010-04-11 17:02:10 +0000565 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000566 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S);
567 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S);
568 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S);
569 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000570 CFGBlock *VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000571 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S);
John McCallfe96e0b2011-11-06 09:01:30 +0000572 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E);
Ted Kremenek6f400242012-07-14 05:04:01 +0000573 CFGBlock *VisitReturnStmt(ReturnStmt *R);
Nico Weber699670e2017-08-23 15:33:16 +0000574 CFGBlock *VisitSEHExceptStmt(SEHExceptStmt *S);
575 CFGBlock *VisitSEHFinallyStmt(SEHFinallyStmt *S);
576 CFGBlock *VisitSEHLeaveStmt(SEHLeaveStmt *S);
577 CFGBlock *VisitSEHTryStmt(SEHTryStmt *S);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000578 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000579 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000580 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
581 AddStmtChoice asc);
Zhanyong Wan6dace612010-11-22 08:45:56 +0000582 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000583 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000584
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000585 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd);
586 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000587 CFGBlock *VisitChildren(Stmt *S);
Ted Kremeneke2499842012-04-12 20:03:44 +0000588 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc);
Mike Stump48871a22009-07-17 01:04:31 +0000589
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000590 void maybeAddScopeBeginForVarDecl(CFGBlock *B, const VarDecl *VD,
591 const Stmt *S) {
592 if (ScopePos && (VD == ScopePos.getFirstVarInScope()))
593 appendScopeBegin(B, VD, S);
594 }
595
Manuel Klimekb5616c92014-08-07 10:42:17 +0000596 /// When creating the CFG for temporary destructors, we want to mirror the
597 /// branch structure of the corresponding constructor calls.
598 /// Thus, while visiting a statement for temporary destructors, we keep a
599 /// context to keep track of the following information:
600 /// - whether a subexpression is executed unconditionally
601 /// - if a subexpression is executed conditionally, the first
602 /// CXXBindTemporaryExpr we encounter in that subexpression (which
603 /// corresponds to the last temporary destructor we have to call for this
604 /// subexpression) and the CFG block at that point (which will become the
605 /// successor block when inserting the decision point).
606 ///
607 /// That way, we can build the branch structure for temporary destructors as
608 /// follows:
609 /// 1. If a subexpression is executed unconditionally, we add the temporary
610 /// destructor calls to the current block.
611 /// 2. If a subexpression is executed conditionally, when we encounter a
612 /// CXXBindTemporaryExpr:
613 /// a) If it is the first temporary destructor call in the subexpression,
614 /// we remember the CXXBindTemporaryExpr and the current block in the
615 /// TempDtorContext; we start a new block, and insert the temporary
616 /// destructor call.
617 /// b) Otherwise, add the temporary destructor call to the current block.
618 /// 3. When we finished visiting a conditionally executed subexpression,
619 /// and we found at least one temporary constructor during the visitation
620 /// (2.a has executed), we insert a decision block that uses the
621 /// CXXBindTemporaryExpr as terminator, and branches to the current block
622 /// if the CXXBindTemporaryExpr was marked executed, and otherwise
623 /// branches to the stored successor.
624 struct TempDtorContext {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000625 TempDtorContext() = default;
Manuel Klimekdeb02622014-08-08 07:37:13 +0000626 TempDtorContext(TryResult KnownExecuted)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000627 : IsConditional(true), KnownExecuted(KnownExecuted) {}
Manuel Klimekb5616c92014-08-07 10:42:17 +0000628
629 /// Returns whether we need to start a new branch for a temporary destructor
Eric Christopher2c4555a2015-06-19 01:52:53 +0000630 /// call. This is the case when the temporary destructor is
Manuel Klimekb5616c92014-08-07 10:42:17 +0000631 /// conditionally executed, and it is the first one we encounter while
632 /// visiting a subexpression - other temporary destructors at the same level
633 /// will be added to the same block and are executed under the same
634 /// condition.
635 bool needsTempDtorBranch() const {
636 return IsConditional && !TerminatorExpr;
637 }
638
639 /// Remember the successor S of a temporary destructor decision branch for
640 /// the corresponding CXXBindTemporaryExpr E.
641 void setDecisionPoint(CFGBlock *S, CXXBindTemporaryExpr *E) {
642 Succ = S;
643 TerminatorExpr = E;
644 }
645
Eugene Zelenko38c70522017-12-07 21:55:09 +0000646 const bool IsConditional = false;
647 const TryResult KnownExecuted = true;
648 CFGBlock *Succ = nullptr;
649 CXXBindTemporaryExpr *TerminatorExpr = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000650 };
651
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000652 // Visitors to walk an AST and generate destructors of temporaries in
653 // full expression.
Manuel Klimekb5616c92014-08-07 10:42:17 +0000654 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
655 TempDtorContext &Context);
656 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E, TempDtorContext &Context);
657 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E,
658 TempDtorContext &Context);
659 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(
660 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context);
661 CFGBlock *VisitConditionalOperatorForTemporaryDtors(
662 AbstractConditionalOperator *E, bool BindToTemporary,
663 TempDtorContext &Context);
664 void InsertTempDtorDecisionBlock(const TempDtorContext &Context,
665 CFGBlock *FalseSucc = nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000666
Ted Kremenek6065ef62008-04-28 18:00:46 +0000667 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000668 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000669 badCFG = true;
670 return Block;
671 }
Mike Stump31feda52009-07-17 01:31:16 +0000672
Artem Dergachev40684812018-02-27 20:03:35 +0000673 // Remember to apply the construction context based on the current \p Layer
674 // when constructing the CFG element for \p CE.
675 void consumeConstructionContext(const ConstructionContextLayer *Layer,
Artem Dergachev1527dec2018-03-12 23:12:40 +0000676 Expr *E);
Artem Dergachevc1b07bd2018-02-23 23:38:41 +0000677
Artem Dergachev40684812018-02-27 20:03:35 +0000678 // Scan \p Child statement to find constructors in it, while keeping in mind
679 // that its parent statement is providing a partial construction context
680 // described by \p Layer. If a constructor is found, it would be assigned
681 // the context based on the layer. If an additional construction context layer
682 // is found, the function recurses into that.
683 void findConstructionContexts(const ConstructionContextLayer *Layer,
Artem Dergachev783a4572018-02-23 22:20:39 +0000684 Stmt *Child);
Artem Dergachev40684812018-02-27 20:03:35 +0000685
Artem Dergachev41ffb302018-02-08 22:58:15 +0000686 // Unset the construction context after consuming it. This is done immediately
Artem Dergachev1527dec2018-03-12 23:12:40 +0000687 // after adding the CFGConstructor or CFGCXXRecordTypedCall element, so
688 // there's no need to do this manually in every Visit... function.
689 void cleanupConstructionContext(Expr *E);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000690
Ted Kremenek93668002009-07-17 22:18:43 +0000691 void autoCreateBlock() { if (!Block) Block = createBlock(); }
692 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000693 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000694
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000695 CFGBlock *addStmt(Stmt *S) {
696 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000697 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000698
Alexis Hunt1d792652011-01-08 20:30:50 +0000699 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000700 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000701 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000702 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000703 void addLifetimeEnds(LocalScope::const_iterator B,
704 LocalScope::const_iterator E, Stmt *S);
705 void addAutomaticObjHandling(LocalScope::const_iterator B,
706 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000707 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000708 void addScopesEnd(LocalScope::const_iterator B, LocalScope::const_iterator E,
709 Stmt *S);
710
711 void getDeclsWithEndedScope(LocalScope::const_iterator B,
712 LocalScope::const_iterator E, Stmt *S);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000713
Marcin Swiderski5e415732010-09-30 23:05:00 +0000714 // Local scopes creation.
715 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
716
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000717 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000718 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
719 LocalScope* Scope = nullptr);
720 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000721
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000722 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000723
724 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000725
Ted Kremenek37881932011-04-04 23:29:12 +0000726 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000727 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000728 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000729
Jordy Rose17347372011-06-10 08:49:37 +0000730 // All block-level expressions should have already been IgnoreParens()ed.
731 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000732 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000733 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000734
Artem Dergachev41ffb302018-02-08 22:58:15 +0000735 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
736 if (BuildOpts.AddRichCXXConstructors) {
Artem Dergachev40684812018-02-27 20:03:35 +0000737 if (const ConstructionContextLayer *Layer =
738 ConstructionContextMap.lookup(CE)) {
Artem Dergachev783a4572018-02-23 22:20:39 +0000739 cleanupConstructionContext(CE);
Artem Dergachev6a5cd5e2018-03-30 19:25:39 +0000740 if (const auto *CC = ConstructionContext::createFromLayers(
741 cfg->getBumpVectorContext(), Layer)) {
742 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
743 return;
744 }
Artem Dergachev41ffb302018-02-08 22:58:15 +0000745 }
746 }
747
748 // No valid construction context found. Fall back to statement.
749 B->appendStmt(CE, cfg->getBumpVectorContext());
750 }
751
Artem Dergachev1527dec2018-03-12 23:12:40 +0000752 void appendCall(CFGBlock *B, CallExpr *CE) {
Richard Trieuf4a0e9a2018-03-15 00:09:26 +0000753 if (alwaysAdd(CE) && cachedEntry)
754 cachedEntry->second = B;
755
Artem Dergachev1527dec2018-03-12 23:12:40 +0000756 if (BuildOpts.AddRichCXXConstructors) {
Artem Dergachev54ed6422018-03-12 23:52:36 +0000757 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(CE, *Context)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +0000758 if (const ConstructionContextLayer *Layer =
759 ConstructionContextMap.lookup(CE)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +0000760 cleanupConstructionContext(CE);
Artem Dergachev6a5cd5e2018-03-30 19:25:39 +0000761 if (const auto *CC = ConstructionContext::createFromLayers(
762 cfg->getBumpVectorContext(), Layer)) {
763 B->appendCXXRecordTypedCall(CE, CC, cfg->getBumpVectorContext());
764 return;
765 }
Artem Dergachev1527dec2018-03-12 23:12:40 +0000766 }
767 }
768 }
769
770 // No valid construction context found. Fall back to statement.
771 B->appendStmt(CE, cfg->getBumpVectorContext());
772 }
773
Alexis Hunt1d792652011-01-08 20:30:50 +0000774 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000775 B->appendInitializer(I, cfg->getBumpVectorContext());
776 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000777
Jordan Rosec9176072014-01-13 17:59:19 +0000778 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
779 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
780 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000781
Marcin Swiderski20b88732010-10-05 05:37:00 +0000782 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
783 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
784 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000785
Marcin Swiderski20b88732010-10-05 05:37:00 +0000786 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
787 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
788 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000789
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000790 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
791 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
792 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000793
Chandler Carruthad747252011-09-13 06:09:01 +0000794 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
795 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
796 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000797
Matthias Gehre351c2182017-07-12 07:04:19 +0000798 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
799 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
800 }
801
Peter Szecsi999a25f2017-08-19 11:19:16 +0000802 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
803 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
804 }
805
Jordan Rosed2f40792013-09-03 17:00:57 +0000806 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
807 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
808 }
809
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000810 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000811 LocalScope::const_iterator B, LocalScope::const_iterator E);
812
Matthias Gehre351c2182017-07-12 07:04:19 +0000813 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
814 LocalScope::const_iterator B,
815 LocalScope::const_iterator E);
816
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000817 const VarDecl *
818 prependAutomaticObjScopeEndWithTerminator(CFGBlock *Blk,
819 LocalScope::const_iterator B,
820 LocalScope::const_iterator E);
821
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000822 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
823 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
824 cfg->getBumpVectorContext());
825 }
826
827 /// Add a reachable successor to a block, with the alternate variant that is
828 /// unreachable.
829 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
830 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
831 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000832 }
Mike Stump11289f42009-09-09 15:08:12 +0000833
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000834 void appendScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
835 if (BuildOpts.AddScopes)
836 B->appendScopeBegin(VD, S, cfg->getBumpVectorContext());
837 }
838
839 void prependScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
840 if (BuildOpts.AddScopes)
841 B->prependScopeBegin(VD, S, cfg->getBumpVectorContext());
842 }
843
844 void appendScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
845 if (BuildOpts.AddScopes)
846 B->appendScopeEnd(VD, S, cfg->getBumpVectorContext());
847 }
848
849 void prependScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
850 if (BuildOpts.AddScopes)
851 B->prependScopeEnd(VD, S, cfg->getBumpVectorContext());
852 }
853
Richard Trieuf935b562014-04-05 05:17:01 +0000854 /// \brief Find a relational comparison with an expression evaluating to a
855 /// boolean and a constant other than 0 and 1.
856 /// e.g. if ((x < y) == 10)
857 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
858 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
859 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
860
861 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
862 const Expr *BoolExpr = RHSExpr;
863 bool IntFirst = true;
864 if (!IntLiteral) {
865 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
866 BoolExpr = LHSExpr;
867 IntFirst = false;
868 }
869
870 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
871 return TryResult();
872
873 llvm::APInt IntValue = IntLiteral->getValue();
874 if ((IntValue == 1) || (IntValue == 0))
875 return TryResult();
876
877 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
878 !IntValue.isNegative();
879
880 BinaryOperatorKind Bok = B->getOpcode();
881 if (Bok == BO_GT || Bok == BO_GE) {
882 // Always true for 10 > bool and bool > -1
883 // Always false for -1 > bool and bool > 10
884 return TryResult(IntFirst == IntLarger);
885 } else {
886 // Always true for -1 < bool and bool < 10
887 // Always false for 10 < bool and bool < -1
888 return TryResult(IntFirst != IntLarger);
889 }
890 }
891
Jordan Rose7afd71e2014-05-20 17:31:11 +0000892 /// Find an incorrect equality comparison. Either with an expression
893 /// evaluating to a boolean and a constant other than 0 and 1.
894 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
895 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000896 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
897 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
898 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
899
900 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
901 const Expr *BoolExpr = RHSExpr;
902
903 if (!IntLiteral) {
904 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
905 BoolExpr = LHSExpr;
906 }
907
Jordan Rose7afd71e2014-05-20 17:31:11 +0000908 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000909 return TryResult();
910
Jordan Rose7afd71e2014-05-20 17:31:11 +0000911 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
912 if (BitOp && (BitOp->getOpcode() == BO_And ||
913 BitOp->getOpcode() == BO_Or)) {
914 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
915 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
916
917 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
918
919 if (!IntLiteral2)
920 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
921
922 if (!IntLiteral2)
923 return TryResult();
924
925 llvm::APInt L1 = IntLiteral->getValue();
926 llvm::APInt L2 = IntLiteral2->getValue();
927 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
928 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
929 if (BuildOpts.Observer)
930 BuildOpts.Observer->compareBitwiseEquality(B,
931 B->getOpcode() != BO_EQ);
932 TryResult(B->getOpcode() != BO_EQ);
933 }
934 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
935 llvm::APInt IntValue = IntLiteral->getValue();
936 if ((IntValue == 1) || (IntValue == 0)) {
937 return TryResult();
938 }
939 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000940 }
941
Jordan Rose7afd71e2014-05-20 17:31:11 +0000942 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000943 }
944
945 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
946 const llvm::APSInt &Value1,
947 const llvm::APSInt &Value2) {
948 assert(Value1.isSigned() == Value2.isSigned());
949 switch (Relation) {
950 default:
951 return TryResult();
952 case BO_EQ:
953 return TryResult(Value1 == Value2);
954 case BO_NE:
955 return TryResult(Value1 != Value2);
956 case BO_LT:
957 return TryResult(Value1 < Value2);
958 case BO_LE:
959 return TryResult(Value1 <= Value2);
960 case BO_GT:
961 return TryResult(Value1 > Value2);
962 case BO_GE:
963 return TryResult(Value1 >= Value2);
964 }
965 }
966
967 /// \brief Find a pair of comparison expressions with or without parentheses
968 /// with a shared variable and constants and a logical operator between them
969 /// that always evaluates to either true or false.
970 /// e.g. if (x != 3 || x != 4)
971 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
972 assert(B->isLogicalOp());
973 const BinaryOperator *LHS =
974 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
975 const BinaryOperator *RHS =
976 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
977 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000978 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000979
980 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000981 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000982
George Burgess IVced56e62015-10-01 18:47:52 +0000983 const DeclRefExpr *Decl1;
984 const Expr *Expr1;
985 BinaryOperatorKind BO1;
986 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000987
George Burgess IVced56e62015-10-01 18:47:52 +0000988 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000989 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000990
George Burgess IVced56e62015-10-01 18:47:52 +0000991 const DeclRefExpr *Decl2;
992 const Expr *Expr2;
993 BinaryOperatorKind BO2;
994 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000995
George Burgess IVced56e62015-10-01 18:47:52 +0000996 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000997 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000998
999 // Check that it is the same variable on both sides.
1000 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001001 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001002
George Burgess IVced56e62015-10-01 18:47:52 +00001003 // Make sure the user's intent is clear (e.g. they're comparing against two
1004 // int literals, or two things from the same enum)
1005 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001006 return {};
George Burgess IVced56e62015-10-01 18:47:52 +00001007
Richard Trieuf935b562014-04-05 05:17:01 +00001008 llvm::APSInt L1, L2;
1009
George Burgess IVced56e62015-10-01 18:47:52 +00001010 if (!Expr1->EvaluateAsInt(L1, *Context) ||
1011 !Expr2->EvaluateAsInt(L2, *Context))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001012 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001013
1014 // Can't compare signed with unsigned or with different bit width.
1015 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001016 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001017
1018 // Values that will be used to determine if result of logical
1019 // operator is always true/false
1020 const llvm::APSInt Values[] = {
1021 // Value less than both Value1 and Value2
1022 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
1023 // L1
1024 L1,
1025 // Value between Value1 and Value2
1026 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
1027 L1.isUnsigned()),
1028 // L2
1029 L2,
1030 // Value greater than both Value1 and Value2
1031 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
1032 };
1033
1034 // Check whether expression is always true/false by evaluating the following
1035 // * variable x is less than the smallest literal.
1036 // * variable x is equal to the smallest literal.
1037 // * Variable x is between smallest and largest literal.
1038 // * Variable x is equal to the largest literal.
1039 // * Variable x is greater than largest literal.
1040 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001041 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +00001042 TryResult Res1, Res2;
1043 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
1044 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
1045
1046 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001047 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001048
1049 if (B->getOpcode() == BO_LAnd) {
1050 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
1051 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
1052 } else {
1053 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
1054 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
1055 }
1056 }
1057
1058 if (AlwaysTrue || AlwaysFalse) {
1059 if (BuildOpts.Observer)
1060 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
1061 return TryResult(AlwaysTrue);
1062 }
Eugene Zelenko38c70522017-12-07 21:55:09 +00001063 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001064 }
1065
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001066 /// Try and evaluate an expression to an integer constant.
1067 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
1068 if (!BuildOpts.PruneTriviallyFalseEdges)
1069 return false;
1070 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001071 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001072 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001073 }
Mike Stump11289f42009-09-09 15:08:12 +00001074
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001075 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001076 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001077 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001078 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001079 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001080 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001081
1082 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1083 if (Bop->isLogicalOp()) {
1084 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001085 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1086 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001087 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001088
1089 // Retrieve result at first, or the map might be updated.
1090 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1091 CachedBoolEvals[S] = Result; // update or insert
1092 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001093 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001094 else {
1095 switch (Bop->getOpcode()) {
1096 default: break;
1097 // For 'x & 0' and 'x * 0', we can determine that
1098 // the value is always false.
1099 case BO_Mul:
1100 case BO_And: {
1101 // If either operand is zero, we know the value
1102 // must be false.
1103 llvm::APSInt IntVal;
1104 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001105 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001106 return TryResult(false);
1107 }
1108 }
1109 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001110 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001111 return TryResult(false);
1112 }
1113 }
1114 }
1115 break;
1116 }
1117 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001118 }
1119
1120 return evaluateAsBooleanConditionNoCache(S);
1121 }
1122
1123 /// \brief Evaluate as boolean \param E without using the cache.
1124 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1125 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1126 if (Bop->isLogicalOp()) {
1127 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1128 if (LHS.isKnown()) {
1129 // We were able to evaluate the LHS, see if we can get away with not
1130 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1131 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1132 return LHS.isTrue();
1133
1134 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1135 if (RHS.isKnown()) {
1136 if (Bop->getOpcode() == BO_LOr)
1137 return LHS.isTrue() || RHS.isTrue();
1138 else
1139 return LHS.isTrue() && RHS.isTrue();
1140 }
1141 } else {
1142 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1143 if (RHS.isKnown()) {
1144 // We can't evaluate the LHS; however, sometimes the result
1145 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1146 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1147 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001148 } else {
1149 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1150 if (BopRes.isKnown())
1151 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001152 }
1153 }
1154
Eugene Zelenko38c70522017-12-07 21:55:09 +00001155 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001156 } else if (Bop->isEqualityOp()) {
1157 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1158 if (BopRes.isKnown())
1159 return BopRes.isTrue();
1160 } else if (Bop->isRelationalOp()) {
1161 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1162 if (BopRes.isKnown())
1163 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001164 }
1165 }
1166
1167 bool Result;
1168 if (E->EvaluateAsBooleanCondition(Result, *Context))
1169 return Result;
1170
Eugene Zelenko38c70522017-12-07 21:55:09 +00001171 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001172 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001173
1174 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001175};
Mike Stump31feda52009-07-17 01:31:16 +00001176
Eugene Zelenko38c70522017-12-07 21:55:09 +00001177} // namespace
1178
Ted Kremeneka099c592011-03-10 03:50:34 +00001179inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1180 const Stmt *stmt) const {
1181 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1182}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001183
Ted Kremeneka099c592011-03-10 03:50:34 +00001184bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001185 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
1186
Ted Kremeneka099c592011-03-10 03:50:34 +00001187 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001188 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001189
1190 if (lastLookup == stmt) {
1191 if (cachedEntry) {
1192 assert(cachedEntry->first == stmt);
1193 return true;
1194 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001195 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001196 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001197
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001198 lastLookup = stmt;
1199
1200 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001201 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1202
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001203 if (!fb) {
1204 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001205 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001206 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001207 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001208
1209 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001210 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001211 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001212 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001213 }
1214
Ted Kremeneka099c592011-03-10 03:50:34 +00001215 cachedEntry = &*itr;
1216 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001217}
1218
Douglas Gregor4619e432008-12-05 23:32:09 +00001219// FIXME: Add support for dependent-sized array types in C++?
1220// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001221static const VariableArrayType *FindVA(const Type *t) {
1222 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1223 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001224 if (vat->getSizeExpr())
1225 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001226
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001227 t = vt->getElementType().getTypePtr();
1228 }
Mike Stump31feda52009-07-17 01:31:16 +00001229
Craig Topper25542942014-05-20 04:30:07 +00001230 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001231}
Mike Stump31feda52009-07-17 01:31:16 +00001232
Artem Dergachev40684812018-02-27 20:03:35 +00001233void CFGBuilder::consumeConstructionContext(
Artem Dergachev1527dec2018-03-12 23:12:40 +00001234 const ConstructionContextLayer *Layer, Expr *E) {
Artem Dergachev40684812018-02-27 20:03:35 +00001235 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachev1527dec2018-03-12 23:12:40 +00001236 ConstructionContextMap.lookup(E)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001237 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001238 // We might have visited this child when we were finding construction
1239 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001240 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001241 "Already within a different construction context!");
1242 } else {
Artem Dergachev1527dec2018-03-12 23:12:40 +00001243 ConstructionContextMap[E] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001244 }
1245}
1246
Artem Dergachev783a4572018-02-23 22:20:39 +00001247void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001248 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001249 if (!BuildOpts.AddRichCXXConstructors)
1250 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001251
Artem Dergachev41ffb302018-02-08 22:58:15 +00001252 if (!Child)
1253 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001254
1255 switch(Child->getStmtClass()) {
1256 case Stmt::CXXConstructExprClass:
1257 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachev40684812018-02-27 20:03:35 +00001258 consumeConstructionContext(Layer, cast<CXXConstructExpr>(Child));
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001259 break;
1260 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00001261 // FIXME: This, like the main visit, doesn't support CUDAKernelCallExpr.
1262 // FIXME: An isa<> would look much better but this whole switch is a
1263 // workaround for an internal compiler error in MSVC 2015 (see r326021).
1264 case Stmt::CallExprClass:
1265 case Stmt::CXXMemberCallExprClass:
1266 case Stmt::CXXOperatorCallExprClass:
1267 case Stmt::UserDefinedLiteralClass: {
1268 auto *CE = cast<CallExpr>(Child);
Artem Dergachev54ed6422018-03-12 23:52:36 +00001269 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(CE, *Context))
Artem Dergachev1527dec2018-03-12 23:12:40 +00001270 consumeConstructionContext(Layer, CE);
1271 break;
1272 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001273 case Stmt::ExprWithCleanupsClass: {
1274 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001275 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001276 break;
1277 }
1278 case Stmt::CXXFunctionalCastExprClass: {
1279 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001280 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001281 break;
1282 }
1283 case Stmt::ImplicitCastExprClass: {
1284 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev317291e2018-03-22 21:37:39 +00001285 // Should we support other implicit cast kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001286 switch (Cast->getCastKind()) {
1287 case CK_NoOp:
1288 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001289 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev13f96642018-03-09 01:39:59 +00001290 default:
1291 break;
1292 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001293 break;
1294 }
1295 case Stmt::CXXBindTemporaryExprClass: {
1296 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachev783a4572018-02-23 22:20:39 +00001297 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001298 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
1299 BTE, Layer),
Artem Dergachev783a4572018-02-23 22:20:39 +00001300 BTE->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001301 break;
1302 }
1303 case Stmt::ConditionalOperatorClass: {
1304 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev9d3a7d82018-03-30 19:21:18 +00001305 if (!dyn_cast_or_null<MaterializeTemporaryExpr>(Layer->getTriggerStmt())) {
1306 // If the object returned by the conditional operator is not going to be a
1307 // temporary object that needs to be immediately materialized, then
1308 // it must be C++17 with its mandatory copy elision. Do not yet promise
1309 // to support this case.
1310 assert(!CO->getType()->getAsCXXRecordDecl() || CO->isGLValue() ||
1311 Context->getLangOpts().CPlusPlus17);
1312 break;
1313 }
Artem Dergachev40684812018-02-27 20:03:35 +00001314 findConstructionContexts(Layer, CO->getLHS());
1315 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001316 break;
1317 }
1318 default:
1319 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001320 }
1321}
1322
Artem Dergachev1527dec2018-03-12 23:12:40 +00001323void CFGBuilder::cleanupConstructionContext(Expr *E) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001324 assert(BuildOpts.AddRichCXXConstructors &&
1325 "We should not be managing construction contexts!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001326 assert(ConstructionContextMap.count(E) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001327 "Cannot exit construction context without the context!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001328 ConstructionContextMap.erase(E);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001329}
1330
1331
Mike Stump31feda52009-07-17 01:31:16 +00001332/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1333/// arbitrary statement. Examples include a single expression or a function
1334/// body (compound statement). The ownership of the returned CFG is
1335/// transferred to the caller. If CFG construction fails, this method returns
1336/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001337std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001338 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001339 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001340 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001341
Mike Stump31feda52009-07-17 01:31:16 +00001342 // Create an empty block that will serve as the exit block for the CFG. Since
1343 // this is the first block added to the CFG, it will be implicitly registered
1344 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001345 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001346 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001347 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001348
Matthias Gehre351c2182017-07-12 07:04:19 +00001349 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1350 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1351
Marcin Swiderski20b88732010-10-05 05:37:00 +00001352 if (BuildOpts.AddImplicitDtors)
1353 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1354 addImplicitDtorsForDestructor(DD);
1355
Ted Kremenek9aae5132007-08-23 21:42:29 +00001356 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001357 CFGBlock *B = addStmt(Statement);
1358
1359 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001360 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001361
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001362 // For C++ constructor add initializers to CFG.
1363 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001364 for (auto *I : llvm::reverse(CD->inits())) {
1365 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001366 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001367 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001368 }
1369 }
1370
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001371 if (B)
1372 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001373
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001374 // Backpatch the gotos whose label -> block mappings we didn't know when we
1375 // encountered them.
1376 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1377 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001378
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001379 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001380 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001381 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001382
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001383 // If there is no target for the goto, then we are looking at an
1384 // incomplete AST. Handle this by not registering a successor.
1385 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001386
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001387 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001388 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1389 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001390 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1391 JT.scopePosition);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001392 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1393 B, I->scopePosition, JT.scopePosition);
1394 appendScopeBegin(JT.block, VD, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001395 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001396 }
1397
1398 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001399 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001400 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1401 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001402 // Lookup the target block.
1403 LabelMapTy::iterator LI = LabelMap.find(*I);
1404
1405 // If there is no target block that contains label, then we are looking
1406 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001407 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001408
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001409 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001410 }
Mike Stump31feda52009-07-17 01:31:16 +00001411
Mike Stump31feda52009-07-17 01:31:16 +00001412 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001413 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001414
Artem Dergachev783a4572018-02-23 22:20:39 +00001415 if (BuildOpts.AddRichCXXConstructors)
1416 assert(ConstructionContextMap.empty() &&
1417 "Not all construction contexts were cleaned up!");
1418
David Blaikiee90195c2014-08-29 18:53:26 +00001419 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001420}
Mike Stump31feda52009-07-17 01:31:16 +00001421
Ted Kremenek9aae5132007-08-23 21:42:29 +00001422/// createBlock - Used to lazily create blocks that are connected
1423/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001424CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1425 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001426 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001427 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001428 return B;
1429}
Mike Stump31feda52009-07-17 01:31:16 +00001430
Chandler Carrutha70991b2011-09-13 09:13:49 +00001431/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1432/// CFG. It is *not* connected to the current (global) successor, and instead
1433/// directly tied to the exit block in order to be reachable.
1434CFGBlock *CFGBuilder::createNoReturnBlock() {
1435 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001436 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001437 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001438 return B;
1439}
1440
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001441/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001442CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001443 if (!BuildOpts.AddInitializers)
1444 return Block;
1445
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001446 bool HasTemporaries = false;
1447
1448 // Destructors of temporaries in initialization expression should be called
1449 // after initialization finishes.
1450 Expr *Init = I->getInit();
1451 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001452 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001453
Jordan Rose6d671cc2012-09-05 22:55:23 +00001454 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001455 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001456 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001457 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1458 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001459 }
1460 }
1461
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001462 autoCreateBlock();
1463 appendInitializer(Block, I);
1464
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001465 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001466 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001467 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001468 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001469
Ted Kremenek8219b822010-12-16 07:46:53 +00001470 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001471 // For expression with temporaries go directly to subexpression to omit
1472 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001473 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1474 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001475 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1476 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1477 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1478 // may cause the same Expr to appear more than once in the CFG. Doing it
1479 // here is safe because there's only one initializer per field.
1480 autoCreateBlock();
1481 appendStmt(Block, Default);
1482 if (Stmt *Child = Default->getExpr())
1483 if (CFGBlock *R = Visit(Child))
1484 Block = R;
1485 return Block;
1486 }
1487 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001488 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001489 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001490
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001491 return Block;
1492}
1493
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001494/// \brief Retrieve the type of the temporary object whose lifetime was
1495/// extended by a local reference with the given initializer.
1496static QualType getReferenceInitTemporaryType(ASTContext &Context,
Richard Smithb8c0f552016-12-09 18:49:13 +00001497 const Expr *Init,
1498 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001499 while (true) {
1500 // Skip parentheses.
1501 Init = Init->IgnoreParens();
1502
1503 // Skip through cleanups.
1504 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1505 Init = EWC->getSubExpr();
1506 continue;
1507 }
1508
1509 // Skip through the temporary-materialization expression.
1510 if (const MaterializeTemporaryExpr *MTE
1511 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1512 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001513 if (FoundMTE)
1514 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001515 continue;
1516 }
1517
1518 // Skip derived-to-base and no-op casts.
1519 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) {
1520 if ((CE->getCastKind() == CK_DerivedToBase ||
1521 CE->getCastKind() == CK_UncheckedDerivedToBase ||
1522 CE->getCastKind() == CK_NoOp) &&
1523 Init->getType()->isRecordType()) {
1524 Init = CE->getSubExpr();
1525 continue;
1526 }
1527 }
1528
1529 // Skip member accesses into rvalues.
1530 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) {
1531 if (!ME->isArrow() && ME->getBase()->isRValue()) {
1532 Init = ME->getBase();
1533 continue;
1534 }
1535 }
1536
1537 break;
1538 }
1539
1540 return Init->getType();
1541}
Matthias Gehre351c2182017-07-12 07:04:19 +00001542
Peter Szecsi999a25f2017-08-19 11:19:16 +00001543// TODO: Support adding LoopExit element to the CFG in case where the loop is
1544// ended by ReturnStmt, GotoStmt or ThrowExpr.
1545void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1546 if(!BuildOpts.AddLoopExit)
1547 return;
1548 autoCreateBlock();
1549 appendLoopExit(Block, LoopStmt);
1550}
1551
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001552void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1553 LocalScope::const_iterator E, Stmt *S) {
1554 if (!BuildOpts.AddScopes)
1555 return;
1556
1557 if (B == E)
1558 return;
1559
1560 // To go from B to E, one first goes up the scopes from B to P
1561 // then sideways in one scope from P to P' and then down
1562 // the scopes from P' to E.
1563 // The lifetime of all objects between B and P end.
1564 LocalScope::const_iterator P = B.shared_parent(E);
1565 int Dist = B.distance(P);
1566 if (Dist <= 0)
1567 return;
1568
1569 for (LocalScope::const_iterator I = B; I != P; ++I)
1570 if (I.pointsToFirstDeclaredVar())
1571 DeclsWithEndedScope.insert(*I);
1572}
1573
Matthias Gehre351c2182017-07-12 07:04:19 +00001574void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1575 LocalScope::const_iterator E,
1576 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001577 getDeclsWithEndedScope(B, E, S);
1578 if (BuildOpts.AddScopes)
1579 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001580 if (BuildOpts.AddImplicitDtors)
1581 addAutomaticObjDtors(B, E, S);
1582 if (BuildOpts.AddLifetime)
1583 addLifetimeEnds(B, E, S);
1584}
1585
1586/// Add to current block automatic objects that leave the scope.
1587void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1588 LocalScope::const_iterator E, Stmt *S) {
1589 if (!BuildOpts.AddLifetime)
1590 return;
1591
1592 if (B == E)
1593 return;
1594
1595 // To go from B to E, one first goes up the scopes from B to P
1596 // then sideways in one scope from P to P' and then down
1597 // the scopes from P' to E.
1598 // The lifetime of all objects between B and P end.
1599 LocalScope::const_iterator P = B.shared_parent(E);
1600 int dist = B.distance(P);
1601 if (dist <= 0)
1602 return;
1603
1604 // We need to perform the scope leaving in reverse order
1605 SmallVector<VarDecl *, 10> DeclsTrivial;
1606 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1607 DeclsTrivial.reserve(dist);
1608 DeclsNonTrivial.reserve(dist);
1609
1610 for (LocalScope::const_iterator I = B; I != P; ++I)
1611 if (hasTrivialDestructor(*I))
1612 DeclsTrivial.push_back(*I);
1613 else
1614 DeclsNonTrivial.push_back(*I);
1615
1616 autoCreateBlock();
1617 // object with trivial destructor end their lifetime last (when storage
1618 // duration ends)
1619 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1620 E = DeclsTrivial.rend();
1621 I != E; ++I)
1622 appendLifetimeEnds(Block, *I, S);
1623
1624 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1625 I = DeclsNonTrivial.rbegin(),
1626 E = DeclsNonTrivial.rend();
1627 I != E; ++I)
1628 appendLifetimeEnds(Block, *I, S);
1629}
1630
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001631/// Add to current block markers for ending scopes.
1632void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1633 LocalScope::const_iterator E, Stmt *S) {
1634 // If implicit destructors are enabled, we'll add scope ends in
1635 // addAutomaticObjDtors.
1636 if (BuildOpts.AddImplicitDtors)
1637 return;
1638
1639 autoCreateBlock();
1640
1641 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1642 I != E; ++I)
1643 appendScopeEnd(Block, *I, S);
1644
1645 return;
1646}
1647
Marcin Swiderski5e415732010-09-30 23:05:00 +00001648/// addAutomaticObjDtors - Add to current block automatic objects destructors
1649/// for objects in range of local scope positions. Use S as trigger statement
1650/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001651void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001652 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001653 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001654 return;
1655
Marcin Swiderski5e415732010-09-30 23:05:00 +00001656 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001657 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001658
Chandler Carruthad747252011-09-13 06:09:01 +00001659 // We need to append the destructors in reverse order, but any one of them
1660 // may be a no-return destructor which changes the CFG. As a result, buffer
1661 // this sequence up and replay them in reverse order when appending onto the
1662 // CFGBlock(s).
1663 SmallVector<VarDecl*, 10> Decls;
1664 Decls.reserve(B.distance(E));
1665 for (LocalScope::const_iterator I = B; I != E; ++I)
1666 Decls.push_back(*I);
1667
1668 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1669 E = Decls.rend();
1670 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001671 if (hasTrivialDestructor(*I)) {
1672 // If AddScopes is enabled and *I is a first variable in a scope, add a
1673 // ScopeEnd marker in a Block.
1674 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1675 autoCreateBlock();
1676 appendScopeEnd(Block, *I, S);
1677 }
1678 continue;
1679 }
Chandler Carruthad747252011-09-13 06:09:01 +00001680 // If this destructor is marked as a no-return destructor, we need to
1681 // create a new block for the destructor which does not have as a successor
1682 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001683 QualType Ty = (*I)->getType();
1684 if (Ty->isReferenceType()) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001685 Ty = getReferenceInitTemporaryType(*Context, (*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001686 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001687 Ty = Context->getBaseElementType(Ty);
1688
Richard Trieu95a192a2015-05-28 00:14:02 +00001689 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001690 Block = createNoReturnBlock();
1691 else
Chandler Carruthad747252011-09-13 06:09:01 +00001692 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001693
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001694 // Add ScopeEnd just after automatic obj destructor.
1695 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1696 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001697 appendAutomaticObjDtor(Block, *I, S);
1698 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001699}
1700
Marcin Swiderski20b88732010-10-05 05:37:00 +00001701/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1702/// base and member objects in destructor.
1703void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001704 assert(BuildOpts.AddImplicitDtors &&
1705 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001706 const CXXRecordDecl *RD = DD->getParent();
1707
1708 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001709 for (const auto &VI : RD->vbases()) {
1710 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001711 if (!CD->hasTrivialDestructor()) {
1712 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001713 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001714 }
1715 }
1716
1717 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001718 for (const auto &BI : RD->bases()) {
1719 if (!BI.isVirtual()) {
1720 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001721 if (!CD->hasTrivialDestructor()) {
1722 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001723 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001724 }
1725 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001726 }
1727
1728 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001729 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001730 // Check for constant size array. Set type to array element type.
1731 QualType QT = FI->getType();
1732 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1733 if (AT->getSize() == 0)
1734 continue;
1735 QT = AT->getElementType();
1736 }
1737
1738 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001739 if (!CD->hasTrivialDestructor()) {
1740 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001741 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001742 }
1743 }
1744}
1745
Marcin Swiderski5e415732010-09-30 23:05:00 +00001746/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1747/// way return valid LocalScope object.
1748LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001749 if (Scope)
1750 return Scope;
1751 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1752 return new (alloc.Allocate<LocalScope>())
1753 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001754}
1755
1756/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +00001757/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001758void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001759 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1760 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001761 return;
1762
Craig Topper25542942014-05-20 04:30:07 +00001763 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001764
1765 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001766 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001767 for (auto *BI : CS->body()) {
1768 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001769 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001770 Scope = addLocalScopeForDeclStmt(DS, Scope);
1771 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001772 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001773 }
1774
1775 // For any other statement scope will be implicit and as such will be
1776 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001777 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001778 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001779}
1780
1781/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1782/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001783LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001784 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001785 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1786 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001787 return Scope;
1788
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001789 for (auto *DI : DS->decls())
1790 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001791 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001792 return Scope;
1793}
1794
Matthias Gehre351c2182017-07-12 07:04:19 +00001795bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1796 // Check for const references bound to temporary. Set type to pointee.
1797 QualType QT = VD->getType();
1798 if (QT.getTypePtr()->isReferenceType()) {
1799 // Attempt to determine whether this declaration lifetime-extends a
1800 // temporary.
1801 //
1802 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1803 // temporaries, and a single declaration can extend multiple temporaries.
1804 // We should look at the storage duration on each nested
1805 // MaterializeTemporaryExpr instead.
1806
1807 const Expr *Init = VD->getInit();
1808 if (!Init)
1809 return true;
1810
1811 // Lifetime-extending a temporary.
1812 bool FoundMTE = false;
1813 QT = getReferenceInitTemporaryType(*Context, Init, &FoundMTE);
1814 if (!FoundMTE)
1815 return true;
1816 }
1817
1818 // Check for constant size array. Set type to array element type.
1819 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1820 if (AT->getSize() == 0)
1821 return true;
1822 QT = AT->getElementType();
1823 }
1824
1825 // Check if type is a C++ class with non-trivial destructor.
1826 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1827 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1828 return true;
1829}
1830
Marcin Swiderski5e415732010-09-30 23:05:00 +00001831/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1832/// create add scope for automatic objects and temporary objects bound to
1833/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001834LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001835 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001836 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1837 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001838 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1839 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001840 return Scope;
1841
1842 // Check if variable is local.
1843 switch (VD->getStorageClass()) {
1844 case SC_None:
1845 case SC_Auto:
1846 case SC_Register:
1847 break;
1848 default: return Scope;
1849 }
1850
Matthias Gehre351c2182017-07-12 07:04:19 +00001851 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001852 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001853 // Add the variable to scope
1854 Scope = createOrReuseLocalScope(Scope);
1855 Scope->addVar(VD);
1856 ScopePos = Scope->begin();
1857 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001858 return Scope;
1859 }
1860
1861 assert(BuildOpts.AddLifetime);
1862 // Add the variable to scope
1863 Scope = createOrReuseLocalScope(Scope);
1864 Scope->addVar(VD);
1865 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001866 return Scope;
1867}
1868
1869/// addLocalScopeAndDtors - For given statement add local scope for it and
1870/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001871void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001872 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001873 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001874 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001875}
1876
Marcin Swiderski321a7072010-09-30 22:54:37 +00001877/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1878/// variables with automatic storage duration to CFGBlock's elements vector.
1879/// Elements will be prepended to physical beginning of the vector which
1880/// happens to be logical end. Use blocks terminator as statement that specifies
1881/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001882/// FIXME: This mechanism for adding automatic destructors doesn't handle
1883/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001884void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001885 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001886 if (!BuildOpts.AddImplicitDtors)
1887 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001888 BumpVectorContext &C = cfg->getBumpVectorContext();
1889 CFGBlock::iterator InsertPos
1890 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1891 for (LocalScope::const_iterator I = B; I != E; ++I)
1892 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1893 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001894}
1895
Matthias Gehre351c2182017-07-12 07:04:19 +00001896/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1897/// variables with automatic storage duration to CFGBlock's elements vector.
1898/// Elements will be prepended to physical beginning of the vector which
1899/// happens to be logical end. Use blocks terminator as statement that specifies
1900/// where lifetime ends.
1901void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1902 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1903 if (!BuildOpts.AddLifetime)
1904 return;
1905 BumpVectorContext &C = cfg->getBumpVectorContext();
1906 CFGBlock::iterator InsertPos =
1907 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1908 for (LocalScope::const_iterator I = B; I != E; ++I)
1909 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1910}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001911
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001912/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
1913/// variables with automatic storage duration to CFGBlock's elements vector.
1914/// Elements will be prepended to physical beginning of the vector which
1915/// happens to be logical end. Use blocks terminator as statement that specifies
1916/// where scope ends.
1917const VarDecl *
1918CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
1919 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1920 if (!BuildOpts.AddScopes)
1921 return nullptr;
1922 BumpVectorContext &C = cfg->getBumpVectorContext();
1923 CFGBlock::iterator InsertPos =
1924 Blk->beginScopeEndInsert(Blk->end(), 1, C);
1925 LocalScope::const_iterator PlaceToInsert = B;
1926 for (LocalScope::const_iterator I = B; I != E; ++I)
1927 PlaceToInsert = I;
1928 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminator());
1929 return *PlaceToInsert;
1930}
1931
Ted Kremenek93668002009-07-17 22:18:43 +00001932/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001933/// blocks for ternary operators, &&, and ||. We also process "," and
1934/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001935CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001936 if (!S) {
1937 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001938 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001939 }
Jordy Rose17347372011-06-10 08:49:37 +00001940
1941 if (Expr *E = dyn_cast<Expr>(S))
1942 S = E->IgnoreParens();
1943
Ted Kremenek93668002009-07-17 22:18:43 +00001944 switch (S->getStmtClass()) {
1945 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001946 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001947
1948 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001949 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001950
John McCallc07a0c72011-02-17 10:25:35 +00001951 case Stmt::BinaryConditionalOperatorClass:
1952 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1953
Ted Kremenek93668002009-07-17 22:18:43 +00001954 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001955 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001956
Ted Kremenek93668002009-07-17 22:18:43 +00001957 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00001958 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001959
Ted Kremenek93668002009-07-17 22:18:43 +00001960 case Stmt::BreakStmtClass:
1961 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001962
Ted Kremenek93668002009-07-17 22:18:43 +00001963 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001964 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001965 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001966 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001967 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001968
Ted Kremenek93668002009-07-17 22:18:43 +00001969 case Stmt::CaseStmtClass:
1970 return VisitCaseStmt(cast<CaseStmt>(S));
1971
1972 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001973 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001974
Ted Kremenek93668002009-07-17 22:18:43 +00001975 case Stmt::CompoundStmtClass:
1976 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001977
Ted Kremenek93668002009-07-17 22:18:43 +00001978 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001979 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001980
Ted Kremenek93668002009-07-17 22:18:43 +00001981 case Stmt::ContinueStmtClass:
1982 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001983
Ted Kremenekb27378c2010-01-19 20:40:33 +00001984 case Stmt::CXXCatchStmtClass:
1985 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1986
John McCall5d413782010-12-06 08:20:24 +00001987 case Stmt::ExprWithCleanupsClass:
1988 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001989
Jordan Rosee5d53932012-08-23 18:10:53 +00001990 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001991 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001992 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1993 // called function's declaration, not by the caller. If we simply add
1994 // this expression to the CFG, we could end up with the same Expr
1995 // appearing multiple times.
1996 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001997 //
1998 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1999 // expression to be used in the same function (through aggregate
2000 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00002001 return VisitStmt(S, asc);
2002
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002003 case Stmt::CXXBindTemporaryExprClass:
2004 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
2005
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002006 case Stmt::CXXConstructExprClass:
2007 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
2008
Jordan Rosec9176072014-01-13 17:59:19 +00002009 case Stmt::CXXNewExprClass:
2010 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2011
Jordan Rosed2f40792013-09-03 17:00:57 +00002012 case Stmt::CXXDeleteExprClass:
2013 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2014
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002015 case Stmt::CXXFunctionalCastExprClass:
2016 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2017
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002018 case Stmt::CXXTemporaryObjectExprClass:
2019 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2020
Ted Kremenekb27378c2010-01-19 20:40:33 +00002021 case Stmt::CXXThrowExprClass:
2022 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002023
Ted Kremenekb27378c2010-01-19 20:40:33 +00002024 case Stmt::CXXTryStmtClass:
2025 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002026
Richard Smith02e85f32011-04-14 22:09:26 +00002027 case Stmt::CXXForRangeStmtClass:
2028 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2029
Ted Kremenek93668002009-07-17 22:18:43 +00002030 case Stmt::DeclStmtClass:
2031 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002032
Ted Kremenek93668002009-07-17 22:18:43 +00002033 case Stmt::DefaultStmtClass:
2034 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002035
Ted Kremenek93668002009-07-17 22:18:43 +00002036 case Stmt::DoStmtClass:
2037 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002038
Ted Kremenek93668002009-07-17 22:18:43 +00002039 case Stmt::ForStmtClass:
2040 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002041
Ted Kremenek93668002009-07-17 22:18:43 +00002042 case Stmt::GotoStmtClass:
2043 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002044
Ted Kremenek93668002009-07-17 22:18:43 +00002045 case Stmt::IfStmtClass:
2046 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002047
Ted Kremenek8219b822010-12-16 07:46:53 +00002048 case Stmt::ImplicitCastExprClass:
2049 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002050
Ted Kremenek93668002009-07-17 22:18:43 +00002051 case Stmt::IndirectGotoStmtClass:
2052 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002053
Ted Kremenek93668002009-07-17 22:18:43 +00002054 case Stmt::LabelStmtClass:
2055 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002056
Ted Kremenekda76a942012-04-12 20:34:52 +00002057 case Stmt::LambdaExprClass:
2058 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2059
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002060 case Stmt::MaterializeTemporaryExprClass:
2061 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2062 asc);
2063
Ted Kremenek5868ec62010-04-11 17:02:10 +00002064 case Stmt::MemberExprClass:
2065 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2066
Ted Kremenek04268232011-11-05 00:10:15 +00002067 case Stmt::NullStmtClass:
2068 return Block;
2069
Ted Kremenek93668002009-07-17 22:18:43 +00002070 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002071 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2072
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002073 case Stmt::ObjCAutoreleasePoolStmtClass:
2074 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2075
Ted Kremenek93668002009-07-17 22:18:43 +00002076 case Stmt::ObjCAtSynchronizedStmtClass:
2077 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002078
Ted Kremenek93668002009-07-17 22:18:43 +00002079 case Stmt::ObjCAtThrowStmtClass:
2080 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002081
Ted Kremenek93668002009-07-17 22:18:43 +00002082 case Stmt::ObjCAtTryStmtClass:
2083 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002084
Ted Kremenek93668002009-07-17 22:18:43 +00002085 case Stmt::ObjCForCollectionStmtClass:
2086 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002087
Ted Kremenek04268232011-11-05 00:10:15 +00002088 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002089 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002090
John McCallfe96e0b2011-11-06 09:01:30 +00002091 case Stmt::PseudoObjectExprClass:
2092 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2093
Ted Kremenek93668002009-07-17 22:18:43 +00002094 case Stmt::ReturnStmtClass:
2095 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002096
Nico Weber699670e2017-08-23 15:33:16 +00002097 case Stmt::SEHExceptStmtClass:
2098 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2099
2100 case Stmt::SEHFinallyStmtClass:
2101 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2102
2103 case Stmt::SEHLeaveStmtClass:
2104 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2105
2106 case Stmt::SEHTryStmtClass:
2107 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2108
Peter Collingbournee190dee2011-03-11 19:24:49 +00002109 case Stmt::UnaryExprOrTypeTraitExprClass:
2110 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2111 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002112
Ted Kremenek93668002009-07-17 22:18:43 +00002113 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002114 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002115
Ted Kremenek93668002009-07-17 22:18:43 +00002116 case Stmt::SwitchStmtClass:
2117 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002118
Zhanyong Wan6dace612010-11-22 08:45:56 +00002119 case Stmt::UnaryOperatorClass:
2120 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2121
Ted Kremenek93668002009-07-17 22:18:43 +00002122 case Stmt::WhileStmtClass:
2123 return VisitWhileStmt(cast<WhileStmt>(S));
2124 }
2125}
Mike Stump11289f42009-09-09 15:08:12 +00002126
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002127CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002128 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002129 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002130 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002131 }
Mike Stump11289f42009-09-09 15:08:12 +00002132
Ted Kremenek93668002009-07-17 22:18:43 +00002133 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002134}
Mike Stump31feda52009-07-17 01:31:16 +00002135
Ted Kremenek93668002009-07-17 22:18:43 +00002136/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002137CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2138 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002139
Ted Kremenek8ae67872013-02-05 22:00:19 +00002140 // Visit the children in their reverse order so that they appear in
2141 // left-to-right (natural) order in the CFG.
2142 reverse_children RChildren(S);
2143 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2144 I != E; ++I) {
2145 if (Stmt *Child = *I)
2146 if (CFGBlock *R = Visit(Child))
2147 B = R;
2148 }
2149 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002150}
Mike Stump11289f42009-09-09 15:08:12 +00002151
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002152CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2153 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002154 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002155
Ted Kremenek7c58d352011-03-10 01:14:11 +00002156 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002157 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002158 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002159 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002160
Ted Kremenek9aae5132007-08-23 21:42:29 +00002161 return Block;
2162}
Mike Stump11289f42009-09-09 15:08:12 +00002163
Zhanyong Wan6dace612010-11-22 08:45:56 +00002164CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002165 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002166 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002167 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002168 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002169 }
2170
Ted Kremenek8219b822010-12-16 07:46:53 +00002171 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002172}
2173
Ted Kremeneka16436f2012-07-14 05:04:06 +00002174CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2175 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2176 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002177
Ted Kremeneka16436f2012-07-14 05:04:06 +00002178 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002179 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002180
Craig Topper25542942014-05-20 04:30:07 +00002181 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2182 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002183}
2184
2185std::pair<CFGBlock*, CFGBlock*>
2186CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2187 Stmt *Term,
2188 CFGBlock *TrueBlock,
2189 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002190 // Introspect the RHS. If it is a nested logical operation, we recursively
2191 // build the CFG using this function. Otherwise, resort to default
2192 // CFG construction behavior.
2193 Expr *RHS = B->getRHS()->IgnoreParens();
2194 CFGBlock *RHSBlock, *ExitBlock;
2195
2196 do {
2197 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2198 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002199 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002200 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2201 break;
2202 }
2203
2204 // The RHS is not a nested logical operation. Don't push the terminator
2205 // down further, but instead visit RHS and construct the respective
2206 // pieces of the CFG, and link up the RHSBlock with the terminator
2207 // we have been provided.
2208 ExitBlock = RHSBlock = createBlock(false);
2209
Richard Trieu6a6af522017-01-04 00:46:30 +00002210 // Even though KnownVal is only used in the else branch of the next
2211 // conditional, tryEvaluateBool performs additional checking on the
2212 // Expr, so it should be called unconditionally.
2213 TryResult KnownVal = tryEvaluateBool(RHS);
2214 if (!KnownVal.isKnown())
2215 KnownVal = tryEvaluateBool(B);
2216
Ted Kremenekb50e7162012-07-14 05:04:10 +00002217 if (!Term) {
2218 assert(TrueBlock == FalseBlock);
2219 addSuccessor(RHSBlock, TrueBlock);
2220 }
2221 else {
2222 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002223 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2224 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002225 }
2226
2227 Block = RHSBlock;
2228 RHSBlock = addStmt(RHS);
2229 }
2230 while (false);
2231
2232 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002233 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002234
2235 // Generate the blocks for evaluating the LHS.
2236 Expr *LHS = B->getLHS()->IgnoreParens();
2237
2238 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2239 if (B_LHS->isLogicalOp()) {
2240 if (B->getOpcode() == BO_LOr)
2241 FalseBlock = RHSBlock;
2242 else
2243 TrueBlock = RHSBlock;
2244
2245 // For the LHS, treat 'B' as the terminator that we want to sink
2246 // into the nested branch. The RHS always gets the top-most
2247 // terminator.
2248 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2249 }
2250
2251 // Create the block evaluating the LHS.
2252 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002253 CFGBlock *LHSBlock = createBlock(false);
2254 LHSBlock->setTerminator(B);
2255
Ted Kremeneka16436f2012-07-14 05:04:06 +00002256 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002257 CFGBlock *EntryLHSBlock = addStmt(LHS);
2258
2259 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002260 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002261
2262 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002263 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002264
2265 // Now link the LHSBlock with RHSBlock.
2266 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002267 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2268 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002269 } else {
2270 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002271 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2272 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002273 }
2274
Ted Kremenekb50e7162012-07-14 05:04:10 +00002275 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002276}
2277
2278CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2279 AddStmtChoice asc) {
2280 // && or ||
2281 if (B->isLogicalOp())
2282 return VisitLogicalOperator(B);
2283
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002284 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002285 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002286 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002287 addStmt(B->getRHS());
2288 return addStmt(B->getLHS());
2289 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002290
2291 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002292 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002293 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002294 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002295 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002296 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002297 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002298 }
Mike Stump11289f42009-09-09 15:08:12 +00002299
Ted Kremenek7c58d352011-03-10 01:14:11 +00002300 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002301 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002302 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002303 }
2304
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002305 CFGBlock *RBlock = Visit(B->getRHS());
2306 CFGBlock *LBlock = Visit(B->getLHS());
2307 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2308 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2309 // return RBlock. Otherwise we'll incorrectly return NULL.
2310 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002311}
2312
Ted Kremeneke2499842012-04-12 20:03:44 +00002313CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002314 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002315 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002316 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002317 }
2318 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002319}
2320
Ted Kremenek93668002009-07-17 22:18:43 +00002321CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2322 // "break" is a control-flow statement. Thus we stop processing the current
2323 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002324 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002325 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002326
Ted Kremenek93668002009-07-17 22:18:43 +00002327 // Now create a new block that ends with the break statement.
2328 Block = createBlock(false);
2329 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002330
Ted Kremenek93668002009-07-17 22:18:43 +00002331 // If there is no target for the break, then we are looking at an incomplete
2332 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002333 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002334 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002335 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002336 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002337 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002338
Ted Kremenek9aae5132007-08-23 21:42:29 +00002339 return Block;
2340}
Mike Stump11289f42009-09-09 15:08:12 +00002341
Sebastian Redl31ad7542011-03-13 17:09:40 +00002342static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002343 QualType Ty = E->getType();
2344 if (Ty->isFunctionPointerType())
2345 Ty = Ty->getAs<PointerType>()->getPointeeType();
2346 else if (Ty->isBlockPointerType())
2347 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002348
Mike Stump04c68512010-01-21 15:20:48 +00002349 const FunctionType *FT = Ty->getAs<FunctionType>();
2350 if (FT) {
2351 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002352 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smithf623c962012-04-17 00:58:00 +00002353 Proto->isNothrow(Ctx))
Mike Stump04c68512010-01-21 15:20:48 +00002354 return false;
2355 }
2356 return true;
2357}
2358
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002359CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002360 // Compute the callee type.
2361 QualType calleeType = C->getCallee()->getType();
2362 if (calleeType == Context->BoundMemberTy) {
2363 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2364
2365 // We should only get a null bound type if processing a dependent
2366 // CFG. Recover by assuming nothing.
2367 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002368 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002369
John McCallc67067f2011-05-11 07:19:11 +00002370 // If this is a call to a no-return function, this stops the block here.
2371 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2372
Mike Stump04c68512010-01-21 15:20:48 +00002373 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002374
2375 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002376 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002377 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002378 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002379 }
2380
Jordan Rose5374c072013-08-19 16:27:28 +00002381 // If this is a call to a builtin function, it might not actually evaluate
2382 // its arguments. Don't add them to the CFG if this is the case.
2383 bool OmitArguments = false;
2384
Mike Stump92244b02010-01-19 22:00:14 +00002385 if (FunctionDecl *FD = C->getDirectCallee()) {
Nico Weber758fbac2018-02-13 21:31:47 +00002386 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002387 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002388 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002389 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00002390 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
2391 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002392 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002393
Sebastian Redl31ad7542011-03-13 17:09:40 +00002394 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002395 AddEHEdge = false;
2396
Jordan Rose5374c072013-08-19 16:27:28 +00002397 if (OmitArguments) {
2398 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2399 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2400 autoCreateBlock();
2401 appendStmt(Block, C);
2402 return Visit(C->getCallee());
2403 }
2404
2405 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002406 autoCreateBlock();
2407 appendCall(Block, C);
2408
2409 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002410 }
Mike Stump11289f42009-09-09 15:08:12 +00002411
Mike Stump92244b02010-01-19 22:00:14 +00002412 if (Block) {
2413 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002414 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002415 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002416 }
Mike Stump11289f42009-09-09 15:08:12 +00002417
Chandler Carrutha70991b2011-09-13 09:13:49 +00002418 if (NoReturn)
2419 Block = createNoReturnBlock();
2420 else
2421 Block = createBlock();
2422
Artem Dergachev1527dec2018-03-12 23:12:40 +00002423 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002424
Mike Stump04c68512010-01-21 15:20:48 +00002425 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002426 // Add exceptional edges.
2427 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002428 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002429 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002430 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002431 }
Mike Stump11289f42009-09-09 15:08:12 +00002432
Mike Stump8c5d7992009-07-25 21:26:53 +00002433 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002434}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002435
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002436CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2437 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002438 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002439 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002440 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002441 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002442
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002443 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002444 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002445 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002446 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002447 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002448 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002449
Ted Kremenek21822592009-07-17 18:20:32 +00002450 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002451 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002452 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002453 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002454 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002455
Ted Kremenek21822592009-07-17 18:20:32 +00002456 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002457 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002458 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002459 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2460 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002461 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002462 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002463}
Mike Stump11289f42009-09-09 15:08:12 +00002464
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002465CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002466 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002467 addLocalScopeForStmt(C);
2468
Matthias Gehre09a134e2015-11-14 00:36:50 +00002469 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002470 // If the body ends with a ReturnStmt, the dtors will be added in
2471 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002472 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002473 }
2474
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002475 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002476
2477 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2478 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002479 // If we hit a segment of code just containing ';' (NullStmts), we can
2480 // get a null block back. In such cases, just use the LastBlock
2481 if (CFGBlock *newBlock = addStmt(*I))
2482 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002483
Ted Kremenekce499c22009-08-27 23:16:26 +00002484 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002485 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002486 }
Mike Stump92244b02010-01-19 22:00:14 +00002487
Ted Kremenek93668002009-07-17 22:18:43 +00002488 return LastBlock;
2489}
Mike Stump11289f42009-09-09 15:08:12 +00002490
John McCallc07a0c72011-02-17 10:25:35 +00002491CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002492 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002493 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002494 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002495
Ted Kremenek51d40b02009-07-17 18:15:54 +00002496 // Create the confluence block that will "merge" the results of the ternary
2497 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002498 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002499 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002500 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002501 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002502
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002503 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002504
Ted Kremenek51d40b02009-07-17 18:15:54 +00002505 // Create a block for the LHS expression if there is an LHS expression. A
2506 // GCC extension allows LHS to be NULL, causing the condition to be the
2507 // value that is returned instead.
2508 // e.g: x ?: y is shorthand for: x ? x : y;
2509 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002510 Block = nullptr;
2511 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002512 const Expr *trueExpr = C->getTrueExpr();
2513 if (trueExpr != opaqueValue) {
2514 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002515 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002516 return nullptr;
2517 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002518 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002519 else
2520 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002521
Ted Kremenek51d40b02009-07-17 18:15:54 +00002522 // Create the block for the RHS expression.
2523 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002524 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002525 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002526 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002527
Richard Smithf676e452012-07-24 21:02:14 +00002528 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2529 if (BinaryOperator *Cond =
2530 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2531 if (Cond->isLogicalOp())
2532 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2533
Ted Kremenek51d40b02009-07-17 18:15:54 +00002534 // Create the block that will contain the condition.
2535 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002536
Mike Stump773582d2009-07-23 23:25:26 +00002537 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002538 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002539 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2540 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002541 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002542 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002543
Ted Kremenekd8138012011-02-24 03:09:15 +00002544 if (opaqueValue) {
2545 // Run the condition expression if it's not trivially expressed in
2546 // terms of the opaque value (or if there is no opaque value).
2547 if (condExpr != opaqueValue)
2548 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002549
Ted Kremenekd8138012011-02-24 03:09:15 +00002550 // Before that, run the common subexpression if there was one.
2551 // At least one of this or the above will be run.
2552 return addStmt(BCO->getCommon());
2553 }
2554
2555 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002556}
2557
Ted Kremenek93668002009-07-17 22:18:43 +00002558CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002559 // Check if the Decl is for an __label__. If so, elide it from the
2560 // CFG entirely.
2561 if (isa<LabelDecl>(*DS->decl_begin()))
2562 return Block;
2563
Ted Kremenek3a601142011-05-24 20:41:31 +00002564 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002565 if (DS->isSingleDecl())
2566 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002567
Craig Topper25542942014-05-20 04:30:07 +00002568 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002569
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002570 // Build an individual DeclStmt for each decl.
2571 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2572 E = DS->decl_rend();
2573 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00002574 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
Benjamin Kramerc3f89252016-10-20 14:27:22 +00002575 unsigned A = alignof(DeclStmt) < 8 ? 8 : alignof(DeclStmt);
Mike Stump11289f42009-09-09 15:08:12 +00002576
Ted Kremenek93668002009-07-17 22:18:43 +00002577 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2578 // automatically freed with the CFG.
2579 DeclGroupRef DG(*I);
2580 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00002581 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00002582 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002583 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002584
Ted Kremenek93668002009-07-17 22:18:43 +00002585 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002586 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002587 }
Mike Stump11289f42009-09-09 15:08:12 +00002588
2589 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002590}
Mike Stump11289f42009-09-09 15:08:12 +00002591
Ted Kremenek93668002009-07-17 22:18:43 +00002592/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002593/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002594CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002595 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002596 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002597
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002598 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002599 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2600 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002601 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002602 }
Mike Stump11289f42009-09-09 15:08:12 +00002603
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002604 bool HasTemporaries = false;
2605
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002606 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002607 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002608
2609 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2610 // For static variables, we need to create a branch to track
2611 // whether or not they are initialized.
2612 if (Block) {
2613 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002614 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002615 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002616 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002617 }
2618 blockAfterStaticInit = Succ;
2619 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002620
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002621 // Destructors of temporaries in initialization expression should be called
2622 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002623 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002624 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002625 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002626
Jordan Rose6d671cc2012-09-05 22:55:23 +00002627 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002628 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002629 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002630 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2631 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002632 }
2633 }
2634
2635 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002636 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002637
Artem Dergachev783a4572018-02-23 22:20:39 +00002638 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002639 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002640 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002641
Ted Kremenek213d0532012-03-22 05:57:43 +00002642 // Keep track of the last non-null block, as 'Block' can be nulled out
2643 // if the initializer expression is something like a 'while' in a
2644 // statement-expression.
2645 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002646
Ted Kremenek93668002009-07-17 22:18:43 +00002647 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002648 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002649 // For expression with temporaries go directly to subexpression to omit
2650 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002651 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2652 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2653 LastBlock = newBlock;
2654 }
2655 else {
2656 if (CFGBlock *newBlock = Visit(Init))
2657 LastBlock = newBlock;
2658 }
Ted Kremenek93668002009-07-17 22:18:43 +00002659 }
Mike Stump11289f42009-09-09 15:08:12 +00002660
Ted Kremenek93668002009-07-17 22:18:43 +00002661 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002662 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002663 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002664 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2665 LastBlock = newBlock;
2666 }
Mike Stump11289f42009-09-09 15:08:12 +00002667
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002668 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2669
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002670 // Remove variable from local scope.
2671 if (ScopePos && VD == *ScopePos)
2672 ++ScopePos;
2673
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002674 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002675 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002676 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002677 Block = createBlock(false);
2678 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002679 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002680 addSuccessor(Block, B);
2681 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002682 }
2683
2684 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002685}
2686
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002687CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002688 // We may see an if statement in the middle of a basic block, or it may be the
2689 // first statement we are processing. In either case, we create a new basic
2690 // block. First, we create the blocks for the then...else statements, and
2691 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002692 // middle of a block, we stop processing that block. That block is then the
2693 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002694
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002695 // Save local scope position because in case of condition variable ScopePos
2696 // won't be restored when traversing AST.
2697 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2698
Richard Smitha547eb22016-07-14 00:11:03 +00002699 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002700 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002701 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002702
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002703 // Create local scope for possible condition variable.
2704 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002705 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002706 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002707
Matthias Gehre351c2182017-07-12 07:04:19 +00002708 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002709
Chris Lattner57540c52011-04-15 05:22:18 +00002710 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002711 // block.
2712 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002713 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002714 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002715 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002716 }
Mike Stump31feda52009-07-17 01:31:16 +00002717
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002718 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002719 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002720
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002721 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002722 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002723
Ted Kremenek9aae5132007-08-23 21:42:29 +00002724 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002725 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002726 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002727
2728 // If branch is not a compound statement create implicit scope
2729 // and add destructors.
2730 if (!isa<CompoundStmt>(Else))
2731 addLocalScopeAndDtors(Else);
2732
Ted Kremenek93668002009-07-17 22:18:43 +00002733 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002734
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002735 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2736 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002737 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002738 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002739 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002740 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002741 }
Mike Stump31feda52009-07-17 01:31:16 +00002742
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002743 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002744 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002745 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002746 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002747 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002748 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002749 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002750
2751 // If branch is not a compound statement create implicit scope
2752 // and add destructors.
2753 if (!isa<CompoundStmt>(Then))
2754 addLocalScopeAndDtors(Then);
2755
Ted Kremenek93668002009-07-17 22:18:43 +00002756 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002757
Ted Kremenek1b379512009-04-01 03:52:47 +00002758 if (!ThenBlock) {
2759 // We can reach here if the "then" body has all NullStmts.
2760 // Create an empty block so we can distinguish between true and false
2761 // branches in path-sensitive analyses.
2762 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002763 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002764 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002765 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002766 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002767 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002768 }
2769
Ted Kremenekb50e7162012-07-14 05:04:10 +00002770 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2771 // having these handle the actual control-flow jump. Note that
2772 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2773 // we resort to the old control-flow behavior. This special handling
2774 // removes infeasible paths from the control-flow graph by having the
2775 // control-flow transfer of '&&' or '||' go directly into the then/else
2776 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002777 BinaryOperator *Cond =
2778 I->getConditionVariable()
2779 ? nullptr
2780 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2781 CFGBlock *LastBlock;
2782 if (Cond && Cond->isLogicalOp())
2783 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2784 else {
2785 // Now create a new block containing the if statement.
2786 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002787
Richard Smith509bbd12017-01-13 22:16:41 +00002788 // Set the terminator of the new block to the If statement.
2789 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002790
Richard Smith509bbd12017-01-13 22:16:41 +00002791 // See if this is a known constant.
2792 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002793
Richard Smith509bbd12017-01-13 22:16:41 +00002794 // Add the successors. If we know that specific branches are
2795 // unreachable, inform addSuccessor() of that knowledge.
2796 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2797 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002798
Richard Smith509bbd12017-01-13 22:16:41 +00002799 // Add the condition as the last statement in the new block. This may
2800 // create new blocks as the condition may contain control-flow. Any newly
2801 // created blocks will be pointed to be "Block".
2802 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002803
Richard Smith509bbd12017-01-13 22:16:41 +00002804 // If the IfStmt contains a condition variable, add it and its
2805 // initializer to the CFG.
2806 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2807 autoCreateBlock();
2808 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2809 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002810 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002811
Richard Smitha547eb22016-07-14 00:11:03 +00002812 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2813 if (Stmt *Init = I->getInit()) {
2814 autoCreateBlock();
2815 LastBlock = addStmt(Init);
2816 }
2817
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002818 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002819}
Mike Stump31feda52009-07-17 01:31:16 +00002820
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002821CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002822 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002823 //
Mike Stump31feda52009-07-17 01:31:16 +00002824 // NOTE: If a "return" appears in the middle of a block, this means that the
2825 // code afterwards is DEAD (unreachable). We still keep a basic block
2826 // for that code; a simple "mark-and-sweep" from the entry block will be
2827 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002828
2829 // Create the new block.
2830 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002831
Matthias Gehre351c2182017-07-12 07:04:19 +00002832 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002833
Artem Dergachev783a4572018-02-23 22:20:39 +00002834 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002835 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
Artem Dergachev783a4572018-02-23 22:20:39 +00002836 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002837
Pavel Labath921e7652013-09-06 08:12:48 +00002838 // If the one of the destructors does not return, we already have the Exit
2839 // block as a successor.
2840 if (!Block->hasNoReturnElement())
2841 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002842
2843 // Add the return statement to the block. This may create new blocks if R
2844 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002845 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002846}
2847
Nico Weber699670e2017-08-23 15:33:16 +00002848CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2849 // SEHExceptStmt are treated like labels, so they are the first statement in a
2850 // block.
2851
2852 // Save local scope position because in case of exception variable ScopePos
2853 // won't be restored when traversing AST.
2854 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2855
2856 addStmt(ES->getBlock());
2857 CFGBlock *SEHExceptBlock = Block;
2858 if (!SEHExceptBlock)
2859 SEHExceptBlock = createBlock();
2860
2861 appendStmt(SEHExceptBlock, ES);
2862
2863 // Also add the SEHExceptBlock as a label, like with regular labels.
2864 SEHExceptBlock->setLabel(ES);
2865
2866 // Bail out if the CFG is bad.
2867 if (badCFG)
2868 return nullptr;
2869
2870 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2871 Block = nullptr;
2872
2873 return SEHExceptBlock;
2874}
2875
2876CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2877 return VisitCompoundStmt(FS->getBlock());
2878}
2879
2880CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2881 // "__leave" is a control-flow statement. Thus we stop processing the current
2882 // block.
2883 if (badCFG)
2884 return nullptr;
2885
2886 // Now create a new block that ends with the __leave statement.
2887 Block = createBlock(false);
2888 Block->setTerminator(LS);
2889
2890 // If there is no target for the __leave, then we are looking at an incomplete
2891 // AST. This means that the CFG cannot be constructed.
2892 if (SEHLeaveJumpTarget.block) {
2893 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2894 addSuccessor(Block, SEHLeaveJumpTarget.block);
2895 } else
2896 badCFG = true;
2897
2898 return Block;
2899}
2900
2901CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2902 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2903 // processing the current block.
2904 CFGBlock *SEHTrySuccessor = nullptr;
2905
2906 if (Block) {
2907 if (badCFG)
2908 return nullptr;
2909 SEHTrySuccessor = Block;
2910 } else SEHTrySuccessor = Succ;
2911
2912 // FIXME: Implement __finally support.
2913 if (Terminator->getFinallyHandler())
2914 return NYS();
2915
2916 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2917
2918 // Create a new block that will contain the __try statement.
2919 CFGBlock *NewTryTerminatedBlock = createBlock(false);
2920
2921 // Add the terminator in the __try block.
2922 NewTryTerminatedBlock->setTerminator(Terminator);
2923
2924 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
2925 // The code after the try is the implicit successor if there's an __except.
2926 Succ = SEHTrySuccessor;
2927 Block = nullptr;
2928 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
2929 if (!ExceptBlock)
2930 return nullptr;
2931 // Add this block to the list of successors for the block with the try
2932 // statement.
2933 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
2934 }
2935 if (PrevSEHTryTerminatedBlock)
2936 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
2937 else
2938 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
2939
2940 // The code after the try is the implicit successor.
2941 Succ = SEHTrySuccessor;
2942
2943 // Save the current "__try" context.
2944 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
2945 NewTryTerminatedBlock);
2946 cfg->addTryDispatchBlock(TryTerminatedBlock);
2947
2948 // Save the current value for the __leave target.
2949 // All __leaves should go to the code following the __try
2950 // (FIXME: or if the __try has a __finally, to the __finally.)
2951 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
2952 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
2953
2954 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
2955 Block = nullptr;
2956 return addStmt(Terminator->getTryBlock());
2957}
2958
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002959CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002960 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002961 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002962 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002963
Ted Kremenek93668002009-07-17 22:18:43 +00002964 if (!LabelBlock) // This can happen when the body is empty, i.e.
2965 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002966
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002967 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2968 "label already in map");
2969 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002970
2971 // Labels partition blocks, so this is the end of the basic block we were
2972 // processing (L is the block's label). Because this is label (and we have
2973 // already processed the substatement) there is no extra control-flow to worry
2974 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002975 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002976 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002977 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002978
2979 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002980 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002981
Ted Kremenek9aae5132007-08-23 21:42:29 +00002982 // This block is now the implicit successor of other blocks.
2983 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002984
Ted Kremenek9aae5132007-08-23 21:42:29 +00002985 return LabelBlock;
2986}
2987
Devin Coughlinb6029b72015-11-25 22:35:37 +00002988CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
2989 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2990 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
2991 if (Expr *CopyExpr = CI.getCopyExpr()) {
2992 CFGBlock *Tmp = Visit(CopyExpr);
2993 if (Tmp)
2994 LastBlock = Tmp;
2995 }
2996 }
2997 return LastBlock;
2998}
2999
Ted Kremenekda76a942012-04-12 20:34:52 +00003000CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
3001 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3002 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
3003 et = E->capture_init_end(); it != et; ++it) {
3004 if (Expr *Init = *it) {
3005 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00003006 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00003007 LastBlock = Tmp;
3008 }
3009 }
3010 return LastBlock;
3011}
3012
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003013CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003014 // Goto is a control-flow statement. Thus we stop processing the current
3015 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003016
Ted Kremenek9aae5132007-08-23 21:42:29 +00003017 Block = createBlock(false);
3018 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003019
3020 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003021 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003022
Ted Kremenek9aae5132007-08-23 21:42:29 +00003023 if (I == LabelMap.end())
3024 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003025 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3026 else {
3027 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003028 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003029 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003030 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003031
Mike Stump31feda52009-07-17 01:31:16 +00003032 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003033}
3034
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003035CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003036 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003037
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003038 // Save local scope position because in case of condition variable ScopePos
3039 // won't be restored when traversing AST.
3040 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3041
3042 // Create local scope for init statement and possible condition variable.
3043 // Add destructor for init statement and condition variable.
3044 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003045 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003046 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003047 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3048
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003049 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003050 addLocalScopeForVarDecl(VD);
3051 LocalScope::const_iterator ContinueScopePos = ScopePos;
3052
Matthias Gehre351c2182017-07-12 07:04:19 +00003053 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003054
Peter Szecsi999a25f2017-08-19 11:19:16 +00003055 addLoopExit(F);
3056
Mike Stump014b3ea2009-07-21 01:12:51 +00003057 // "for" is a control-flow statement. Thus we stop processing the current
3058 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003059 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003060 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003061 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003062 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003063 } else
3064 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003065
Ted Kremenek304a9532010-05-21 20:30:15 +00003066 // Save the current value for the break targets.
3067 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003068 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003069 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003070
Craig Topper25542942014-05-20 04:30:07 +00003071 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003072
Ted Kremenek9aae5132007-08-23 21:42:29 +00003073 // Now create the loop body.
3074 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003075 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003076
Ted Kremenekb50e7162012-07-14 05:04:10 +00003077 // Save the current values for Block, Succ, continue and break targets.
3078 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3079 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003080
Ted Kremenekb50e7162012-07-14 05:04:10 +00003081 // Create an empty block to represent the transition block for looping back
3082 // to the head of the loop. If we have increment code, it will
3083 // go in this block as well.
3084 Block = Succ = TransitionBlock = createBlock(false);
3085 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003086
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003087 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003088 // Generate increment code in its own basic block. This is the target of
3089 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003090 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003091 }
Mike Stump31feda52009-07-17 01:31:16 +00003092
Ted Kremenek902393b2009-04-28 00:51:56 +00003093 // Finish up the increment (or empty) block if it hasn't been already.
3094 if (Block) {
3095 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003096 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003097 return nullptr;
3098 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003099 }
Mike Stump31feda52009-07-17 01:31:16 +00003100
Ted Kremenekb50e7162012-07-14 05:04:10 +00003101 // The starting block for the loop increment is the block that should
3102 // represent the 'loop target' for looping back to the start of the loop.
3103 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3104 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003105
Ted Kremenekb50e7162012-07-14 05:04:10 +00003106 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003107 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003108
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003109 // If body is not a compound statement create implicit scope
3110 // and add destructors.
3111 if (!isa<CompoundStmt>(F->getBody()))
3112 addLocalScopeAndDtors(F->getBody());
3113
Mike Stump31feda52009-07-17 01:31:16 +00003114 // Now populate the body block, and in the process create new blocks as we
3115 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003116 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003117
Ted Kremenekb50e7162012-07-14 05:04:10 +00003118 if (!BodyBlock) {
3119 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3120 // Use the continue jump target as the proxy for the body.
3121 BodyBlock = ContinueJumpTarget.block;
3122 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003123 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003124 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003125 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00003126
3127 // Because of short-circuit evaluation, the condition of the loop can span
3128 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3129 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003130 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003131
Ted Kremenekb50e7162012-07-14 05:04:10 +00003132 do {
3133 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003134 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003135
3136 // Specially handle logical operators, which have a slightly
3137 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003138 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003139 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003140 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003141 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003142 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3143 break;
3144 }
3145
3146 // The default case when not handling logical operators.
3147 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3148 ExitConditionBlock->setTerminator(F);
3149
3150 // See if this is a known constant.
3151 TryResult KnownVal(true);
3152
3153 if (C) {
3154 // Now add the actual condition to the condition block.
3155 // Because the condition itself may contain control-flow, new blocks may
3156 // be created. Thus we update "Succ" after adding the condition.
3157 Block = ExitConditionBlock;
3158 EntryConditionBlock = addStmt(C);
3159
3160 // If this block contains a condition variable, add both the condition
3161 // variable and initializer to the CFG.
3162 if (VarDecl *VD = F->getConditionVariable()) {
3163 if (Expr *Init = VD->getInit()) {
3164 autoCreateBlock();
3165 appendStmt(Block, F->getConditionVariableDeclStmt());
3166 EntryConditionBlock = addStmt(Init);
3167 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003168 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003169 }
3170 }
3171
3172 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003173 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003174
3175 KnownVal = tryEvaluateBool(C);
3176 }
3177
3178 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003179 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003180 // Link up the condition block with the code that follows the loop. (the
3181 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003182 addSuccessor(ExitConditionBlock,
3183 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003184 } while (false);
3185
3186 // Link up the loop-back block to the entry condition block.
3187 addSuccessor(TransitionBlock, EntryConditionBlock);
3188
3189 // The condition block is the implicit successor for any code above the loop.
3190 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003191
Ted Kremenek9aae5132007-08-23 21:42:29 +00003192 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003193 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003194 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003195 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3196 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003197 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003198 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003199 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003200
3201 // There is no loop initialization. We are thus basically a while loop.
3202 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003203 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003204 Succ = EntryConditionBlock;
3205 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003206}
3207
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003208CFGBlock *
3209CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3210 AddStmtChoice asc) {
3211 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003212 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003213 MTE->getTemporary());
3214
3215 return VisitStmt(MTE, asc);
3216}
3217
Ted Kremenek5868ec62010-04-11 17:02:10 +00003218CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003219 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003220 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003221 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003222 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003223 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003224}
3225
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003226CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003227 // Objective-C fast enumeration 'for' statements:
3228 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3229 //
3230 // for ( Type newVariable in collection_expression ) { statements }
3231 //
3232 // becomes:
3233 //
3234 // prologue:
3235 // 1. collection_expression
3236 // T. jump to loop_entry
3237 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003238 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003239 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3240 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3241 // TB:
3242 // statements
3243 // T. jump to loop_entry
3244 // FB:
3245 // what comes after
3246 //
3247 // and
3248 //
3249 // Type existingItem;
3250 // for ( existingItem in expression ) { statements }
3251 //
3252 // becomes:
3253 //
Mike Stump31feda52009-07-17 01:31:16 +00003254 // the same with newVariable replaced with existingItem; the binding works
3255 // the same except that for one ObjCForCollectionStmt::getElement() returns
3256 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003257
Craig Topper25542942014-05-20 04:30:07 +00003258 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003259
Ted Kremenek9d56e642008-11-11 17:10:00 +00003260 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003261 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003262 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003263 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003264 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003265 } else
3266 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003267
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003268 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003269 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003270
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003271 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003272 ExitConditionBlock->setTerminator(S);
3273
3274 // The last statement in the block should be the ObjCForCollectionStmt, which
3275 // performs the actual binding to 'element' and determines if there are any
3276 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003277 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003278 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003279
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003280 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003281 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003282 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003283 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3284 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003285 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003286 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003287 return nullptr;
3288 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003289 }
Mike Stump31feda52009-07-17 01:31:16 +00003290
3291 // The condition block is the implicit successor for the loop body as well as
3292 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003293 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003294
Ted Kremenek9d56e642008-11-11 17:10:00 +00003295 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003296 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003297 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003298 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003299 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003300 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003301
Anna Zaks56b49752013-06-22 00:23:20 +00003302 // Add an intermediate block between the BodyBlock and the
3303 // EntryConditionBlock to represent the "loop back" transition, for looping
3304 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003305 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003306 Succ = LoopBackBlock = createBlock();
3307 LoopBackBlock->setLoopTarget(S);
3308
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003309 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003310 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003311
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003312 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003313
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003314 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003315 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003316 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003317 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003318 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003319 }
Mike Stump31feda52009-07-17 01:31:16 +00003320
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003321 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003322 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003323 }
Mike Stump31feda52009-07-17 01:31:16 +00003324
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003325 // Link up the condition block with the code that follows the loop.
3326 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003327 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003328
Ted Kremenek9d56e642008-11-11 17:10:00 +00003329 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003330 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003331 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003332}
3333
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003334CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3335 // Inline the body.
3336 return addStmt(S->getSubStmt());
3337 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3338}
3339
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003340CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003341 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003342
Ted Kremenek49805452009-05-02 01:49:13 +00003343 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003344 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003345
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003346 // The sync body starts its own basic block. This makes it a little easier
3347 // for diagnostic clients.
3348 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003349 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003350 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003351
Craig Topper25542942014-05-20 04:30:07 +00003352 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003353 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003354 }
Mike Stump31feda52009-07-17 01:31:16 +00003355
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003356 // Add the @synchronized to the CFG.
3357 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003358 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003359
Ted Kremenek49805452009-05-02 01:49:13 +00003360 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003361 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003362}
Mike Stump31feda52009-07-17 01:31:16 +00003363
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003364CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003365 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003366 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003367}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003368
John McCallfe96e0b2011-11-06 09:01:30 +00003369CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3370 autoCreateBlock();
3371
3372 // Add the PseudoObject as the last thing.
3373 appendStmt(Block, E);
3374
3375 CFGBlock *lastBlock = Block;
3376
3377 // Before that, evaluate all of the semantics in order. In
3378 // CFG-land, that means appending them in reverse order.
3379 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3380 Expr *Semantic = E->getSemanticExpr(--i);
3381
3382 // If the semantic is an opaque value, we're being asked to bind
3383 // it to its source expression.
3384 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3385 Semantic = OVE->getSourceExpr();
3386
3387 if (CFGBlock *B = Visit(Semantic))
3388 lastBlock = B;
3389 }
3390
3391 return lastBlock;
3392}
3393
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003394CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003395 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003396
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003397 // Save local scope position because in case of condition variable ScopePos
3398 // won't be restored when traversing AST.
3399 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3400
3401 // Create local scope for possible condition variable.
3402 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003403 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003404 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003405 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003406 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003407 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003408 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003409
Mike Stump014b3ea2009-07-21 01:12:51 +00003410 // "while" is a control-flow statement. Thus we stop processing the current
3411 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003412 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003413 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003414 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003415 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003416 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003417 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003418 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003419 }
Mike Stump31feda52009-07-17 01:31:16 +00003420
Craig Topper25542942014-05-20 04:30:07 +00003421 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003422
Ted Kremenek9aae5132007-08-23 21:42:29 +00003423 // Process the loop body.
3424 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003425 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003426
Ted Kremenekb50e7162012-07-14 05:04:10 +00003427 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003428 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3429 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003430 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003431
Mike Stump31feda52009-07-17 01:31:16 +00003432 // Create an empty block to represent the transition block for looping back
3433 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003434 Succ = TransitionBlock = createBlock(false);
3435 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003436 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003437
Ted Kremenek9aae5132007-08-23 21:42:29 +00003438 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003439 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003440
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003441 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003442 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003443
3444 // If body is not a compound statement create implicit scope
3445 // and add destructors.
3446 if (!isa<CompoundStmt>(W->getBody()))
3447 addLocalScopeAndDtors(W->getBody());
3448
Ted Kremenek9aae5132007-08-23 21:42:29 +00003449 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003450 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003451
Ted Kremeneke9610502007-08-30 18:39:40 +00003452 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003453 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003454 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003455 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003456 }
3457
3458 // Because of short-circuit evaluation, the condition of the loop can span
3459 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3460 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003461 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003462
3463 do {
3464 Expr *C = W->getCond();
3465
3466 // Specially handle logical operators, which have a slightly
3467 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003468 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003469 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003470 std::tie(EntryConditionBlock, ExitConditionBlock) =
3471 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003472 break;
3473 }
3474
3475 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003476 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003477 ExitConditionBlock->setTerminator(W);
3478
3479 // Now add the actual condition to the condition block.
3480 // Because the condition itself may contain control-flow, new blocks may
3481 // be created. Thus we update "Succ" after adding the condition.
3482 Block = ExitConditionBlock;
3483 Block = EntryConditionBlock = addStmt(C);
3484
3485 // If this block contains a condition variable, add both the condition
3486 // variable and initializer to the CFG.
3487 if (VarDecl *VD = W->getConditionVariable()) {
3488 if (Expr *Init = VD->getInit()) {
3489 autoCreateBlock();
3490 appendStmt(Block, W->getConditionVariableDeclStmt());
3491 EntryConditionBlock = addStmt(Init);
3492 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003493 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003494 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003495 }
Mike Stump31feda52009-07-17 01:31:16 +00003496
Ted Kremenekb50e7162012-07-14 05:04:10 +00003497 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003498 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003499
3500 // See if this is a known constant.
3501 const TryResult& KnownVal = tryEvaluateBool(C);
3502
Ted Kremenek30754282009-07-24 04:47:11 +00003503 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003504 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003505 // Link up the condition block with the code that follows the loop. (the
3506 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003507 addSuccessor(ExitConditionBlock,
3508 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003509 } while(false);
3510
3511 // Link up the loop-back block to the entry condition block.
3512 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003513
3514 // There can be no more statements in the condition block since we loop back
3515 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003516 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003517
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003518 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003519 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003520 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003521}
Mike Stump11289f42009-09-09 15:08:12 +00003522
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003523CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003524 // FIXME: For now we pretend that @catch and the code it contains does not
3525 // exit.
3526 return Block;
3527}
Mike Stump31feda52009-07-17 01:31:16 +00003528
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003529CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003530 // FIXME: This isn't complete. We basically treat @throw like a return
3531 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003532
Ted Kremenek0868eea2009-09-24 18:45:41 +00003533 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003534 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003535 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003536
Ted Kremenek93041ba2008-12-09 20:20:09 +00003537 // Create the new block.
3538 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003539
Ted Kremenek93041ba2008-12-09 20:20:09 +00003540 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003541 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003542
3543 // Add the statement to the block. This may create new blocks if S contains
3544 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003545 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003546}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003547
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003548CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003549 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003550 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003551 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003552
3553 // Create the new block.
3554 Block = createBlock(false);
3555
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003556 if (TryTerminatedBlock)
3557 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003558 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003559 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003560 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003561 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003562
3563 // Add the statement to the block. This may create new blocks if S contains
3564 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003565 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003566}
3567
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003568CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003569 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003570
Peter Szecsi999a25f2017-08-19 11:19:16 +00003571 addLoopExit(D);
3572
Mike Stump8d50b6a2009-07-21 01:27:50 +00003573 // "do...while" is a control-flow statement. Thus we stop processing the
3574 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003575 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003576 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003577 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003578 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003579 } else
3580 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003581
3582 // Because of short-circuit evaluation, the condition of the loop can span
3583 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3584 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003585 CFGBlock *ExitConditionBlock = createBlock(false);
3586 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003587
Ted Kremenek81e14852007-08-27 19:46:09 +00003588 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003589 ExitConditionBlock->setTerminator(D);
3590
3591 // Now add the actual condition to the condition block. Because the condition
3592 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003593 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003594 Block = ExitConditionBlock;
3595 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003596 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003597 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003598 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003599 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003600 }
Mike Stump31feda52009-07-17 01:31:16 +00003601
Ted Kremeneka1523a32008-02-27 07:20:00 +00003602 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003603 Succ = EntryConditionBlock;
3604
Mike Stump773582d2009-07-23 23:25:26 +00003605 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003606 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003607
Ted Kremenek9aae5132007-08-23 21:42:29 +00003608 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003609 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003610 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003611 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003612
Ted Kremenek9aae5132007-08-23 21:42:29 +00003613 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003614 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3615 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3616 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003617
Ted Kremenek9aae5132007-08-23 21:42:29 +00003618 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003619 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003620
Ted Kremenek9aae5132007-08-23 21:42:29 +00003621 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003622 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003623
Ted Kremenek9aae5132007-08-23 21:42:29 +00003624 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003625 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003626
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003627 // If body is not a compound statement create implicit scope
3628 // and add destructors.
3629 if (!isa<CompoundStmt>(D->getBody()))
3630 addLocalScopeAndDtors(D->getBody());
3631
Ted Kremenek9aae5132007-08-23 21:42:29 +00003632 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003633 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003634
Ted Kremeneke9610502007-08-30 18:39:40 +00003635 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003636 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003637 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003638 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003639 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003640 }
Mike Stump31feda52009-07-17 01:31:16 +00003641
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003642 // Add an intermediate block between the BodyBlock and the
3643 // ExitConditionBlock to represent the "loop back" transition. Create an
3644 // empty block to represent the transition block for looping back to the
3645 // head of the loop.
3646 // FIXME: Can we do this more efficiently without adding another block?
3647 Block = nullptr;
3648 Succ = BodyBlock;
3649 CFGBlock *LoopBackBlock = createBlock();
3650 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003651
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003652 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003653 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003654 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003655 else
Craig Topper25542942014-05-20 04:30:07 +00003656 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003657 }
Mike Stump31feda52009-07-17 01:31:16 +00003658
Ted Kremenek30754282009-07-24 04:47:11 +00003659 // Link up the condition block with the code that follows the loop.
3660 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003661 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003662
3663 // There can be no more statements in the body block(s) since we loop back to
3664 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003665 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003666
Ted Kremenek9aae5132007-08-23 21:42:29 +00003667 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003668 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003669 return BodyBlock;
3670}
3671
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003672CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003673 // "continue" is a control-flow statement. Thus we stop processing the
3674 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003675 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003676 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003677
Ted Kremenek9aae5132007-08-23 21:42:29 +00003678 // Now create a new block that ends with the continue statement.
3679 Block = createBlock(false);
3680 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003681
Ted Kremenek9aae5132007-08-23 21:42:29 +00003682 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003683 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003684 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003685 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003686 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003687 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003688 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003689
Ted Kremenek9aae5132007-08-23 21:42:29 +00003690 return Block;
3691}
Mike Stump11289f42009-09-09 15:08:12 +00003692
Peter Collingbournee190dee2011-03-11 19:24:49 +00003693CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3694 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003695 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003696 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003697 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003698 }
Mike Stump11289f42009-09-09 15:08:12 +00003699
Ted Kremenek93668002009-07-17 22:18:43 +00003700 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003701 CFGBlock *lastBlock = Block;
3702
Ted Kremenek93668002009-07-17 22:18:43 +00003703 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003704 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003705 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003706 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003707 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003708 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003709}
Mike Stump11289f42009-09-09 15:08:12 +00003710
Ted Kremenek93668002009-07-17 22:18:43 +00003711/// VisitStmtExpr - Utility method to handle (nested) statement
3712/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003713CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003714 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003715 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003716 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003717 }
Ted Kremenek93668002009-07-17 22:18:43 +00003718 return VisitCompoundStmt(SE->getSubStmt());
3719}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003720
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003721CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003722 // "switch" is a control-flow statement. Thus we stop processing the current
3723 // block.
Craig Topper25542942014-05-20 04:30:07 +00003724 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003725
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003726 // Save local scope position because in case of condition variable ScopePos
3727 // won't be restored when traversing AST.
3728 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3729
Richard Smitha547eb22016-07-14 00:11:03 +00003730 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003731 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003732 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003733
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003734 // Create local scope for possible condition variable.
3735 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003736 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003737 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003738
Matthias Gehre351c2182017-07-12 07:04:19 +00003739 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003740
Ted Kremenek9aae5132007-08-23 21:42:29 +00003741 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003742 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003743 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003744 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003745 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003746
3747 // Save the current "switch" context.
3748 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003749 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003750 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003751
Mike Stump31feda52009-07-17 01:31:16 +00003752 // Set the "default" case to be the block after the switch statement. If the
3753 // switch statement contains a "default:", this value will be overwritten with
3754 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003755 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003756
Ted Kremenek9aae5132007-08-23 21:42:29 +00003757 // Create a new block that will contain the switch statement.
3758 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003759
Ted Kremenek9aae5132007-08-23 21:42:29 +00003760 // Now process the switch body. The code after the switch is the implicit
3761 // successor.
3762 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003763 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003764
3765 // When visiting the body, the case statements should automatically get linked
3766 // up to the switch. We also don't keep a pointer to the body, since all
3767 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003768 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003769 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003770
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003771 // For pruning unreachable case statements, save the current state
3772 // for tracking the condition value.
3773 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3774 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003775
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003776 // Determine if the switch condition can be explicitly evaluated.
3777 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003778 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003779 bool b = tryEvaluate(Terminator->getCond(), result);
3780 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003781 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003782
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003783 // If body is not a compound statement create implicit scope
3784 // and add destructors.
3785 if (!isa<CompoundStmt>(Terminator->getBody()))
3786 addLocalScopeAndDtors(Terminator->getBody());
3787
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003788 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003789 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003790 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003791 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003792 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003793
Mike Stump31feda52009-07-17 01:31:16 +00003794 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003795 // following the switch body. Moreover, take into account if all the
3796 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003797 //
3798 // Note: We add a successor to a switch that is considered covered yet has no
3799 // case statements if the enumeration has no enumerators.
3800 bool SwitchAlwaysHasSuccessor = false;
3801 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3802 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3803 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003804 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3805 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003806
Ted Kremenek81e14852007-08-27 19:46:09 +00003807 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003808 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003809 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003810 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003811
Richard Smitha547eb22016-07-14 00:11:03 +00003812 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003813 // SwitchStmt and the condition variable initialization to the CFG.
3814 if (VarDecl *VD = Terminator->getConditionVariable()) {
3815 if (Expr *Init = VD->getInit()) {
3816 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003817 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003818 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003819 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003820 }
3821 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003822
Richard Smitha547eb22016-07-14 00:11:03 +00003823 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3824 if (Stmt *Init = Terminator->getInit()) {
3825 autoCreateBlock();
3826 LastBlock = addStmt(Init);
3827 }
3828
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003829 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003830}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003831
3832static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003833 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003834 const CaseStmt *CS,
3835 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003836 if (!switchCond)
3837 return true;
3838
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003839 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003840
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003841 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003842 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003843 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003844 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003845 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003846
3847 if (condInt == lhsInt) {
3848 addCase = true;
3849 switchExclusivelyCovered = true;
3850 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003851 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003852 if (const Expr *RHS = CS->getRHS()) {
3853 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003854 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003855 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003856 addCase = true;
3857 switchExclusivelyCovered = true;
3858 }
3859 }
3860 }
3861 }
3862 else
3863 addCase = true;
3864 }
3865 return addCase;
3866}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003867
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003868CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003869 // CaseStmts are essentially labels, so they are the first statement in a
3870 // block.
Craig Topper25542942014-05-20 04:30:07 +00003871 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003872
Ted Kremenek60fa6572010-08-04 23:54:30 +00003873 if (Stmt *Sub = CS->getSubStmt()) {
3874 // For deeply nested chains of CaseStmts, instead of doing a recursion
3875 // (which can blow out the stack), manually unroll and create blocks
3876 // along the way.
3877 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003878 CFGBlock *currentBlock = createBlock(false);
3879 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003880
Ted Kremenek60fa6572010-08-04 23:54:30 +00003881 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003882 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003883 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003884 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003885
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003886 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003887 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003888 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003889 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003890
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003891 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003892 CS = cast<CaseStmt>(Sub);
3893 Sub = CS->getSubStmt();
3894 }
3895
3896 addStmt(Sub);
3897 }
Mike Stump11289f42009-09-09 15:08:12 +00003898
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003899 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003900 if (!CaseBlock)
3901 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003902
3903 // Cases statements partition blocks, so this is the top of the basic block we
3904 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003905 CaseBlock->setLabel(CS);
3906
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003907 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003908 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003909
3910 // Add this block to the list of successors for the block with the switch
3911 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003912 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003913 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003914 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003915 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003916
Ted Kremenek9aae5132007-08-23 21:42:29 +00003917 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003918 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003919
Ted Kremenek60fa6572010-08-04 23:54:30 +00003920 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003921 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003922 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003923 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003924 // This block is now the implicit successor of other blocks.
3925 Succ = CaseBlock;
3926 }
Mike Stump31feda52009-07-17 01:31:16 +00003927
Ted Kremenek60fa6572010-08-04 23:54:30 +00003928 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003929}
Mike Stump31feda52009-07-17 01:31:16 +00003930
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003931CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003932 if (Terminator->getSubStmt())
3933 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003934
Ted Kremenek654c78f2008-02-13 22:05:39 +00003935 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003936
3937 if (!DefaultCaseBlock)
3938 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003939
3940 // Default statements partition blocks, so this is the top of the basic block
3941 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003942 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003943
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003944 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003945 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003946
Mike Stump31feda52009-07-17 01:31:16 +00003947 // Unlike case statements, we don't add the default block to the successors
3948 // for the switch statement immediately. This is done when we finish
3949 // processing the switch statement. This allows for the default case
3950 // (including a fall-through to the code after the switch statement) to always
3951 // be the last successor of a switch-terminated block.
3952
Ted Kremenek654c78f2008-02-13 22:05:39 +00003953 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003954 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003955
Ted Kremenek654c78f2008-02-13 22:05:39 +00003956 // This block is now the implicit successor of other blocks.
3957 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003958
3959 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003960}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003961
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003962CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3963 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3964 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003965 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003966
3967 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003968 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003969 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003970 TrySuccessor = Block;
3971 } else TrySuccessor = Succ;
3972
Mike Stump0bdba6c2010-01-20 01:15:34 +00003973 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003974
3975 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003976 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003977 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003978 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003979
Mike Stump0bdba6c2010-01-20 01:15:34 +00003980 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003981 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3982 // The code after the try is the implicit successor.
3983 Succ = TrySuccessor;
3984 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003985 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003986 HasCatchAll = true;
3987 }
Craig Topper25542942014-05-20 04:30:07 +00003988 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003989 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00003990 if (!CatchBlock)
3991 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003992 // Add this block to the list of successors for the block with the try
3993 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003994 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003995 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00003996 if (!HasCatchAll) {
3997 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003998 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00003999 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004000 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00004001 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004002
4003 // The code after the try is the implicit successor.
4004 Succ = TrySuccessor;
4005
Mike Stump845384a2010-01-20 01:30:58 +00004006 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00004007 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
4008 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00004009
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004010 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004011 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004012 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004013}
4014
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004015CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004016 // CXXCatchStmt are treated like labels, so they are the first statement in a
4017 // block.
4018
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004019 // Save local scope position because in case of exception variable ScopePos
4020 // won't be restored when traversing AST.
4021 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4022
4023 // Create local scope for possible exception variable.
4024 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004025 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004026 LocalScope::const_iterator BeginScopePos = ScopePos;
4027 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004028 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004029 }
4030
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004031 if (CS->getHandlerBlock())
4032 addStmt(CS->getHandlerBlock());
4033
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004034 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004035 if (!CatchBlock)
4036 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004037
4038 // CXXCatchStmt is more than just a label. They have semantic meaning
4039 // as well, as they implicitly "initialize" the catch variable. Add
4040 // it to the CFG as a CFGElement so that the control-flow of these
4041 // semantics gets captured.
4042 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004043
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004044 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4045 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004046 CatchBlock->setLabel(CS);
4047
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004048 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004049 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004050 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004051
4052 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004053 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004054
4055 return CatchBlock;
4056}
4057
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004058CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004059 // C++0x for-range statements are specified as [stmt.ranged]:
4060 //
4061 // {
4062 // auto && __range = range-init;
4063 // for ( auto __begin = begin-expr,
4064 // __end = end-expr;
4065 // __begin != __end;
4066 // ++__begin ) {
4067 // for-range-declaration = *__begin;
4068 // statement
4069 // }
4070 // }
4071
4072 // Save local scope position before the addition of the implicit variables.
4073 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4074
4075 // Create local scopes and destructors for range, begin and end variables.
4076 if (Stmt *Range = S->getRangeStmt())
4077 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004078 if (Stmt *Begin = S->getBeginStmt())
4079 addLocalScopeForStmt(Begin);
4080 if (Stmt *End = S->getEndStmt())
4081 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004082 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004083
4084 LocalScope::const_iterator ContinueScopePos = ScopePos;
4085
4086 // "for" is a control-flow statement. Thus we stop processing the current
4087 // block.
Craig Topper25542942014-05-20 04:30:07 +00004088 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004089 if (Block) {
4090 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004091 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004092 LoopSuccessor = Block;
4093 } else
4094 LoopSuccessor = Succ;
4095
4096 // Save the current value for the break targets.
4097 // All breaks should go to the code following the loop.
4098 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4099 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4100
4101 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004102 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004103 ConditionBlock->setTerminator(S);
4104
4105 // Now add the actual condition to the condition block.
4106 if (Expr *C = S->getCond()) {
4107 Block = ConditionBlock;
4108 CFGBlock *BeginConditionBlock = addStmt(C);
4109 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004110 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004111 assert(BeginConditionBlock == ConditionBlock &&
4112 "condition block in for-range was unexpectedly complex");
4113 (void)BeginConditionBlock;
4114 }
4115
4116 // The condition block is the implicit successor for the loop body as well as
4117 // any code above the loop.
4118 Succ = ConditionBlock;
4119
4120 // See if this is a known constant.
4121 TryResult KnownVal(true);
4122
4123 if (S->getCond())
4124 KnownVal = tryEvaluateBool(S->getCond());
4125
4126 // Now create the loop body.
4127 {
4128 assert(S->getBody());
4129
4130 // Save the current values for Block, Succ, and continue targets.
4131 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4132 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4133
4134 // Generate increment code in its own basic block. This is the target of
4135 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004136 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004137 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004138 if (badCFG)
4139 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004140 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4141
4142 // The starting block for the loop increment is the block that should
4143 // represent the 'loop target' for looping back to the start of the loop.
4144 ContinueJumpTarget.block->setLoopTarget(S);
4145
4146 // Finish up the increment block and prepare to start the loop body.
4147 assert(Block);
4148 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004149 return nullptr;
4150 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004151
4152 // Add implicit scope and dtors for loop variable.
4153 addLocalScopeAndDtors(S->getLoopVarStmt());
4154
4155 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004156 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004157 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004158 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004159 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004160 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004161 return nullptr;
4162
Richard Smith02e85f32011-04-14 22:09:26 +00004163 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004164 addSuccessor(ConditionBlock,
4165 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004166 }
4167
4168 // Link up the condition block with the code that follows the loop (the
4169 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004170 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004171
4172 // Add the initialization statements.
4173 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004174 addStmt(S->getBeginStmt());
4175 addStmt(S->getEndStmt());
Richard Smith0c502d22011-04-18 15:49:25 +00004176 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004177}
4178
John McCall5d413782010-12-06 08:20:24 +00004179CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004180 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004181 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004182 // If adding implicit destructors visit the full expression for adding
4183 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004184 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004185 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004186
4187 // Full expression has to be added as CFGStmt so it will be sequenced
4188 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004189 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004190 }
4191 return Visit(E->getSubExpr(), asc);
4192}
4193
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004194CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4195 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004196 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004197 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004198 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004199
Artem Dergachev783a4572018-02-23 22:20:39 +00004200 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004201 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004202 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004203
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004204 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004205 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004206 }
4207 return Visit(E->getSubExpr(), asc);
4208}
4209
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004210CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4211 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004212 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004213 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004214
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004215 return VisitChildren(C);
4216}
4217
Jordan Rosec9176072014-01-13 17:59:19 +00004218CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4219 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004220 autoCreateBlock();
4221 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004222
Artem Dergachev783a4572018-02-23 22:20:39 +00004223 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004224 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004225 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004226
Jordan Rosec9176072014-01-13 17:59:19 +00004227 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004228 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004229
Jordan Rosec9176072014-01-13 17:59:19 +00004230 if (BuildOpts.AddCXXNewAllocator)
4231 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004232
Jordan Rosec9176072014-01-13 17:59:19 +00004233 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004234 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004235
Jordan Rosec9176072014-01-13 17:59:19 +00004236 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4237 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004238 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004239
Jordan Rosec9176072014-01-13 17:59:19 +00004240 return Block;
4241}
Jordan Rosed2f40792013-09-03 17:00:57 +00004242
4243CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4244 AddStmtChoice asc) {
4245 autoCreateBlock();
4246 appendStmt(Block, DE);
4247 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004248 if (!DTy.isNull()) {
4249 DTy = DTy.getNonReferenceType();
4250 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4251 if (RD) {
4252 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4253 appendDeleteDtor(Block, RD, DE);
4254 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004255 }
4256
4257 return VisitChildren(DE);
4258}
4259
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004260CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4261 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004262 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004263 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004264 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004265 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004266 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004267 }
4268 return Visit(E->getSubExpr(), asc);
4269}
4270
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004271CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4272 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004273 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004274 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004275 return VisitChildren(C);
4276}
4277
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004278CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4279 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004280 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004281 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004282 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004283 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004284 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004285}
4286
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004287CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004288 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004289 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004290
Ted Kremenekeda180e22007-08-28 19:26:49 +00004291 if (!IBlock) {
4292 IBlock = createBlock(false);
4293 cfg->setIndirectGotoBlock(IBlock);
4294 }
Mike Stump31feda52009-07-17 01:31:16 +00004295
Ted Kremenekeda180e22007-08-28 19:26:49 +00004296 // IndirectGoto is a control-flow statement. Thus we stop processing the
4297 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004298 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004299 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004300
Ted Kremenekeda180e22007-08-28 19:26:49 +00004301 Block = createBlock(false);
4302 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004303 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004304 return addStmt(I->getTarget());
4305}
4306
Manuel Klimekb5616c92014-08-07 10:42:17 +00004307CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4308 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004309 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4310
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004311tryAgain:
4312 if (!E) {
4313 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004314 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004315 }
4316 switch (E->getStmtClass()) {
4317 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004318 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004319
4320 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004321 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4322 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004323
4324 case Stmt::CXXBindTemporaryExprClass:
4325 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004326 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004327
John McCallc07a0c72011-02-17 10:25:35 +00004328 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004329 case Stmt::ConditionalOperatorClass:
4330 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004331 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004332
4333 case Stmt::ImplicitCastExprClass:
4334 // For implicit cast we want BindToTemporary to be passed further.
4335 E = cast<CastExpr>(E)->getSubExpr();
4336 goto tryAgain;
4337
Manuel Klimekb0042c42014-07-30 08:34:42 +00004338 case Stmt::CXXFunctionalCastExprClass:
4339 // For functional cast we want BindToTemporary to be passed further.
4340 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4341 goto tryAgain;
4342
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004343 case Stmt::ParenExprClass:
4344 E = cast<ParenExpr>(E)->getSubExpr();
4345 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004346
Manuel Klimekb0042c42014-07-30 08:34:42 +00004347 case Stmt::MaterializeTemporaryExprClass: {
4348 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4349 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4350 SmallVector<const Expr *, 2> CommaLHSs;
4351 SmallVector<SubobjectAdjustment, 2> Adjustments;
4352 // Find the expression whose lifetime needs to be extended.
4353 E = const_cast<Expr *>(
4354 cast<MaterializeTemporaryExpr>(E)
4355 ->GetTemporaryExpr()
4356 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4357 // Visit the skipped comma operator left-hand sides for other temporaries.
4358 for (const Expr *CommaLHS : CommaLHSs) {
4359 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004360 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004361 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004362 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004363 }
Richard Smith4137af22014-07-27 05:12:49 +00004364
4365 case Stmt::BlockExprClass:
4366 // Don't recurse into blocks; their subexpressions don't get evaluated
4367 // here.
4368 return Block;
4369
4370 case Stmt::LambdaExprClass: {
4371 // For lambda expressions, only recurse into the capture initializers,
4372 // and not the body.
4373 auto *LE = cast<LambdaExpr>(E);
4374 CFGBlock *B = Block;
4375 for (Expr *Init : LE->capture_inits()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004376 if (CFGBlock *R = VisitForTemporaryDtors(
4377 Init, /*BindToTemporary=*/false, Context))
Richard Smith4137af22014-07-27 05:12:49 +00004378 B = R;
4379 }
4380 return B;
4381 }
4382
4383 case Stmt::CXXDefaultArgExprClass:
4384 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4385 goto tryAgain;
4386
4387 case Stmt::CXXDefaultInitExprClass:
4388 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4389 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004390 }
4391}
4392
Manuel Klimekb5616c92014-08-07 10:42:17 +00004393CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4394 TempDtorContext &Context) {
4395 if (isa<LambdaExpr>(E)) {
4396 // Do not visit the children of lambdas; they have their own CFGs.
4397 return Block;
4398 }
4399
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004400 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004401 // order that they will appear in the CFG. Because the CFG is built
4402 // bottom-up, this means we visit them in their natural order, which
4403 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004404 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004405 for (Stmt *Child : E->children())
4406 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004407 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004408 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004409
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004410 return B;
4411}
4412
Manuel Klimekb5616c92014-08-07 10:42:17 +00004413CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4414 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004415 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004416 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004417 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4418 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4419 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004420
Manuel Klimekedf925b92014-08-07 18:44:19 +00004421 // We do not know at CFG-construction time whether the right-hand-side was
4422 // executed, thus we add a branch node that depends on the temporary
4423 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004424 TempDtorContext RHSContext(
4425 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004426 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004427 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004428
Manuel Klimekb5616c92014-08-07 10:42:17 +00004429 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004430 }
4431
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004432 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004433 // For assignment operator (=) LHS expression is visited
4434 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004435 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4436 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004437 return LHSBlock ? LHSBlock : RHSBlock;
4438 }
4439
4440 // For any other binary operator RHS expression is visited before
4441 // LHS expression (order of children). For destructors visit them in reverse
4442 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004443 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4444 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004445 return RHSBlock ? RHSBlock : LHSBlock;
4446}
4447
4448CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004449 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004450 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004451 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004452 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004453 // If lifetime of temporary is not prolonged (by assigning to constant
4454 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004455
Chandler Carruthad747252011-09-13 06:09:01 +00004456 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004457
Richard Trieu95a192a2015-05-28 00:14:02 +00004458 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004459 // If the destructor is marked as a no-return destructor, we need to
4460 // create a new block for the destructor which does not have as a
4461 // successor anything built thus far. Control won't flow out of this
4462 // block.
4463 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004464 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004465 } else if (Context.needsTempDtorBranch()) {
4466 // If we need to introduce a branch, we add a new block that we will hook
4467 // up to a decision block later.
4468 if (B) Succ = B;
4469 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004470 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004471 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004472 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004473 if (Context.needsTempDtorBranch()) {
4474 Context.setDecisionPoint(Succ, E);
4475 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004476 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004477
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004478 B = Block;
4479 }
4480 return B;
4481}
4482
Manuel Klimekb5616c92014-08-07 10:42:17 +00004483void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4484 CFGBlock *FalseSucc) {
4485 if (!Context.TerminatorExpr) {
4486 // If no temporary was found, we do not need to insert a decision point.
4487 return;
4488 }
4489 assert(Context.TerminatorExpr);
4490 CFGBlock *Decision = createBlock(false);
4491 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004492 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004493 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004494 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004495 Block = Decision;
4496}
4497
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004498CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004499 AbstractConditionalOperator *E, bool BindToTemporary,
4500 TempDtorContext &Context) {
4501 VisitForTemporaryDtors(E->getCond(), false, Context);
4502 CFGBlock *ConditionBlock = Block;
4503 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004504 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004505 TryResult NegatedVal = ConditionVal;
4506 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004507
Manuel Klimekdeb02622014-08-08 07:37:13 +00004508 TempDtorContext TrueContext(
4509 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004510 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004511 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004512
Manuel Klimekb5616c92014-08-07 10:42:17 +00004513 Block = ConditionBlock;
4514 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004515 TempDtorContext FalseContext(
4516 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004517 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004518
Manuel Klimekb5616c92014-08-07 10:42:17 +00004519 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004520 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004521 } else if (TrueContext.TerminatorExpr) {
4522 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004523 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004524 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004525 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004526 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004527 return Block;
4528}
4529
Mike Stump31feda52009-07-17 01:31:16 +00004530/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4531/// no successors or predecessors. If this is the first block created in the
4532/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004533CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004534 bool first_block = begin() == end();
4535
4536 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004537 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004538 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004539 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004540
4541 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004542 if (first_block)
4543 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004544
4545 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004546 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004547}
4548
David Blaikiee90195c2014-08-29 18:53:26 +00004549/// buildCFG - Constructs a CFG from an AST.
4550std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4551 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004552 CFGBuilder Builder(C, BO);
4553 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004554}
4555
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004556const CXXDestructorDecl *
4557CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004558 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004559 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004560 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004561 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004562 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004563 case CFGElement::Statement:
4564 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004565 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004566 case CFGElement::ScopeBegin:
4567 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004568 llvm_unreachable("getDestructorDecl should only be used with "
4569 "ImplicitDtors");
4570 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004571 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004572 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004573
4574 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4575 //
4576 // Lifetime-extending constructs are handled here. This works for a single
4577 // temporary in an initializer expression.
4578 if (ty->isReferenceType()) {
4579 if (const Expr *Init = var->getInit()) {
4580 ty = getReferenceInitTemporaryType(astContext, Init);
4581 }
4582 }
4583
Ted Kremeneke7d78882012-03-19 23:48:41 +00004584 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004585 ty = arrayType->getElementType();
4586 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004587 const RecordType *recordType = ty->getAs<RecordType>();
4588 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004589 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004590 return classDecl->getDestructor();
4591 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004592 case CFGElement::DeleteDtor: {
4593 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4594 QualType DTy = DE->getDestroyedType();
4595 DTy = DTy.getNonReferenceType();
4596 const CXXRecordDecl *classDecl =
4597 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4598 return classDecl->getDestructor();
4599 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004600 case CFGElement::TemporaryDtor: {
4601 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004602 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004603 const CXXTemporary *temp = bindExpr->getTemporary();
4604 return temp->getDestructor();
4605 }
4606 case CFGElement::BaseDtor:
4607 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004608 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004609 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004610 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004611 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004612}
4613
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004614bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004615 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4616 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004617 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004618}
4619
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004620//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004621// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004622//===----------------------------------------------------------------------===//
4623
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004624CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004625 : ReachableBlock(IsReachable ? B : nullptr),
4626 UnreachableBlock(!IsReachable ? B : nullptr,
4627 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004628
4629CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004630 : ReachableBlock(B),
4631 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4632 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004633
4634void CFGBlock::addSuccessor(AdjacentBlock Succ,
4635 BumpVectorContext &C) {
4636 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004637 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004638
4639 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004640 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004641
4642 Succs.push_back(Succ, C);
4643}
4644
Ted Kremenekb0371852010-09-09 00:06:04 +00004645bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004646 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004647 if (F.IgnoreNullPredecessors && !From)
4648 return true;
4649
4650 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004651 // If the 'To' has no label or is labeled but the label isn't a
4652 // CaseStmt then filter this edge.
4653 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004654 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004655 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004656 const Stmt *L = To->getLabel();
4657 if (!L || !isa<CaseStmt>(L))
4658 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004659 }
4660 }
4661 }
4662
4663 return false;
4664}
4665
4666//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004667// CFG pretty printing
4668//===----------------------------------------------------------------------===//
4669
Ted Kremenek7e776b12007-08-22 18:22:34 +00004670namespace {
4671
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004672class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004673 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4674 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4675
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004676 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004677 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004678 signed currentBlock = 0;
4679 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004680 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004681
Eugene Zelenko38c70522017-12-07 21:55:09 +00004682public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004683 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004684 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004685 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4686 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004687 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004688 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004689 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4690 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004691 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004692 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004693
Ted Kremenek96a7a592011-03-01 03:15:10 +00004694 switch (stmt->getStmtClass()) {
4695 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004696 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4697 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004698 case Stmt::IfStmtClass: {
4699 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4700 if (var)
4701 DeclMap[var] = P;
4702 break;
4703 }
4704 case Stmt::ForStmtClass: {
4705 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4706 if (var)
4707 DeclMap[var] = P;
4708 break;
4709 }
4710 case Stmt::WhileStmtClass: {
4711 const VarDecl *var =
4712 cast<WhileStmt>(stmt)->getConditionVariable();
4713 if (var)
4714 DeclMap[var] = P;
4715 break;
4716 }
4717 case Stmt::SwitchStmtClass: {
4718 const VarDecl *var =
4719 cast<SwitchStmt>(stmt)->getConditionVariable();
4720 if (var)
4721 DeclMap[var] = P;
4722 break;
4723 }
4724 case Stmt::CXXCatchStmtClass: {
4725 const VarDecl *var =
4726 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4727 if (var)
4728 DeclMap[var] = P;
4729 break;
4730 }
4731 default:
4732 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004733 }
4734 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004735 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004736 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004737 }
Mike Stump31feda52009-07-17 01:31:16 +00004738
Eugene Zelenko38c70522017-12-07 21:55:09 +00004739 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004740
Chris Lattnerc61089a2009-06-30 01:26:17 +00004741 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004742 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004743 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004744
Craig Topperb45acb82014-03-14 06:02:07 +00004745 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004746 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004747
4748 if (I == StmtMap.end())
4749 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004750
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004751 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004752 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004753 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004754 }
Mike Stump31feda52009-07-17 01:31:16 +00004755
Ted Kremenek60983dc2010-01-19 20:52:05 +00004756 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004757 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004758 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004759
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004760 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004761 DeclMapTy::iterator I = DeclMap.find(D);
4762
4763 if (I == DeclMap.end())
4764 return false;
4765
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004766 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004767 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004768 return false;
4769 }
4770
4771 OS << "[B" << I->second.first << "." << I->second.second << "]";
4772 return true;
4773 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004774};
4775
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004776class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004777 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004778 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004779 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004780 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004781
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004782public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004783 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004784 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004785 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004786 this->Policy.IncludeNewlines = false;
4787 }
Mike Stump31feda52009-07-17 01:31:16 +00004788
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004789 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004790 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004791 if (Stmt *C = I->getCond())
4792 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004793 }
Mike Stump31feda52009-07-17 01:31:16 +00004794
Ted Kremenek9aae5132007-08-23 21:42:29 +00004795 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004796 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004797 Terminator->printPretty(OS, Helper, Policy);
4798 }
4799
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004800 void VisitDeclStmt(DeclStmt *DS) {
4801 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4802 OS << "static init " << VD->getName();
4803 }
4804
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004805 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004806 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004807 if (F->getInit())
4808 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004809 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004810 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004811 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004812 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004813 if (F->getInc())
4814 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004815 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004816 }
Mike Stump31feda52009-07-17 01:31:16 +00004817
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004818 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004819 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004820 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004821 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004822 }
Mike Stump31feda52009-07-17 01:31:16 +00004823
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004824 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004825 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004826 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004827 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004828 }
Mike Stump31feda52009-07-17 01:31:16 +00004829
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004830 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004831 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004832 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004833 }
Mike Stump31feda52009-07-17 01:31:16 +00004834
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004835 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004836 OS << "try ...";
4837 }
4838
Nico Weber699670e2017-08-23 15:33:16 +00004839 void VisitSEHTryStmt(SEHTryStmt *CS) {
4840 OS << "__try ...";
4841 }
4842
John McCallc07a0c72011-02-17 10:25:35 +00004843 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004844 if (Stmt *Cond = C->getCond())
4845 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004846 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004847 }
Mike Stump31feda52009-07-17 01:31:16 +00004848
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004849 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004850 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004851 if (Stmt *Cond = C->getCond())
4852 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004853 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004854 }
Mike Stump31feda52009-07-17 01:31:16 +00004855
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004856 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004857 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004858 if (Stmt *T = I->getTarget())
4859 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004860 }
Mike Stump31feda52009-07-17 01:31:16 +00004861
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004862 void VisitBinaryOperator(BinaryOperator* B) {
4863 if (!B->isLogicalOp()) {
4864 VisitExpr(B);
4865 return;
4866 }
Mike Stump31feda52009-07-17 01:31:16 +00004867
Richard Trieuddd01ce2014-06-09 22:53:25 +00004868 if (B->getLHS())
4869 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004870
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004871 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004872 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004873 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004874 return;
John McCalle3027922010-08-25 11:45:40 +00004875 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004876 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004877 return;
4878 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004879 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004880 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004881 }
Mike Stump31feda52009-07-17 01:31:16 +00004882
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004883 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004884 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004885 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004886
4887public:
4888 void print(CFGTerminator T) {
4889 if (T.isTemporaryDtorsBranch())
4890 OS << "(Temp Dtor) ";
4891 Visit(T.getStmt());
4892 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004893};
Eugene Zelenko38c70522017-12-07 21:55:09 +00004894
4895} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00004896
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004897static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
4898 const CXXCtorInitializer *I) {
4899 if (I->isBaseInitializer())
4900 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
4901 else if (I->isDelegatingInitializer())
4902 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
4903 else
4904 OS << I->getAnyMember()->getName();
4905 OS << "(";
4906 if (Expr *IE = I->getInit())
4907 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
4908 OS << ")";
4909
4910 if (I->isBaseInitializer())
4911 OS << " (Base initializer)";
4912 else if (I->isDelegatingInitializer())
4913 OS << " (Delegating initializer)";
4914 else
4915 OS << " (Member initializer)";
4916}
4917
Artem Dergachev1527dec2018-03-12 23:12:40 +00004918static void print_construction_context(raw_ostream &OS,
4919 StmtPrinterHelper &Helper,
4920 const ConstructionContext *CC) {
4921 const Stmt *S1 = nullptr, *S2 = nullptr;
4922 switch (CC->getKind()) {
Artem Dergachev922455f2018-03-22 22:02:38 +00004923 case ConstructionContext::SimpleConstructorInitializerKind: {
Artem Dergachev1527dec2018-03-12 23:12:40 +00004924 OS << ", ";
Artem Dergachev922455f2018-03-22 22:02:38 +00004925 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC);
4926 print_initializer(OS, Helper, SICC->getCXXCtorInitializer());
4927 break;
4928 }
4929 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: {
4930 OS << ", ";
4931 const auto *CICC =
4932 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC);
4933 print_initializer(OS, Helper, CICC->getCXXCtorInitializer());
4934 S2 = CICC->getCXXBindTemporaryExpr();
Artem Dergachev1527dec2018-03-12 23:12:40 +00004935 break;
4936 }
4937 case ConstructionContext::SimpleVariableKind: {
Artem Dergachev317291e2018-03-22 21:37:39 +00004938 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC);
4939 S1 = SDSCC->getDeclStmt();
4940 break;
4941 }
4942 case ConstructionContext::CXX17ElidedCopyVariableKind: {
4943 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC);
4944 S1 = CDSCC->getDeclStmt();
4945 S2 = CDSCC->getCXXBindTemporaryExpr();
Artem Dergachev1527dec2018-03-12 23:12:40 +00004946 break;
4947 }
4948 case ConstructionContext::NewAllocatedObjectKind: {
4949 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
4950 S1 = NECC->getCXXNewExpr();
4951 break;
4952 }
Artem Dergachev317291e2018-03-22 21:37:39 +00004953 case ConstructionContext::SimpleReturnedValueKind: {
4954 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC);
Artem Dergachev1527dec2018-03-12 23:12:40 +00004955 S1 = RSCC->getReturnStmt();
4956 break;
4957 }
Artem Dergachev317291e2018-03-22 21:37:39 +00004958 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: {
4959 const auto *RSCC =
4960 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC);
4961 S1 = RSCC->getReturnStmt();
4962 S2 = RSCC->getCXXBindTemporaryExpr();
4963 break;
4964 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00004965 case ConstructionContext::TemporaryObjectKind: {
4966 const auto *TOCC = cast<TemporaryObjectConstructionContext>(CC);
4967 S1 = TOCC->getCXXBindTemporaryExpr();
4968 S2 = TOCC->getMaterializedTemporaryExpr();
4969 break;
4970 }
4971 }
4972 if (S1) {
4973 OS << ", ";
4974 Helper.handledStmt(const_cast<Stmt *>(S1), OS);
4975 }
4976 if (S2) {
4977 OS << ", ";
4978 Helper.handledStmt(const_cast<Stmt *>(S2), OS);
4979 }
4980}
4981
Aaron Ballmanff924b02013-11-18 20:11:50 +00004982static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00004983 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004984 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4985 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00004986 assert(S != nullptr && "Expecting non-null Stmt");
4987
Aaron Ballmanff924b02013-11-18 20:11:50 +00004988 // special printing for statement-expressions.
4989 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
4990 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00004991
Benjamin Kramer5733e352015-07-18 17:09:36 +00004992 auto Children = Sub->children();
4993 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00004994 OS << "({ ... ; ";
4995 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
4996 OS << " })\n";
4997 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004998 }
4999 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00005000 // special printing for comma expressions.
5001 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
5002 if (B->getOpcode() == BO_Comma) {
5003 OS << "... , ";
5004 Helper.handledStmt(B->getRHS(),OS);
5005 OS << '\n';
5006 return;
5007 }
5008 }
5009 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00005010
Artem Dergachev1527dec2018-03-12 23:12:40 +00005011 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
5012 if (isa<CXXOperatorCallExpr>(S))
5013 OS << " (OperatorCall)";
5014 OS << " (CXXRecordTypedCall";
5015 print_construction_context(OS, Helper, VTC->getConstructionContext());
5016 OS << ")";
5017 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005018 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005019 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005020 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005021 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005022 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005023 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005024 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00005025 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005026 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005027 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00005028 OS << " (" << CE->getStmtClassName() << ", "
5029 << CE->getCastKindName()
5030 << ", " << CE->getType().getAsString()
5031 << ")";
5032 }
Mike Stump31feda52009-07-17 01:31:16 +00005033
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005034 // Expressions need a newline.
5035 if (isa<Expr>(S))
5036 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005037 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005038 print_initializer(OS, Helper, IE->getInitializer());
5039 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005040 } else if (Optional<CFGAutomaticObjDtor> DE =
5041 E.getAs<CFGAutomaticObjDtor>()) {
5042 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005043 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005044
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00005045 const Type* T = VD->getType().getTypePtr();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005046 if (const ReferenceType* RT = T->getAs<ReferenceType>())
5047 T = RT->getPointeeType().getTypePtr();
Richard Smithf676e452012-07-24 21:02:14 +00005048 T = T->getBaseElementTypeUnsafe();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005049
5050 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
5051 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00005052 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
5053 const VarDecl *VD = DE->getVarDecl();
5054 Helper.handleDecl(VD, OS);
5055
5056 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00005057 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
5058 const Stmt *LoopStmt = LE->getLoopStmt();
5059 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005060 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
5061 OS << "CFGScopeBegin(";
5062 if (const VarDecl *VD = SB->getVarDecl())
5063 OS << VD->getQualifiedNameAsString();
5064 OS << ")\n";
5065 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
5066 OS << "CFGScopeEnd(";
5067 if (const VarDecl *VD = SE->getVarDecl())
5068 OS << VD->getQualifiedNameAsString();
5069 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00005070 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
5071 OS << "CFGNewAllocator(";
5072 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
5073 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5074 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00005075 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
5076 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
5077 if (!RD)
5078 return;
5079 CXXDeleteExpr *DelExpr =
5080 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005081 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005082 OS << "->~" << RD->getName().str() << "()";
5083 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005084 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5085 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005086 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005087 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005088 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5089 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005090 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005091 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005092 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005093 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005094 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5095 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005096 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005097 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005098 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005099 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005100}
Mike Stump31feda52009-07-17 01:31:16 +00005101
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005102static void print_block(raw_ostream &OS, const CFG* cfg,
5103 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005104 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005105 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005106 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005107
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005108 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005109 if (ShowColors)
5110 OS.changeColor(raw_ostream::YELLOW, true);
5111
5112 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005113
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005114 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005115 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005116 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005117 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005118 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005119 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005120 else if (B.hasNoReturnElement())
5121 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005122 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005123 OS << "]\n";
5124
5125 if (ShowColors)
5126 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005127
Ted Kremenek71eca012007-08-29 23:20:49 +00005128 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005129 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005130 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005131 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005132
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005133 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005134 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005135 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005136 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005137 if (C->getLHS())
5138 C->getLHS()->printPretty(OS, &Helper,
5139 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005140 if (C->getRHS()) {
5141 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005142 C->getRHS()->printPretty(OS, &Helper,
5143 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005144 }
Mike Stump92244b02010-01-19 22:00:14 +00005145 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005146 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005147 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005148 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005149 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005150 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005151 0);
5152 else
5153 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005154 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005155 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5156 OS << "__except (";
5157 ES->getFilterExpr()->printPretty(OS, &Helper,
5158 PrintingPolicy(Helper.getLangOpts()), 0);
5159 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005160 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005161 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005162
Ted Kremenek71eca012007-08-29 23:20:49 +00005163 OS << ":\n";
5164 }
Mike Stump31feda52009-07-17 01:31:16 +00005165
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005166 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005167 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005168
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005169 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5170 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005171 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005172 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005173 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005174
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005175 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005176
Aaron Ballmanff924b02013-11-18 20:11:50 +00005177 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005178
Ted Kremenek72be32a2011-12-22 23:33:52 +00005179 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005180 }
Mike Stump31feda52009-07-17 01:31:16 +00005181
Ted Kremenek71eca012007-08-29 23:20:49 +00005182 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005183 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005184 if (ShowColors)
5185 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005186
Ted Kremenek72be32a2011-12-22 23:33:52 +00005187 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005188
Aaron Ballmanff924b02013-11-18 20:11:50 +00005189 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005190
Aaron Ballmanff924b02013-11-18 20:11:50 +00005191 PrintingPolicy PP(Helper.getLangOpts());
5192 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005193 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005194 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00005195
5196 if (ShowColors)
5197 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005198 }
Mike Stump31feda52009-07-17 01:31:16 +00005199
Ted Kremenek71eca012007-08-29 23:20:49 +00005200 if (print_edges) {
5201 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005202 if (!B.pred_empty()) {
5203 const raw_ostream::Colors Color = raw_ostream::BLUE;
5204 if (ShowColors)
5205 OS.changeColor(Color);
5206 OS << " Preds " ;
5207 if (ShowColors)
5208 OS.resetColor();
5209 OS << '(' << B.pred_size() << "):";
5210 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005211
Ted Kremenek72be32a2011-12-22 23:33:52 +00005212 if (ShowColors)
5213 OS.changeColor(Color);
5214
5215 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5216 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005217 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005218 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005219
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005220 CFGBlock *B = *I;
5221 bool Reachable = true;
5222 if (!B) {
5223 Reachable = false;
5224 B = I->getPossiblyUnreachableBlock();
5225 }
5226
5227 OS << " B" << B->getBlockID();
5228 if (!Reachable)
5229 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005230 }
5231
5232 if (ShowColors)
5233 OS.resetColor();
5234
5235 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005236 }
Mike Stump31feda52009-07-17 01:31:16 +00005237
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005238 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005239 if (!B.succ_empty()) {
5240 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5241 if (ShowColors)
5242 OS.changeColor(Color);
5243 OS << " Succs ";
5244 if (ShowColors)
5245 OS.resetColor();
5246 OS << '(' << B.succ_size() << "):";
5247 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005248
Ted Kremenek72be32a2011-12-22 23:33:52 +00005249 if (ShowColors)
5250 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005251
Ted Kremenek72be32a2011-12-22 23:33:52 +00005252 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5253 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005254 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005255 OS << "\n ";
5256
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005257 CFGBlock *B = *I;
5258
5259 bool Reachable = true;
5260 if (!B) {
5261 Reachable = false;
5262 B = I->getPossiblyUnreachableBlock();
5263 }
5264
5265 if (B) {
5266 OS << " B" << B->getBlockID();
5267 if (!Reachable)
5268 OS << "(Unreachable)";
5269 }
5270 else {
5271 OS << " NULL";
5272 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005273 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005274
Ted Kremenek72be32a2011-12-22 23:33:52 +00005275 if (ShowColors)
5276 OS.resetColor();
5277 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005278 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005279 }
Mike Stump31feda52009-07-17 01:31:16 +00005280}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005281
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005282/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005283void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5284 print(llvm::errs(), LO, ShowColors);
5285}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005286
5287/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005288void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005289 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005290
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005291 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005292 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005293
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005294 // Iterate through the CFGBlocks and print them one by one.
5295 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5296 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005297 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005298 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005299
Aaron Ballmanff924b02013-11-18 20:11:50 +00005300 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005301 }
Mike Stump31feda52009-07-17 01:31:16 +00005302
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005303 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005304 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005305 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005306 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005307}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005308
5309/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005310void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5311 bool ShowColors) const {
5312 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005313}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005314
Yaron Kerencdae9412016-01-29 19:38:18 +00005315LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005316 dump(getParent(), LangOptions(), false);
5317}
5318
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005319/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5320/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005321void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005322 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005323 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005324 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005325 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005326}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005327
Ted Kremenek15647632008-01-30 23:02:42 +00005328/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005329void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005330 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005331 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005332 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005333}
5334
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005335Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00005336 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005337 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005338 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005339
Craig Topper25542942014-05-20 04:30:07 +00005340 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005341
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005342 switch (Terminator->getStmtClass()) {
5343 default:
5344 break;
Mike Stump31feda52009-07-17 01:31:16 +00005345
Jordan Rosecf10ea82013-06-06 21:53:45 +00005346 case Stmt::CXXForRangeStmtClass:
5347 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5348 break;
5349
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005350 case Stmt::ForStmtClass:
5351 E = cast<ForStmt>(Terminator)->getCond();
5352 break;
Mike Stump31feda52009-07-17 01:31:16 +00005353
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005354 case Stmt::WhileStmtClass:
5355 E = cast<WhileStmt>(Terminator)->getCond();
5356 break;
Mike Stump31feda52009-07-17 01:31:16 +00005357
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005358 case Stmt::DoStmtClass:
5359 E = cast<DoStmt>(Terminator)->getCond();
5360 break;
Mike Stump31feda52009-07-17 01:31:16 +00005361
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005362 case Stmt::IfStmtClass:
5363 E = cast<IfStmt>(Terminator)->getCond();
5364 break;
Mike Stump31feda52009-07-17 01:31:16 +00005365
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005366 case Stmt::ChooseExprClass:
5367 E = cast<ChooseExpr>(Terminator)->getCond();
5368 break;
Mike Stump31feda52009-07-17 01:31:16 +00005369
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005370 case Stmt::IndirectGotoStmtClass:
5371 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5372 break;
Mike Stump31feda52009-07-17 01:31:16 +00005373
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005374 case Stmt::SwitchStmtClass:
5375 E = cast<SwitchStmt>(Terminator)->getCond();
5376 break;
Mike Stump31feda52009-07-17 01:31:16 +00005377
John McCallc07a0c72011-02-17 10:25:35 +00005378 case Stmt::BinaryConditionalOperatorClass:
5379 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5380 break;
5381
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005382 case Stmt::ConditionalOperatorClass:
5383 E = cast<ConditionalOperator>(Terminator)->getCond();
5384 break;
Mike Stump31feda52009-07-17 01:31:16 +00005385
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005386 case Stmt::BinaryOperatorClass: // '&&' and '||'
5387 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005388 break;
Mike Stump31feda52009-07-17 01:31:16 +00005389
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005390 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005391 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005392 }
Mike Stump31feda52009-07-17 01:31:16 +00005393
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005394 if (!StripParens)
5395 return E;
5396
Craig Topper25542942014-05-20 04:30:07 +00005397 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005398}
5399
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005400//===----------------------------------------------------------------------===//
5401// CFG Graphviz Visualization
5402//===----------------------------------------------------------------------===//
5403
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005404#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005405static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005406#endif
5407
Chris Lattnerc61089a2009-06-30 01:26:17 +00005408void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005409#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005410 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005411 GraphHelper = &H;
5412 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005413 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005414#endif
5415}
5416
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005417namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005418
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005419template<>
5420struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005421 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005422
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005423 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005424#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005425 std::string OutSStr;
5426 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005427 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005428 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005429
5430 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5431
5432 // Process string output to make it nicer...
5433 for (unsigned i = 0; i != OutStr.length(); ++i)
5434 if (OutStr[i] == '\n') { // Left justify
5435 OutStr[i] = '\\';
5436 OutStr.insert(OutStr.begin()+i+1, 'l');
5437 }
Mike Stump31feda52009-07-17 01:31:16 +00005438
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005439 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005440#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005441 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005442#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005443 }
5444};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005445
5446} // namespace llvm