blob: 7fec3f7de8caf4c64d86931e2633f43fb6e4a1ee [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
486 // itself is being visited.
Artem Dergachev40684812018-02-27 20:03:35 +0000487 llvm::DenseMap<CXXConstructExpr *, 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 Dergachevc1b07bd2018-02-23 23:38:41 +0000676 CXXConstructExpr *CE);
677
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
687 // after adding the CFGConstructor element, so there's no need to
688 // do this manually in every Visit... function.
Artem Dergachev783a4572018-02-23 22:20:39 +0000689 void cleanupConstructionContext(CXXConstructExpr *CE);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000690
Ted Kremenek93668002009-07-17 22:18:43 +0000691 void autoCreateBlock() { if (!Block) Block = createBlock(); }
692 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000693 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000694
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000695 CFGBlock *addStmt(Stmt *S) {
696 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000697 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000698
Alexis Hunt1d792652011-01-08 20:30:50 +0000699 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000700 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000701 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000702 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000703 void addLifetimeEnds(LocalScope::const_iterator B,
704 LocalScope::const_iterator E, Stmt *S);
705 void addAutomaticObjHandling(LocalScope::const_iterator B,
706 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000707 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000708 void addScopesEnd(LocalScope::const_iterator B, LocalScope::const_iterator E,
709 Stmt *S);
710
711 void getDeclsWithEndedScope(LocalScope::const_iterator B,
712 LocalScope::const_iterator E, Stmt *S);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000713
Marcin Swiderski5e415732010-09-30 23:05:00 +0000714 // Local scopes creation.
715 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
716
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000717 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000718 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
719 LocalScope* Scope = nullptr);
720 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000721
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000722 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000723
724 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000725
Ted Kremenek37881932011-04-04 23:29:12 +0000726 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000727 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000728 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000729
Jordy Rose17347372011-06-10 08:49:37 +0000730 // All block-level expressions should have already been IgnoreParens()ed.
731 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000732 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000733 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000734
Artem Dergachev41ffb302018-02-08 22:58:15 +0000735 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
736 if (BuildOpts.AddRichCXXConstructors) {
Artem Dergachev40684812018-02-27 20:03:35 +0000737 if (const ConstructionContextLayer *Layer =
738 ConstructionContextMap.lookup(CE)) {
739 const ConstructionContext *CC =
740 ConstructionContext::createFromLayers(cfg->getBumpVectorContext(),
741 Layer);
Artem Dergachev783a4572018-02-23 22:20:39 +0000742 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
743 cleanupConstructionContext(CE);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000744 return;
745 }
746 }
747
748 // No valid construction context found. Fall back to statement.
749 B->appendStmt(CE, cfg->getBumpVectorContext());
750 }
751
Alexis Hunt1d792652011-01-08 20:30:50 +0000752 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000753 B->appendInitializer(I, cfg->getBumpVectorContext());
754 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000755
Jordan Rosec9176072014-01-13 17:59:19 +0000756 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
757 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
758 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000759
Marcin Swiderski20b88732010-10-05 05:37:00 +0000760 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
761 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
762 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000763
Marcin Swiderski20b88732010-10-05 05:37:00 +0000764 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
765 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
766 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000767
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000768 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
769 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
770 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000771
Chandler Carruthad747252011-09-13 06:09:01 +0000772 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
773 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
774 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000775
Matthias Gehre351c2182017-07-12 07:04:19 +0000776 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
777 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
778 }
779
Peter Szecsi999a25f2017-08-19 11:19:16 +0000780 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
781 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
782 }
783
Jordan Rosed2f40792013-09-03 17:00:57 +0000784 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
785 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
786 }
787
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000788 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000789 LocalScope::const_iterator B, LocalScope::const_iterator E);
790
Matthias Gehre351c2182017-07-12 07:04:19 +0000791 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
792 LocalScope::const_iterator B,
793 LocalScope::const_iterator E);
794
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000795 const VarDecl *
796 prependAutomaticObjScopeEndWithTerminator(CFGBlock *Blk,
797 LocalScope::const_iterator B,
798 LocalScope::const_iterator E);
799
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000800 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
801 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
802 cfg->getBumpVectorContext());
803 }
804
805 /// Add a reachable successor to a block, with the alternate variant that is
806 /// unreachable.
807 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
808 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
809 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000810 }
Mike Stump11289f42009-09-09 15:08:12 +0000811
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000812 void appendScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
813 if (BuildOpts.AddScopes)
814 B->appendScopeBegin(VD, S, cfg->getBumpVectorContext());
815 }
816
817 void prependScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
818 if (BuildOpts.AddScopes)
819 B->prependScopeBegin(VD, S, cfg->getBumpVectorContext());
820 }
821
822 void appendScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
823 if (BuildOpts.AddScopes)
824 B->appendScopeEnd(VD, S, cfg->getBumpVectorContext());
825 }
826
827 void prependScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
828 if (BuildOpts.AddScopes)
829 B->prependScopeEnd(VD, S, cfg->getBumpVectorContext());
830 }
831
Richard Trieuf935b562014-04-05 05:17:01 +0000832 /// \brief Find a relational comparison with an expression evaluating to a
833 /// boolean and a constant other than 0 and 1.
834 /// e.g. if ((x < y) == 10)
835 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
836 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
837 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
838
839 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
840 const Expr *BoolExpr = RHSExpr;
841 bool IntFirst = true;
842 if (!IntLiteral) {
843 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
844 BoolExpr = LHSExpr;
845 IntFirst = false;
846 }
847
848 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
849 return TryResult();
850
851 llvm::APInt IntValue = IntLiteral->getValue();
852 if ((IntValue == 1) || (IntValue == 0))
853 return TryResult();
854
855 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
856 !IntValue.isNegative();
857
858 BinaryOperatorKind Bok = B->getOpcode();
859 if (Bok == BO_GT || Bok == BO_GE) {
860 // Always true for 10 > bool and bool > -1
861 // Always false for -1 > bool and bool > 10
862 return TryResult(IntFirst == IntLarger);
863 } else {
864 // Always true for -1 < bool and bool < 10
865 // Always false for 10 < bool and bool < -1
866 return TryResult(IntFirst != IntLarger);
867 }
868 }
869
Jordan Rose7afd71e2014-05-20 17:31:11 +0000870 /// Find an incorrect equality comparison. Either with an expression
871 /// evaluating to a boolean and a constant other than 0 and 1.
872 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
873 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000874 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
875 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
876 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
877
878 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
879 const Expr *BoolExpr = RHSExpr;
880
881 if (!IntLiteral) {
882 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
883 BoolExpr = LHSExpr;
884 }
885
Jordan Rose7afd71e2014-05-20 17:31:11 +0000886 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000887 return TryResult();
888
Jordan Rose7afd71e2014-05-20 17:31:11 +0000889 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
890 if (BitOp && (BitOp->getOpcode() == BO_And ||
891 BitOp->getOpcode() == BO_Or)) {
892 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
893 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
894
895 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
896
897 if (!IntLiteral2)
898 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
899
900 if (!IntLiteral2)
901 return TryResult();
902
903 llvm::APInt L1 = IntLiteral->getValue();
904 llvm::APInt L2 = IntLiteral2->getValue();
905 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
906 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
907 if (BuildOpts.Observer)
908 BuildOpts.Observer->compareBitwiseEquality(B,
909 B->getOpcode() != BO_EQ);
910 TryResult(B->getOpcode() != BO_EQ);
911 }
912 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
913 llvm::APInt IntValue = IntLiteral->getValue();
914 if ((IntValue == 1) || (IntValue == 0)) {
915 return TryResult();
916 }
917 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000918 }
919
Jordan Rose7afd71e2014-05-20 17:31:11 +0000920 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000921 }
922
923 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
924 const llvm::APSInt &Value1,
925 const llvm::APSInt &Value2) {
926 assert(Value1.isSigned() == Value2.isSigned());
927 switch (Relation) {
928 default:
929 return TryResult();
930 case BO_EQ:
931 return TryResult(Value1 == Value2);
932 case BO_NE:
933 return TryResult(Value1 != Value2);
934 case BO_LT:
935 return TryResult(Value1 < Value2);
936 case BO_LE:
937 return TryResult(Value1 <= Value2);
938 case BO_GT:
939 return TryResult(Value1 > Value2);
940 case BO_GE:
941 return TryResult(Value1 >= Value2);
942 }
943 }
944
945 /// \brief Find a pair of comparison expressions with or without parentheses
946 /// with a shared variable and constants and a logical operator between them
947 /// that always evaluates to either true or false.
948 /// e.g. if (x != 3 || x != 4)
949 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
950 assert(B->isLogicalOp());
951 const BinaryOperator *LHS =
952 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
953 const BinaryOperator *RHS =
954 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
955 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000956 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000957
958 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000959 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000960
George Burgess IVced56e62015-10-01 18:47:52 +0000961 const DeclRefExpr *Decl1;
962 const Expr *Expr1;
963 BinaryOperatorKind BO1;
964 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000965
George Burgess IVced56e62015-10-01 18:47:52 +0000966 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000967 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000968
George Burgess IVced56e62015-10-01 18:47:52 +0000969 const DeclRefExpr *Decl2;
970 const Expr *Expr2;
971 BinaryOperatorKind BO2;
972 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000973
George Burgess IVced56e62015-10-01 18:47:52 +0000974 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000975 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000976
977 // Check that it is the same variable on both sides.
978 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000979 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000980
George Burgess IVced56e62015-10-01 18:47:52 +0000981 // Make sure the user's intent is clear (e.g. they're comparing against two
982 // int literals, or two things from the same enum)
983 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +0000984 return {};
George Burgess IVced56e62015-10-01 18:47:52 +0000985
Richard Trieuf935b562014-04-05 05:17:01 +0000986 llvm::APSInt L1, L2;
987
George Burgess IVced56e62015-10-01 18:47:52 +0000988 if (!Expr1->EvaluateAsInt(L1, *Context) ||
989 !Expr2->EvaluateAsInt(L2, *Context))
Eugene Zelenko38c70522017-12-07 21:55:09 +0000990 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000991
992 // Can't compare signed with unsigned or with different bit width.
993 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000994 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000995
996 // Values that will be used to determine if result of logical
997 // operator is always true/false
998 const llvm::APSInt Values[] = {
999 // Value less than both Value1 and Value2
1000 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
1001 // L1
1002 L1,
1003 // Value between Value1 and Value2
1004 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
1005 L1.isUnsigned()),
1006 // L2
1007 L2,
1008 // Value greater than both Value1 and Value2
1009 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
1010 };
1011
1012 // Check whether expression is always true/false by evaluating the following
1013 // * variable x is less than the smallest literal.
1014 // * variable x is equal to the smallest literal.
1015 // * Variable x is between smallest and largest literal.
1016 // * Variable x is equal to the largest literal.
1017 // * Variable x is greater than largest literal.
1018 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001019 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +00001020 TryResult Res1, Res2;
1021 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
1022 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
1023
1024 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001025 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001026
1027 if (B->getOpcode() == BO_LAnd) {
1028 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
1029 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
1030 } else {
1031 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
1032 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
1033 }
1034 }
1035
1036 if (AlwaysTrue || AlwaysFalse) {
1037 if (BuildOpts.Observer)
1038 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
1039 return TryResult(AlwaysTrue);
1040 }
Eugene Zelenko38c70522017-12-07 21:55:09 +00001041 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001042 }
1043
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001044 /// Try and evaluate an expression to an integer constant.
1045 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
1046 if (!BuildOpts.PruneTriviallyFalseEdges)
1047 return false;
1048 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001049 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001050 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001051 }
Mike Stump11289f42009-09-09 15:08:12 +00001052
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001053 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001054 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001055 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001056 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001057 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001058 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001059
1060 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1061 if (Bop->isLogicalOp()) {
1062 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001063 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1064 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001065 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001066
1067 // Retrieve result at first, or the map might be updated.
1068 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1069 CachedBoolEvals[S] = Result; // update or insert
1070 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001071 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001072 else {
1073 switch (Bop->getOpcode()) {
1074 default: break;
1075 // For 'x & 0' and 'x * 0', we can determine that
1076 // the value is always false.
1077 case BO_Mul:
1078 case BO_And: {
1079 // If either operand is zero, we know the value
1080 // must be false.
1081 llvm::APSInt IntVal;
1082 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001083 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001084 return TryResult(false);
1085 }
1086 }
1087 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001088 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001089 return TryResult(false);
1090 }
1091 }
1092 }
1093 break;
1094 }
1095 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001096 }
1097
1098 return evaluateAsBooleanConditionNoCache(S);
1099 }
1100
1101 /// \brief Evaluate as boolean \param E without using the cache.
1102 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1103 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1104 if (Bop->isLogicalOp()) {
1105 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1106 if (LHS.isKnown()) {
1107 // We were able to evaluate the LHS, see if we can get away with not
1108 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1109 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1110 return LHS.isTrue();
1111
1112 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1113 if (RHS.isKnown()) {
1114 if (Bop->getOpcode() == BO_LOr)
1115 return LHS.isTrue() || RHS.isTrue();
1116 else
1117 return LHS.isTrue() && RHS.isTrue();
1118 }
1119 } else {
1120 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1121 if (RHS.isKnown()) {
1122 // We can't evaluate the LHS; however, sometimes the result
1123 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1124 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1125 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001126 } else {
1127 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1128 if (BopRes.isKnown())
1129 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001130 }
1131 }
1132
Eugene Zelenko38c70522017-12-07 21:55:09 +00001133 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001134 } else if (Bop->isEqualityOp()) {
1135 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1136 if (BopRes.isKnown())
1137 return BopRes.isTrue();
1138 } else if (Bop->isRelationalOp()) {
1139 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1140 if (BopRes.isKnown())
1141 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001142 }
1143 }
1144
1145 bool Result;
1146 if (E->EvaluateAsBooleanCondition(Result, *Context))
1147 return Result;
1148
Eugene Zelenko38c70522017-12-07 21:55:09 +00001149 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001150 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001151
1152 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001153};
Mike Stump31feda52009-07-17 01:31:16 +00001154
Eugene Zelenko38c70522017-12-07 21:55:09 +00001155} // namespace
1156
Ted Kremeneka099c592011-03-10 03:50:34 +00001157inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1158 const Stmt *stmt) const {
1159 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1160}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001161
Ted Kremeneka099c592011-03-10 03:50:34 +00001162bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001163 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
1164
Ted Kremeneka099c592011-03-10 03:50:34 +00001165 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001166 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001167
1168 if (lastLookup == stmt) {
1169 if (cachedEntry) {
1170 assert(cachedEntry->first == stmt);
1171 return true;
1172 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001173 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001174 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001175
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001176 lastLookup = stmt;
1177
1178 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001179 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1180
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001181 if (!fb) {
1182 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001183 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001184 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001185 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001186
1187 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001188 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001189 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001190 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001191 }
1192
Ted Kremeneka099c592011-03-10 03:50:34 +00001193 cachedEntry = &*itr;
1194 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001195}
1196
Douglas Gregor4619e432008-12-05 23:32:09 +00001197// FIXME: Add support for dependent-sized array types in C++?
1198// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001199static const VariableArrayType *FindVA(const Type *t) {
1200 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1201 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001202 if (vat->getSizeExpr())
1203 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001204
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001205 t = vt->getElementType().getTypePtr();
1206 }
Mike Stump31feda52009-07-17 01:31:16 +00001207
Craig Topper25542942014-05-20 04:30:07 +00001208 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001209}
Mike Stump31feda52009-07-17 01:31:16 +00001210
Artem Dergachev40684812018-02-27 20:03:35 +00001211void CFGBuilder::consumeConstructionContext(
1212 const ConstructionContextLayer *Layer, CXXConstructExpr *CE) {
1213 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001214 ConstructionContextMap.lookup(CE)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001215 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001216 // We might have visited this child when we were finding construction
1217 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001218 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001219 "Already within a different construction context!");
1220 } else {
Artem Dergachev40684812018-02-27 20:03:35 +00001221 ConstructionContextMap[CE] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001222 }
1223}
1224
Artem Dergachev783a4572018-02-23 22:20:39 +00001225void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001226 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001227 if (!BuildOpts.AddRichCXXConstructors)
1228 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001229
Artem Dergachev41ffb302018-02-08 22:58:15 +00001230 if (!Child)
1231 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001232
1233 switch(Child->getStmtClass()) {
1234 case Stmt::CXXConstructExprClass:
1235 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachev40684812018-02-27 20:03:35 +00001236 consumeConstructionContext(Layer, cast<CXXConstructExpr>(Child));
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001237 break;
1238 }
1239 case Stmt::ExprWithCleanupsClass: {
1240 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001241 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001242 break;
1243 }
1244 case Stmt::CXXFunctionalCastExprClass: {
1245 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001246 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001247 break;
1248 }
1249 case Stmt::ImplicitCastExprClass: {
1250 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev66030522018-03-01 01:09:24 +00001251 // TODO: We need to support CK_ConstructorConversion, maybe other kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001252 switch (Cast->getCastKind()) {
1253 case CK_NoOp:
1254 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001255 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev13f96642018-03-09 01:39:59 +00001256 default:
1257 break;
1258 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001259 break;
1260 }
1261 case Stmt::CXXBindTemporaryExprClass: {
1262 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachev783a4572018-02-23 22:20:39 +00001263 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001264 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
1265 BTE, Layer),
Artem Dergachev783a4572018-02-23 22:20:39 +00001266 BTE->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001267 break;
1268 }
1269 case Stmt::ConditionalOperatorClass: {
1270 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001271 findConstructionContexts(Layer, CO->getLHS());
1272 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001273 break;
1274 }
1275 default:
1276 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001277 }
1278}
1279
Artem Dergachev783a4572018-02-23 22:20:39 +00001280void CFGBuilder::cleanupConstructionContext(CXXConstructExpr *CE) {
1281 assert(BuildOpts.AddRichCXXConstructors &&
1282 "We should not be managing construction contexts!");
1283 assert(ConstructionContextMap.count(CE) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001284 "Cannot exit construction context without the context!");
Artem Dergachev783a4572018-02-23 22:20:39 +00001285 ConstructionContextMap.erase(CE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001286}
1287
1288
Mike Stump31feda52009-07-17 01:31:16 +00001289/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1290/// arbitrary statement. Examples include a single expression or a function
1291/// body (compound statement). The ownership of the returned CFG is
1292/// transferred to the caller. If CFG construction fails, this method returns
1293/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001294std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001295 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001296 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001297 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001298
Mike Stump31feda52009-07-17 01:31:16 +00001299 // Create an empty block that will serve as the exit block for the CFG. Since
1300 // this is the first block added to the CFG, it will be implicitly registered
1301 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001302 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001303 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001304 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001305
Matthias Gehre351c2182017-07-12 07:04:19 +00001306 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1307 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1308
Marcin Swiderski20b88732010-10-05 05:37:00 +00001309 if (BuildOpts.AddImplicitDtors)
1310 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1311 addImplicitDtorsForDestructor(DD);
1312
Ted Kremenek9aae5132007-08-23 21:42:29 +00001313 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001314 CFGBlock *B = addStmt(Statement);
1315
1316 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001317 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001318
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001319 // For C++ constructor add initializers to CFG.
1320 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001321 for (auto *I : llvm::reverse(CD->inits())) {
1322 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001323 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001324 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001325 }
1326 }
1327
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001328 if (B)
1329 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001330
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001331 // Backpatch the gotos whose label -> block mappings we didn't know when we
1332 // encountered them.
1333 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1334 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001335
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001336 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001337 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001338 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001339
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001340 // If there is no target for the goto, then we are looking at an
1341 // incomplete AST. Handle this by not registering a successor.
1342 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001343
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001344 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001345 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1346 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001347 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1348 JT.scopePosition);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001349 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1350 B, I->scopePosition, JT.scopePosition);
1351 appendScopeBegin(JT.block, VD, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001352 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001353 }
1354
1355 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001356 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001357 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1358 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001359 // Lookup the target block.
1360 LabelMapTy::iterator LI = LabelMap.find(*I);
1361
1362 // If there is no target block that contains label, then we are looking
1363 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001364 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001365
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001366 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001367 }
Mike Stump31feda52009-07-17 01:31:16 +00001368
Mike Stump31feda52009-07-17 01:31:16 +00001369 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001370 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001371
Artem Dergachev783a4572018-02-23 22:20:39 +00001372 if (BuildOpts.AddRichCXXConstructors)
1373 assert(ConstructionContextMap.empty() &&
1374 "Not all construction contexts were cleaned up!");
1375
David Blaikiee90195c2014-08-29 18:53:26 +00001376 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001377}
Mike Stump31feda52009-07-17 01:31:16 +00001378
Ted Kremenek9aae5132007-08-23 21:42:29 +00001379/// createBlock - Used to lazily create blocks that are connected
1380/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001381CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1382 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001383 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001384 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001385 return B;
1386}
Mike Stump31feda52009-07-17 01:31:16 +00001387
Chandler Carrutha70991b2011-09-13 09:13:49 +00001388/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1389/// CFG. It is *not* connected to the current (global) successor, and instead
1390/// directly tied to the exit block in order to be reachable.
1391CFGBlock *CFGBuilder::createNoReturnBlock() {
1392 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001393 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001394 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001395 return B;
1396}
1397
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001398/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001399CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001400 if (!BuildOpts.AddInitializers)
1401 return Block;
1402
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001403 bool HasTemporaries = false;
1404
1405 // Destructors of temporaries in initialization expression should be called
1406 // after initialization finishes.
1407 Expr *Init = I->getInit();
1408 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001409 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001410
Jordan Rose6d671cc2012-09-05 22:55:23 +00001411 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001412 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001413 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001414 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1415 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001416 }
1417 }
1418
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001419 autoCreateBlock();
1420 appendInitializer(Block, I);
1421
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001422 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001423 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001424 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001425 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001426
Ted Kremenek8219b822010-12-16 07:46:53 +00001427 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001428 // For expression with temporaries go directly to subexpression to omit
1429 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001430 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1431 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001432 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1433 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1434 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1435 // may cause the same Expr to appear more than once in the CFG. Doing it
1436 // here is safe because there's only one initializer per field.
1437 autoCreateBlock();
1438 appendStmt(Block, Default);
1439 if (Stmt *Child = Default->getExpr())
1440 if (CFGBlock *R = Visit(Child))
1441 Block = R;
1442 return Block;
1443 }
1444 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001445 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001446 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001447
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001448 return Block;
1449}
1450
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001451/// \brief Retrieve the type of the temporary object whose lifetime was
1452/// extended by a local reference with the given initializer.
1453static QualType getReferenceInitTemporaryType(ASTContext &Context,
Richard Smithb8c0f552016-12-09 18:49:13 +00001454 const Expr *Init,
1455 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001456 while (true) {
1457 // Skip parentheses.
1458 Init = Init->IgnoreParens();
1459
1460 // Skip through cleanups.
1461 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1462 Init = EWC->getSubExpr();
1463 continue;
1464 }
1465
1466 // Skip through the temporary-materialization expression.
1467 if (const MaterializeTemporaryExpr *MTE
1468 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1469 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001470 if (FoundMTE)
1471 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001472 continue;
1473 }
1474
1475 // Skip derived-to-base and no-op casts.
1476 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) {
1477 if ((CE->getCastKind() == CK_DerivedToBase ||
1478 CE->getCastKind() == CK_UncheckedDerivedToBase ||
1479 CE->getCastKind() == CK_NoOp) &&
1480 Init->getType()->isRecordType()) {
1481 Init = CE->getSubExpr();
1482 continue;
1483 }
1484 }
1485
1486 // Skip member accesses into rvalues.
1487 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) {
1488 if (!ME->isArrow() && ME->getBase()->isRValue()) {
1489 Init = ME->getBase();
1490 continue;
1491 }
1492 }
1493
1494 break;
1495 }
1496
1497 return Init->getType();
1498}
Matthias Gehre351c2182017-07-12 07:04:19 +00001499
Peter Szecsi999a25f2017-08-19 11:19:16 +00001500// TODO: Support adding LoopExit element to the CFG in case where the loop is
1501// ended by ReturnStmt, GotoStmt or ThrowExpr.
1502void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1503 if(!BuildOpts.AddLoopExit)
1504 return;
1505 autoCreateBlock();
1506 appendLoopExit(Block, LoopStmt);
1507}
1508
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001509void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1510 LocalScope::const_iterator E, Stmt *S) {
1511 if (!BuildOpts.AddScopes)
1512 return;
1513
1514 if (B == E)
1515 return;
1516
1517 // To go from B to E, one first goes up the scopes from B to P
1518 // then sideways in one scope from P to P' and then down
1519 // the scopes from P' to E.
1520 // The lifetime of all objects between B and P end.
1521 LocalScope::const_iterator P = B.shared_parent(E);
1522 int Dist = B.distance(P);
1523 if (Dist <= 0)
1524 return;
1525
1526 for (LocalScope::const_iterator I = B; I != P; ++I)
1527 if (I.pointsToFirstDeclaredVar())
1528 DeclsWithEndedScope.insert(*I);
1529}
1530
Matthias Gehre351c2182017-07-12 07:04:19 +00001531void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1532 LocalScope::const_iterator E,
1533 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001534 getDeclsWithEndedScope(B, E, S);
1535 if (BuildOpts.AddScopes)
1536 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001537 if (BuildOpts.AddImplicitDtors)
1538 addAutomaticObjDtors(B, E, S);
1539 if (BuildOpts.AddLifetime)
1540 addLifetimeEnds(B, E, S);
1541}
1542
1543/// Add to current block automatic objects that leave the scope.
1544void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1545 LocalScope::const_iterator E, Stmt *S) {
1546 if (!BuildOpts.AddLifetime)
1547 return;
1548
1549 if (B == E)
1550 return;
1551
1552 // To go from B to E, one first goes up the scopes from B to P
1553 // then sideways in one scope from P to P' and then down
1554 // the scopes from P' to E.
1555 // The lifetime of all objects between B and P end.
1556 LocalScope::const_iterator P = B.shared_parent(E);
1557 int dist = B.distance(P);
1558 if (dist <= 0)
1559 return;
1560
1561 // We need to perform the scope leaving in reverse order
1562 SmallVector<VarDecl *, 10> DeclsTrivial;
1563 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1564 DeclsTrivial.reserve(dist);
1565 DeclsNonTrivial.reserve(dist);
1566
1567 for (LocalScope::const_iterator I = B; I != P; ++I)
1568 if (hasTrivialDestructor(*I))
1569 DeclsTrivial.push_back(*I);
1570 else
1571 DeclsNonTrivial.push_back(*I);
1572
1573 autoCreateBlock();
1574 // object with trivial destructor end their lifetime last (when storage
1575 // duration ends)
1576 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1577 E = DeclsTrivial.rend();
1578 I != E; ++I)
1579 appendLifetimeEnds(Block, *I, S);
1580
1581 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1582 I = DeclsNonTrivial.rbegin(),
1583 E = DeclsNonTrivial.rend();
1584 I != E; ++I)
1585 appendLifetimeEnds(Block, *I, S);
1586}
1587
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001588/// Add to current block markers for ending scopes.
1589void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1590 LocalScope::const_iterator E, Stmt *S) {
1591 // If implicit destructors are enabled, we'll add scope ends in
1592 // addAutomaticObjDtors.
1593 if (BuildOpts.AddImplicitDtors)
1594 return;
1595
1596 autoCreateBlock();
1597
1598 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1599 I != E; ++I)
1600 appendScopeEnd(Block, *I, S);
1601
1602 return;
1603}
1604
Marcin Swiderski5e415732010-09-30 23:05:00 +00001605/// addAutomaticObjDtors - Add to current block automatic objects destructors
1606/// for objects in range of local scope positions. Use S as trigger statement
1607/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001608void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001609 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001610 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001611 return;
1612
Marcin Swiderski5e415732010-09-30 23:05:00 +00001613 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001614 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001615
Chandler Carruthad747252011-09-13 06:09:01 +00001616 // We need to append the destructors in reverse order, but any one of them
1617 // may be a no-return destructor which changes the CFG. As a result, buffer
1618 // this sequence up and replay them in reverse order when appending onto the
1619 // CFGBlock(s).
1620 SmallVector<VarDecl*, 10> Decls;
1621 Decls.reserve(B.distance(E));
1622 for (LocalScope::const_iterator I = B; I != E; ++I)
1623 Decls.push_back(*I);
1624
1625 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1626 E = Decls.rend();
1627 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001628 if (hasTrivialDestructor(*I)) {
1629 // If AddScopes is enabled and *I is a first variable in a scope, add a
1630 // ScopeEnd marker in a Block.
1631 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1632 autoCreateBlock();
1633 appendScopeEnd(Block, *I, S);
1634 }
1635 continue;
1636 }
Chandler Carruthad747252011-09-13 06:09:01 +00001637 // If this destructor is marked as a no-return destructor, we need to
1638 // create a new block for the destructor which does not have as a successor
1639 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001640 QualType Ty = (*I)->getType();
1641 if (Ty->isReferenceType()) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001642 Ty = getReferenceInitTemporaryType(*Context, (*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001643 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001644 Ty = Context->getBaseElementType(Ty);
1645
Richard Trieu95a192a2015-05-28 00:14:02 +00001646 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001647 Block = createNoReturnBlock();
1648 else
Chandler Carruthad747252011-09-13 06:09:01 +00001649 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001650
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001651 // Add ScopeEnd just after automatic obj destructor.
1652 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1653 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001654 appendAutomaticObjDtor(Block, *I, S);
1655 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001656}
1657
Marcin Swiderski20b88732010-10-05 05:37:00 +00001658/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1659/// base and member objects in destructor.
1660void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001661 assert(BuildOpts.AddImplicitDtors &&
1662 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001663 const CXXRecordDecl *RD = DD->getParent();
1664
1665 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001666 for (const auto &VI : RD->vbases()) {
1667 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001668 if (!CD->hasTrivialDestructor()) {
1669 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001670 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001671 }
1672 }
1673
1674 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001675 for (const auto &BI : RD->bases()) {
1676 if (!BI.isVirtual()) {
1677 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001678 if (!CD->hasTrivialDestructor()) {
1679 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001680 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001681 }
1682 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001683 }
1684
1685 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001686 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001687 // Check for constant size array. Set type to array element type.
1688 QualType QT = FI->getType();
1689 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1690 if (AT->getSize() == 0)
1691 continue;
1692 QT = AT->getElementType();
1693 }
1694
1695 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001696 if (!CD->hasTrivialDestructor()) {
1697 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001698 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001699 }
1700 }
1701}
1702
Marcin Swiderski5e415732010-09-30 23:05:00 +00001703/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1704/// way return valid LocalScope object.
1705LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001706 if (Scope)
1707 return Scope;
1708 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1709 return new (alloc.Allocate<LocalScope>())
1710 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001711}
1712
1713/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +00001714/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001715void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001716 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1717 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001718 return;
1719
Craig Topper25542942014-05-20 04:30:07 +00001720 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001721
1722 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001723 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001724 for (auto *BI : CS->body()) {
1725 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001726 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001727 Scope = addLocalScopeForDeclStmt(DS, Scope);
1728 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001729 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001730 }
1731
1732 // For any other statement scope will be implicit and as such will be
1733 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001734 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001735 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001736}
1737
1738/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1739/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001740LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001741 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001742 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1743 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001744 return Scope;
1745
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001746 for (auto *DI : DS->decls())
1747 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001748 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001749 return Scope;
1750}
1751
Matthias Gehre351c2182017-07-12 07:04:19 +00001752bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1753 // Check for const references bound to temporary. Set type to pointee.
1754 QualType QT = VD->getType();
1755 if (QT.getTypePtr()->isReferenceType()) {
1756 // Attempt to determine whether this declaration lifetime-extends a
1757 // temporary.
1758 //
1759 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1760 // temporaries, and a single declaration can extend multiple temporaries.
1761 // We should look at the storage duration on each nested
1762 // MaterializeTemporaryExpr instead.
1763
1764 const Expr *Init = VD->getInit();
1765 if (!Init)
1766 return true;
1767
1768 // Lifetime-extending a temporary.
1769 bool FoundMTE = false;
1770 QT = getReferenceInitTemporaryType(*Context, Init, &FoundMTE);
1771 if (!FoundMTE)
1772 return true;
1773 }
1774
1775 // Check for constant size array. Set type to array element type.
1776 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1777 if (AT->getSize() == 0)
1778 return true;
1779 QT = AT->getElementType();
1780 }
1781
1782 // Check if type is a C++ class with non-trivial destructor.
1783 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1784 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1785 return true;
1786}
1787
Marcin Swiderski5e415732010-09-30 23:05:00 +00001788/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1789/// create add scope for automatic objects and temporary objects bound to
1790/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001791LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001792 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001793 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1794 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001795 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1796 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001797 return Scope;
1798
1799 // Check if variable is local.
1800 switch (VD->getStorageClass()) {
1801 case SC_None:
1802 case SC_Auto:
1803 case SC_Register:
1804 break;
1805 default: return Scope;
1806 }
1807
Matthias Gehre351c2182017-07-12 07:04:19 +00001808 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001809 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001810 // Add the variable to scope
1811 Scope = createOrReuseLocalScope(Scope);
1812 Scope->addVar(VD);
1813 ScopePos = Scope->begin();
1814 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001815 return Scope;
1816 }
1817
1818 assert(BuildOpts.AddLifetime);
1819 // Add the variable to scope
1820 Scope = createOrReuseLocalScope(Scope);
1821 Scope->addVar(VD);
1822 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001823 return Scope;
1824}
1825
1826/// addLocalScopeAndDtors - For given statement add local scope for it and
1827/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001828void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001829 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001830 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001831 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001832}
1833
Marcin Swiderski321a7072010-09-30 22:54:37 +00001834/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1835/// variables with automatic storage duration to CFGBlock's elements vector.
1836/// Elements will be prepended to physical beginning of the vector which
1837/// happens to be logical end. Use blocks terminator as statement that specifies
1838/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001839/// FIXME: This mechanism for adding automatic destructors doesn't handle
1840/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001841void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001842 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001843 if (!BuildOpts.AddImplicitDtors)
1844 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001845 BumpVectorContext &C = cfg->getBumpVectorContext();
1846 CFGBlock::iterator InsertPos
1847 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1848 for (LocalScope::const_iterator I = B; I != E; ++I)
1849 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1850 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001851}
1852
Matthias Gehre351c2182017-07-12 07:04:19 +00001853/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1854/// variables with automatic storage duration to CFGBlock's elements vector.
1855/// Elements will be prepended to physical beginning of the vector which
1856/// happens to be logical end. Use blocks terminator as statement that specifies
1857/// where lifetime ends.
1858void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1859 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1860 if (!BuildOpts.AddLifetime)
1861 return;
1862 BumpVectorContext &C = cfg->getBumpVectorContext();
1863 CFGBlock::iterator InsertPos =
1864 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1865 for (LocalScope::const_iterator I = B; I != E; ++I)
1866 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1867}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001868
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001869/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
1870/// variables with automatic storage duration to CFGBlock's elements vector.
1871/// Elements will be prepended to physical beginning of the vector which
1872/// happens to be logical end. Use blocks terminator as statement that specifies
1873/// where scope ends.
1874const VarDecl *
1875CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
1876 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1877 if (!BuildOpts.AddScopes)
1878 return nullptr;
1879 BumpVectorContext &C = cfg->getBumpVectorContext();
1880 CFGBlock::iterator InsertPos =
1881 Blk->beginScopeEndInsert(Blk->end(), 1, C);
1882 LocalScope::const_iterator PlaceToInsert = B;
1883 for (LocalScope::const_iterator I = B; I != E; ++I)
1884 PlaceToInsert = I;
1885 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminator());
1886 return *PlaceToInsert;
1887}
1888
Ted Kremenek93668002009-07-17 22:18:43 +00001889/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001890/// blocks for ternary operators, &&, and ||. We also process "," and
1891/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001892CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001893 if (!S) {
1894 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001895 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001896 }
Jordy Rose17347372011-06-10 08:49:37 +00001897
1898 if (Expr *E = dyn_cast<Expr>(S))
1899 S = E->IgnoreParens();
1900
Ted Kremenek93668002009-07-17 22:18:43 +00001901 switch (S->getStmtClass()) {
1902 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001903 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001904
1905 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001906 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001907
John McCallc07a0c72011-02-17 10:25:35 +00001908 case Stmt::BinaryConditionalOperatorClass:
1909 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1910
Ted Kremenek93668002009-07-17 22:18:43 +00001911 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001912 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001913
Ted Kremenek93668002009-07-17 22:18:43 +00001914 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00001915 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001916
Ted Kremenek93668002009-07-17 22:18:43 +00001917 case Stmt::BreakStmtClass:
1918 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001919
Ted Kremenek93668002009-07-17 22:18:43 +00001920 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001921 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001922 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001923 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001924 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001925
Ted Kremenek93668002009-07-17 22:18:43 +00001926 case Stmt::CaseStmtClass:
1927 return VisitCaseStmt(cast<CaseStmt>(S));
1928
1929 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001930 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001931
Ted Kremenek93668002009-07-17 22:18:43 +00001932 case Stmt::CompoundStmtClass:
1933 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001934
Ted Kremenek93668002009-07-17 22:18:43 +00001935 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001936 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001937
Ted Kremenek93668002009-07-17 22:18:43 +00001938 case Stmt::ContinueStmtClass:
1939 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001940
Ted Kremenekb27378c2010-01-19 20:40:33 +00001941 case Stmt::CXXCatchStmtClass:
1942 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1943
John McCall5d413782010-12-06 08:20:24 +00001944 case Stmt::ExprWithCleanupsClass:
1945 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001946
Jordan Rosee5d53932012-08-23 18:10:53 +00001947 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001948 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001949 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1950 // called function's declaration, not by the caller. If we simply add
1951 // this expression to the CFG, we could end up with the same Expr
1952 // appearing multiple times.
1953 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001954 //
1955 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1956 // expression to be used in the same function (through aggregate
1957 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00001958 return VisitStmt(S, asc);
1959
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001960 case Stmt::CXXBindTemporaryExprClass:
1961 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
1962
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001963 case Stmt::CXXConstructExprClass:
1964 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
1965
Jordan Rosec9176072014-01-13 17:59:19 +00001966 case Stmt::CXXNewExprClass:
1967 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
1968
Jordan Rosed2f40792013-09-03 17:00:57 +00001969 case Stmt::CXXDeleteExprClass:
1970 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
1971
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001972 case Stmt::CXXFunctionalCastExprClass:
1973 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
1974
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001975 case Stmt::CXXTemporaryObjectExprClass:
1976 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
1977
Ted Kremenekb27378c2010-01-19 20:40:33 +00001978 case Stmt::CXXThrowExprClass:
1979 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001980
Ted Kremenekb27378c2010-01-19 20:40:33 +00001981 case Stmt::CXXTryStmtClass:
1982 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001983
Richard Smith02e85f32011-04-14 22:09:26 +00001984 case Stmt::CXXForRangeStmtClass:
1985 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
1986
Ted Kremenek93668002009-07-17 22:18:43 +00001987 case Stmt::DeclStmtClass:
1988 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001989
Ted Kremenek93668002009-07-17 22:18:43 +00001990 case Stmt::DefaultStmtClass:
1991 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001992
Ted Kremenek93668002009-07-17 22:18:43 +00001993 case Stmt::DoStmtClass:
1994 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001995
Ted Kremenek93668002009-07-17 22:18:43 +00001996 case Stmt::ForStmtClass:
1997 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001998
Ted Kremenek93668002009-07-17 22:18:43 +00001999 case Stmt::GotoStmtClass:
2000 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002001
Ted Kremenek93668002009-07-17 22:18:43 +00002002 case Stmt::IfStmtClass:
2003 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002004
Ted Kremenek8219b822010-12-16 07:46:53 +00002005 case Stmt::ImplicitCastExprClass:
2006 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002007
Ted Kremenek93668002009-07-17 22:18:43 +00002008 case Stmt::IndirectGotoStmtClass:
2009 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002010
Ted Kremenek93668002009-07-17 22:18:43 +00002011 case Stmt::LabelStmtClass:
2012 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002013
Ted Kremenekda76a942012-04-12 20:34:52 +00002014 case Stmt::LambdaExprClass:
2015 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2016
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002017 case Stmt::MaterializeTemporaryExprClass:
2018 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2019 asc);
2020
Ted Kremenek5868ec62010-04-11 17:02:10 +00002021 case Stmt::MemberExprClass:
2022 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2023
Ted Kremenek04268232011-11-05 00:10:15 +00002024 case Stmt::NullStmtClass:
2025 return Block;
2026
Ted Kremenek93668002009-07-17 22:18:43 +00002027 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002028 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2029
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002030 case Stmt::ObjCAutoreleasePoolStmtClass:
2031 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2032
Ted Kremenek93668002009-07-17 22:18:43 +00002033 case Stmt::ObjCAtSynchronizedStmtClass:
2034 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002035
Ted Kremenek93668002009-07-17 22:18:43 +00002036 case Stmt::ObjCAtThrowStmtClass:
2037 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002038
Ted Kremenek93668002009-07-17 22:18:43 +00002039 case Stmt::ObjCAtTryStmtClass:
2040 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002041
Ted Kremenek93668002009-07-17 22:18:43 +00002042 case Stmt::ObjCForCollectionStmtClass:
2043 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002044
Ted Kremenek04268232011-11-05 00:10:15 +00002045 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002046 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002047
John McCallfe96e0b2011-11-06 09:01:30 +00002048 case Stmt::PseudoObjectExprClass:
2049 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2050
Ted Kremenek93668002009-07-17 22:18:43 +00002051 case Stmt::ReturnStmtClass:
2052 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002053
Nico Weber699670e2017-08-23 15:33:16 +00002054 case Stmt::SEHExceptStmtClass:
2055 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2056
2057 case Stmt::SEHFinallyStmtClass:
2058 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2059
2060 case Stmt::SEHLeaveStmtClass:
2061 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2062
2063 case Stmt::SEHTryStmtClass:
2064 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2065
Peter Collingbournee190dee2011-03-11 19:24:49 +00002066 case Stmt::UnaryExprOrTypeTraitExprClass:
2067 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2068 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002069
Ted Kremenek93668002009-07-17 22:18:43 +00002070 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002071 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002072
Ted Kremenek93668002009-07-17 22:18:43 +00002073 case Stmt::SwitchStmtClass:
2074 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002075
Zhanyong Wan6dace612010-11-22 08:45:56 +00002076 case Stmt::UnaryOperatorClass:
2077 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2078
Ted Kremenek93668002009-07-17 22:18:43 +00002079 case Stmt::WhileStmtClass:
2080 return VisitWhileStmt(cast<WhileStmt>(S));
2081 }
2082}
Mike Stump11289f42009-09-09 15:08:12 +00002083
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002084CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002085 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002086 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002087 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002088 }
Mike Stump11289f42009-09-09 15:08:12 +00002089
Ted Kremenek93668002009-07-17 22:18:43 +00002090 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002091}
Mike Stump31feda52009-07-17 01:31:16 +00002092
Ted Kremenek93668002009-07-17 22:18:43 +00002093/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002094CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2095 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002096
Ted Kremenek8ae67872013-02-05 22:00:19 +00002097 // Visit the children in their reverse order so that they appear in
2098 // left-to-right (natural) order in the CFG.
2099 reverse_children RChildren(S);
2100 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2101 I != E; ++I) {
2102 if (Stmt *Child = *I)
2103 if (CFGBlock *R = Visit(Child))
2104 B = R;
2105 }
2106 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002107}
Mike Stump11289f42009-09-09 15:08:12 +00002108
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002109CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2110 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002111 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002112
Ted Kremenek7c58d352011-03-10 01:14:11 +00002113 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002114 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002115 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002116 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002117
Ted Kremenek9aae5132007-08-23 21:42:29 +00002118 return Block;
2119}
Mike Stump11289f42009-09-09 15:08:12 +00002120
Zhanyong Wan6dace612010-11-22 08:45:56 +00002121CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002122 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002123 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002124 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002125 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002126 }
2127
Ted Kremenek8219b822010-12-16 07:46:53 +00002128 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002129}
2130
Ted Kremeneka16436f2012-07-14 05:04:06 +00002131CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2132 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2133 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002134
Ted Kremeneka16436f2012-07-14 05:04:06 +00002135 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002136 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002137
Craig Topper25542942014-05-20 04:30:07 +00002138 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2139 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002140}
2141
2142std::pair<CFGBlock*, CFGBlock*>
2143CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2144 Stmt *Term,
2145 CFGBlock *TrueBlock,
2146 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002147 // Introspect the RHS. If it is a nested logical operation, we recursively
2148 // build the CFG using this function. Otherwise, resort to default
2149 // CFG construction behavior.
2150 Expr *RHS = B->getRHS()->IgnoreParens();
2151 CFGBlock *RHSBlock, *ExitBlock;
2152
2153 do {
2154 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2155 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002156 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002157 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2158 break;
2159 }
2160
2161 // The RHS is not a nested logical operation. Don't push the terminator
2162 // down further, but instead visit RHS and construct the respective
2163 // pieces of the CFG, and link up the RHSBlock with the terminator
2164 // we have been provided.
2165 ExitBlock = RHSBlock = createBlock(false);
2166
Richard Trieu6a6af522017-01-04 00:46:30 +00002167 // Even though KnownVal is only used in the else branch of the next
2168 // conditional, tryEvaluateBool performs additional checking on the
2169 // Expr, so it should be called unconditionally.
2170 TryResult KnownVal = tryEvaluateBool(RHS);
2171 if (!KnownVal.isKnown())
2172 KnownVal = tryEvaluateBool(B);
2173
Ted Kremenekb50e7162012-07-14 05:04:10 +00002174 if (!Term) {
2175 assert(TrueBlock == FalseBlock);
2176 addSuccessor(RHSBlock, TrueBlock);
2177 }
2178 else {
2179 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002180 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2181 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002182 }
2183
2184 Block = RHSBlock;
2185 RHSBlock = addStmt(RHS);
2186 }
2187 while (false);
2188
2189 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002190 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002191
2192 // Generate the blocks for evaluating the LHS.
2193 Expr *LHS = B->getLHS()->IgnoreParens();
2194
2195 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2196 if (B_LHS->isLogicalOp()) {
2197 if (B->getOpcode() == BO_LOr)
2198 FalseBlock = RHSBlock;
2199 else
2200 TrueBlock = RHSBlock;
2201
2202 // For the LHS, treat 'B' as the terminator that we want to sink
2203 // into the nested branch. The RHS always gets the top-most
2204 // terminator.
2205 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2206 }
2207
2208 // Create the block evaluating the LHS.
2209 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002210 CFGBlock *LHSBlock = createBlock(false);
2211 LHSBlock->setTerminator(B);
2212
Ted Kremeneka16436f2012-07-14 05:04:06 +00002213 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002214 CFGBlock *EntryLHSBlock = addStmt(LHS);
2215
2216 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002217 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002218
2219 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002220 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002221
2222 // Now link the LHSBlock with RHSBlock.
2223 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002224 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2225 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002226 } else {
2227 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002228 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2229 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002230 }
2231
Ted Kremenekb50e7162012-07-14 05:04:10 +00002232 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002233}
2234
2235CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2236 AddStmtChoice asc) {
2237 // && or ||
2238 if (B->isLogicalOp())
2239 return VisitLogicalOperator(B);
2240
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002241 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002242 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002243 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002244 addStmt(B->getRHS());
2245 return addStmt(B->getLHS());
2246 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002247
2248 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002249 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002250 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002251 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002252 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002253 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002254 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002255 }
Mike Stump11289f42009-09-09 15:08:12 +00002256
Ted Kremenek7c58d352011-03-10 01:14:11 +00002257 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002258 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002259 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002260 }
2261
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002262 CFGBlock *RBlock = Visit(B->getRHS());
2263 CFGBlock *LBlock = Visit(B->getLHS());
2264 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2265 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2266 // return RBlock. Otherwise we'll incorrectly return NULL.
2267 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002268}
2269
Ted Kremeneke2499842012-04-12 20:03:44 +00002270CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002271 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002272 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002273 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002274 }
2275 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002276}
2277
Ted Kremenek93668002009-07-17 22:18:43 +00002278CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2279 // "break" is a control-flow statement. Thus we stop processing the current
2280 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002281 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002282 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002283
Ted Kremenek93668002009-07-17 22:18:43 +00002284 // Now create a new block that ends with the break statement.
2285 Block = createBlock(false);
2286 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002287
Ted Kremenek93668002009-07-17 22:18:43 +00002288 // If there is no target for the break, then we are looking at an incomplete
2289 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002290 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002291 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002292 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002293 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002294 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002295
Ted Kremenek9aae5132007-08-23 21:42:29 +00002296 return Block;
2297}
Mike Stump11289f42009-09-09 15:08:12 +00002298
Sebastian Redl31ad7542011-03-13 17:09:40 +00002299static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002300 QualType Ty = E->getType();
2301 if (Ty->isFunctionPointerType())
2302 Ty = Ty->getAs<PointerType>()->getPointeeType();
2303 else if (Ty->isBlockPointerType())
2304 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002305
Mike Stump04c68512010-01-21 15:20:48 +00002306 const FunctionType *FT = Ty->getAs<FunctionType>();
2307 if (FT) {
2308 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002309 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smithf623c962012-04-17 00:58:00 +00002310 Proto->isNothrow(Ctx))
Mike Stump04c68512010-01-21 15:20:48 +00002311 return false;
2312 }
2313 return true;
2314}
2315
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002316CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002317 // Compute the callee type.
2318 QualType calleeType = C->getCallee()->getType();
2319 if (calleeType == Context->BoundMemberTy) {
2320 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2321
2322 // We should only get a null bound type if processing a dependent
2323 // CFG. Recover by assuming nothing.
2324 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002325 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002326
John McCallc67067f2011-05-11 07:19:11 +00002327 // If this is a call to a no-return function, this stops the block here.
2328 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2329
Mike Stump04c68512010-01-21 15:20:48 +00002330 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002331
2332 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002333 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002334 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002335 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002336 }
2337
Jordan Rose5374c072013-08-19 16:27:28 +00002338 // If this is a call to a builtin function, it might not actually evaluate
2339 // its arguments. Don't add them to the CFG if this is the case.
2340 bool OmitArguments = false;
2341
Mike Stump92244b02010-01-19 22:00:14 +00002342 if (FunctionDecl *FD = C->getDirectCallee()) {
Nico Weber758fbac2018-02-13 21:31:47 +00002343 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002344 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002345 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002346 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00002347 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
2348 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002349 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002350
Sebastian Redl31ad7542011-03-13 17:09:40 +00002351 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002352 AddEHEdge = false;
2353
Jordan Rose5374c072013-08-19 16:27:28 +00002354 if (OmitArguments) {
2355 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2356 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2357 autoCreateBlock();
2358 appendStmt(Block, C);
2359 return Visit(C->getCallee());
2360 }
2361
2362 if (!NoReturn && !AddEHEdge) {
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002363 return VisitStmt(C, asc.withAlwaysAdd(true));
Jordan Rose5374c072013-08-19 16:27:28 +00002364 }
Mike Stump11289f42009-09-09 15:08:12 +00002365
Mike Stump92244b02010-01-19 22:00:14 +00002366 if (Block) {
2367 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002368 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002369 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002370 }
Mike Stump11289f42009-09-09 15:08:12 +00002371
Chandler Carrutha70991b2011-09-13 09:13:49 +00002372 if (NoReturn)
2373 Block = createNoReturnBlock();
2374 else
2375 Block = createBlock();
2376
Ted Kremenek2866bab2011-03-10 01:14:08 +00002377 appendStmt(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002378
Mike Stump04c68512010-01-21 15:20:48 +00002379 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002380 // Add exceptional edges.
2381 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002382 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002383 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002384 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002385 }
Mike Stump11289f42009-09-09 15:08:12 +00002386
Mike Stump8c5d7992009-07-25 21:26:53 +00002387 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002388}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002389
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002390CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2391 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002392 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002393 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002394 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002395 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002396
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002397 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002398 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002399 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002400 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002401 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002402 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002403
Ted Kremenek21822592009-07-17 18:20:32 +00002404 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002405 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002406 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002407 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002408 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002409
Ted Kremenek21822592009-07-17 18:20:32 +00002410 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002411 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002412 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002413 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2414 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002415 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002416 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002417}
Mike Stump11289f42009-09-09 15:08:12 +00002418
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002419CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002420 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002421 addLocalScopeForStmt(C);
2422
Matthias Gehre09a134e2015-11-14 00:36:50 +00002423 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002424 // If the body ends with a ReturnStmt, the dtors will be added in
2425 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002426 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002427 }
2428
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002429 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002430
2431 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2432 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002433 // If we hit a segment of code just containing ';' (NullStmts), we can
2434 // get a null block back. In such cases, just use the LastBlock
2435 if (CFGBlock *newBlock = addStmt(*I))
2436 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002437
Ted Kremenekce499c22009-08-27 23:16:26 +00002438 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002439 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002440 }
Mike Stump92244b02010-01-19 22:00:14 +00002441
Ted Kremenek93668002009-07-17 22:18:43 +00002442 return LastBlock;
2443}
Mike Stump11289f42009-09-09 15:08:12 +00002444
John McCallc07a0c72011-02-17 10:25:35 +00002445CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002446 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002447 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002448 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002449
Ted Kremenek51d40b02009-07-17 18:15:54 +00002450 // Create the confluence block that will "merge" the results of the ternary
2451 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002452 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002453 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002454 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002455 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002456
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002457 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002458
Ted Kremenek51d40b02009-07-17 18:15:54 +00002459 // Create a block for the LHS expression if there is an LHS expression. A
2460 // GCC extension allows LHS to be NULL, causing the condition to be the
2461 // value that is returned instead.
2462 // e.g: x ?: y is shorthand for: x ? x : y;
2463 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002464 Block = nullptr;
2465 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002466 const Expr *trueExpr = C->getTrueExpr();
2467 if (trueExpr != opaqueValue) {
2468 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002469 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002470 return nullptr;
2471 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002472 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002473 else
2474 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002475
Ted Kremenek51d40b02009-07-17 18:15:54 +00002476 // Create the block for the RHS expression.
2477 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002478 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002479 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002480 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002481
Richard Smithf676e452012-07-24 21:02:14 +00002482 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2483 if (BinaryOperator *Cond =
2484 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2485 if (Cond->isLogicalOp())
2486 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2487
Ted Kremenek51d40b02009-07-17 18:15:54 +00002488 // Create the block that will contain the condition.
2489 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002490
Mike Stump773582d2009-07-23 23:25:26 +00002491 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002492 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002493 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2494 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002495 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002496 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002497
Ted Kremenekd8138012011-02-24 03:09:15 +00002498 if (opaqueValue) {
2499 // Run the condition expression if it's not trivially expressed in
2500 // terms of the opaque value (or if there is no opaque value).
2501 if (condExpr != opaqueValue)
2502 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002503
Ted Kremenekd8138012011-02-24 03:09:15 +00002504 // Before that, run the common subexpression if there was one.
2505 // At least one of this or the above will be run.
2506 return addStmt(BCO->getCommon());
2507 }
2508
2509 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002510}
2511
Ted Kremenek93668002009-07-17 22:18:43 +00002512CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002513 // Check if the Decl is for an __label__. If so, elide it from the
2514 // CFG entirely.
2515 if (isa<LabelDecl>(*DS->decl_begin()))
2516 return Block;
2517
Ted Kremenek3a601142011-05-24 20:41:31 +00002518 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002519 if (DS->isSingleDecl())
2520 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002521
Craig Topper25542942014-05-20 04:30:07 +00002522 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002523
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002524 // Build an individual DeclStmt for each decl.
2525 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2526 E = DS->decl_rend();
2527 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00002528 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
Benjamin Kramerc3f89252016-10-20 14:27:22 +00002529 unsigned A = alignof(DeclStmt) < 8 ? 8 : alignof(DeclStmt);
Mike Stump11289f42009-09-09 15:08:12 +00002530
Ted Kremenek93668002009-07-17 22:18:43 +00002531 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2532 // automatically freed with the CFG.
2533 DeclGroupRef DG(*I);
2534 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00002535 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00002536 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002537 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002538
Ted Kremenek93668002009-07-17 22:18:43 +00002539 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002540 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002541 }
Mike Stump11289f42009-09-09 15:08:12 +00002542
2543 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002544}
Mike Stump11289f42009-09-09 15:08:12 +00002545
Ted Kremenek93668002009-07-17 22:18:43 +00002546/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002547/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002548CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002549 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002550 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002551
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002552 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002553 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2554 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002555 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002556 }
Mike Stump11289f42009-09-09 15:08:12 +00002557
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002558 bool HasTemporaries = false;
2559
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002560 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002561 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002562
2563 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2564 // For static variables, we need to create a branch to track
2565 // whether or not they are initialized.
2566 if (Block) {
2567 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002568 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002569 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002570 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002571 }
2572 blockAfterStaticInit = Succ;
2573 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002574
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002575 // Destructors of temporaries in initialization expression should be called
2576 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002577 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002578 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002579 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002580
Jordan Rose6d671cc2012-09-05 22:55:23 +00002581 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002582 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002583 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002584 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2585 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002586 }
2587 }
2588
2589 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002590 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002591
Artem Dergachev783a4572018-02-23 22:20:39 +00002592 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002593 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002594 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002595
Ted Kremenek213d0532012-03-22 05:57:43 +00002596 // Keep track of the last non-null block, as 'Block' can be nulled out
2597 // if the initializer expression is something like a 'while' in a
2598 // statement-expression.
2599 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002600
Ted Kremenek93668002009-07-17 22:18:43 +00002601 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002602 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002603 // For expression with temporaries go directly to subexpression to omit
2604 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002605 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2606 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2607 LastBlock = newBlock;
2608 }
2609 else {
2610 if (CFGBlock *newBlock = Visit(Init))
2611 LastBlock = newBlock;
2612 }
Ted Kremenek93668002009-07-17 22:18:43 +00002613 }
Mike Stump11289f42009-09-09 15:08:12 +00002614
Ted Kremenek93668002009-07-17 22:18:43 +00002615 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002616 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002617 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002618 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2619 LastBlock = newBlock;
2620 }
Mike Stump11289f42009-09-09 15:08:12 +00002621
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002622 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2623
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002624 // Remove variable from local scope.
2625 if (ScopePos && VD == *ScopePos)
2626 ++ScopePos;
2627
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002628 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002629 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002630 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002631 Block = createBlock(false);
2632 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002633 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002634 addSuccessor(Block, B);
2635 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002636 }
2637
2638 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002639}
2640
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002641CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002642 // We may see an if statement in the middle of a basic block, or it may be the
2643 // first statement we are processing. In either case, we create a new basic
2644 // block. First, we create the blocks for the then...else statements, and
2645 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002646 // middle of a block, we stop processing that block. That block is then the
2647 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002648
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002649 // Save local scope position because in case of condition variable ScopePos
2650 // won't be restored when traversing AST.
2651 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2652
Richard Smitha547eb22016-07-14 00:11:03 +00002653 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002654 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002655 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002656
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002657 // Create local scope for possible condition variable.
2658 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002659 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002660 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002661
Matthias Gehre351c2182017-07-12 07:04:19 +00002662 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002663
Chris Lattner57540c52011-04-15 05:22:18 +00002664 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002665 // block.
2666 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002667 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002668 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002669 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002670 }
Mike Stump31feda52009-07-17 01:31:16 +00002671
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002672 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002673 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002674
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002675 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002676 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002677
Ted Kremenek9aae5132007-08-23 21:42:29 +00002678 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002679 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002680 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002681
2682 // If branch is not a compound statement create implicit scope
2683 // and add destructors.
2684 if (!isa<CompoundStmt>(Else))
2685 addLocalScopeAndDtors(Else);
2686
Ted Kremenek93668002009-07-17 22:18:43 +00002687 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002688
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002689 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2690 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002691 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002692 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002693 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002694 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002695 }
Mike Stump31feda52009-07-17 01:31:16 +00002696
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002697 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002698 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002699 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002700 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002701 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002702 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002703 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002704
2705 // If branch is not a compound statement create implicit scope
2706 // and add destructors.
2707 if (!isa<CompoundStmt>(Then))
2708 addLocalScopeAndDtors(Then);
2709
Ted Kremenek93668002009-07-17 22:18:43 +00002710 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002711
Ted Kremenek1b379512009-04-01 03:52:47 +00002712 if (!ThenBlock) {
2713 // We can reach here if the "then" body has all NullStmts.
2714 // Create an empty block so we can distinguish between true and false
2715 // branches in path-sensitive analyses.
2716 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002717 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002718 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002719 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002720 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002721 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002722 }
2723
Ted Kremenekb50e7162012-07-14 05:04:10 +00002724 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2725 // having these handle the actual control-flow jump. Note that
2726 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2727 // we resort to the old control-flow behavior. This special handling
2728 // removes infeasible paths from the control-flow graph by having the
2729 // control-flow transfer of '&&' or '||' go directly into the then/else
2730 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002731 BinaryOperator *Cond =
2732 I->getConditionVariable()
2733 ? nullptr
2734 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2735 CFGBlock *LastBlock;
2736 if (Cond && Cond->isLogicalOp())
2737 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2738 else {
2739 // Now create a new block containing the if statement.
2740 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002741
Richard Smith509bbd12017-01-13 22:16:41 +00002742 // Set the terminator of the new block to the If statement.
2743 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002744
Richard Smith509bbd12017-01-13 22:16:41 +00002745 // See if this is a known constant.
2746 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002747
Richard Smith509bbd12017-01-13 22:16:41 +00002748 // Add the successors. If we know that specific branches are
2749 // unreachable, inform addSuccessor() of that knowledge.
2750 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2751 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002752
Richard Smith509bbd12017-01-13 22:16:41 +00002753 // Add the condition as the last statement in the new block. This may
2754 // create new blocks as the condition may contain control-flow. Any newly
2755 // created blocks will be pointed to be "Block".
2756 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002757
Richard Smith509bbd12017-01-13 22:16:41 +00002758 // If the IfStmt contains a condition variable, add it and its
2759 // initializer to the CFG.
2760 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2761 autoCreateBlock();
2762 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2763 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002764 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002765
Richard Smitha547eb22016-07-14 00:11:03 +00002766 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2767 if (Stmt *Init = I->getInit()) {
2768 autoCreateBlock();
2769 LastBlock = addStmt(Init);
2770 }
2771
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002772 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002773}
Mike Stump31feda52009-07-17 01:31:16 +00002774
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002775CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002776 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002777 //
Mike Stump31feda52009-07-17 01:31:16 +00002778 // NOTE: If a "return" appears in the middle of a block, this means that the
2779 // code afterwards is DEAD (unreachable). We still keep a basic block
2780 // for that code; a simple "mark-and-sweep" from the entry block will be
2781 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002782
2783 // Create the new block.
2784 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002785
Matthias Gehre351c2182017-07-12 07:04:19 +00002786 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002787
Artem Dergachev783a4572018-02-23 22:20:39 +00002788 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002789 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
Artem Dergachev783a4572018-02-23 22:20:39 +00002790 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002791
Pavel Labath921e7652013-09-06 08:12:48 +00002792 // If the one of the destructors does not return, we already have the Exit
2793 // block as a successor.
2794 if (!Block->hasNoReturnElement())
2795 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002796
2797 // Add the return statement to the block. This may create new blocks if R
2798 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002799 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002800}
2801
Nico Weber699670e2017-08-23 15:33:16 +00002802CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2803 // SEHExceptStmt are treated like labels, so they are the first statement in a
2804 // block.
2805
2806 // Save local scope position because in case of exception variable ScopePos
2807 // won't be restored when traversing AST.
2808 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2809
2810 addStmt(ES->getBlock());
2811 CFGBlock *SEHExceptBlock = Block;
2812 if (!SEHExceptBlock)
2813 SEHExceptBlock = createBlock();
2814
2815 appendStmt(SEHExceptBlock, ES);
2816
2817 // Also add the SEHExceptBlock as a label, like with regular labels.
2818 SEHExceptBlock->setLabel(ES);
2819
2820 // Bail out if the CFG is bad.
2821 if (badCFG)
2822 return nullptr;
2823
2824 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2825 Block = nullptr;
2826
2827 return SEHExceptBlock;
2828}
2829
2830CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2831 return VisitCompoundStmt(FS->getBlock());
2832}
2833
2834CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2835 // "__leave" is a control-flow statement. Thus we stop processing the current
2836 // block.
2837 if (badCFG)
2838 return nullptr;
2839
2840 // Now create a new block that ends with the __leave statement.
2841 Block = createBlock(false);
2842 Block->setTerminator(LS);
2843
2844 // If there is no target for the __leave, then we are looking at an incomplete
2845 // AST. This means that the CFG cannot be constructed.
2846 if (SEHLeaveJumpTarget.block) {
2847 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2848 addSuccessor(Block, SEHLeaveJumpTarget.block);
2849 } else
2850 badCFG = true;
2851
2852 return Block;
2853}
2854
2855CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2856 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2857 // processing the current block.
2858 CFGBlock *SEHTrySuccessor = nullptr;
2859
2860 if (Block) {
2861 if (badCFG)
2862 return nullptr;
2863 SEHTrySuccessor = Block;
2864 } else SEHTrySuccessor = Succ;
2865
2866 // FIXME: Implement __finally support.
2867 if (Terminator->getFinallyHandler())
2868 return NYS();
2869
2870 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2871
2872 // Create a new block that will contain the __try statement.
2873 CFGBlock *NewTryTerminatedBlock = createBlock(false);
2874
2875 // Add the terminator in the __try block.
2876 NewTryTerminatedBlock->setTerminator(Terminator);
2877
2878 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
2879 // The code after the try is the implicit successor if there's an __except.
2880 Succ = SEHTrySuccessor;
2881 Block = nullptr;
2882 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
2883 if (!ExceptBlock)
2884 return nullptr;
2885 // Add this block to the list of successors for the block with the try
2886 // statement.
2887 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
2888 }
2889 if (PrevSEHTryTerminatedBlock)
2890 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
2891 else
2892 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
2893
2894 // The code after the try is the implicit successor.
2895 Succ = SEHTrySuccessor;
2896
2897 // Save the current "__try" context.
2898 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
2899 NewTryTerminatedBlock);
2900 cfg->addTryDispatchBlock(TryTerminatedBlock);
2901
2902 // Save the current value for the __leave target.
2903 // All __leaves should go to the code following the __try
2904 // (FIXME: or if the __try has a __finally, to the __finally.)
2905 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
2906 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
2907
2908 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
2909 Block = nullptr;
2910 return addStmt(Terminator->getTryBlock());
2911}
2912
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002913CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002914 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002915 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002916 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002917
Ted Kremenek93668002009-07-17 22:18:43 +00002918 if (!LabelBlock) // This can happen when the body is empty, i.e.
2919 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002920
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002921 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2922 "label already in map");
2923 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002924
2925 // Labels partition blocks, so this is the end of the basic block we were
2926 // processing (L is the block's label). Because this is label (and we have
2927 // already processed the substatement) there is no extra control-flow to worry
2928 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002929 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002930 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002931 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002932
2933 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002934 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002935
Ted Kremenek9aae5132007-08-23 21:42:29 +00002936 // This block is now the implicit successor of other blocks.
2937 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002938
Ted Kremenek9aae5132007-08-23 21:42:29 +00002939 return LabelBlock;
2940}
2941
Devin Coughlinb6029b72015-11-25 22:35:37 +00002942CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
2943 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2944 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
2945 if (Expr *CopyExpr = CI.getCopyExpr()) {
2946 CFGBlock *Tmp = Visit(CopyExpr);
2947 if (Tmp)
2948 LastBlock = Tmp;
2949 }
2950 }
2951 return LastBlock;
2952}
2953
Ted Kremenekda76a942012-04-12 20:34:52 +00002954CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
2955 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2956 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
2957 et = E->capture_init_end(); it != et; ++it) {
2958 if (Expr *Init = *it) {
2959 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00002960 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00002961 LastBlock = Tmp;
2962 }
2963 }
2964 return LastBlock;
2965}
2966
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002967CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00002968 // Goto is a control-flow statement. Thus we stop processing the current
2969 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00002970
Ted Kremenek9aae5132007-08-23 21:42:29 +00002971 Block = createBlock(false);
2972 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00002973
2974 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002975 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00002976
Ted Kremenek9aae5132007-08-23 21:42:29 +00002977 if (I == LabelMap.end())
2978 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002979 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
2980 else {
2981 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00002982 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002983 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002984 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002985
Mike Stump31feda52009-07-17 01:31:16 +00002986 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002987}
2988
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002989CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00002990 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002991
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002992 // Save local scope position because in case of condition variable ScopePos
2993 // won't be restored when traversing AST.
2994 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2995
2996 // Create local scope for init statement and possible condition variable.
2997 // Add destructor for init statement and condition variable.
2998 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002999 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003000 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003001 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3002
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003003 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003004 addLocalScopeForVarDecl(VD);
3005 LocalScope::const_iterator ContinueScopePos = ScopePos;
3006
Matthias Gehre351c2182017-07-12 07:04:19 +00003007 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003008
Peter Szecsi999a25f2017-08-19 11:19:16 +00003009 addLoopExit(F);
3010
Mike Stump014b3ea2009-07-21 01:12:51 +00003011 // "for" is a control-flow statement. Thus we stop processing the current
3012 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003013 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003014 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003015 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003016 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003017 } else
3018 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003019
Ted Kremenek304a9532010-05-21 20:30:15 +00003020 // Save the current value for the break targets.
3021 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003022 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003023 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003024
Craig Topper25542942014-05-20 04:30:07 +00003025 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003026
Ted Kremenek9aae5132007-08-23 21:42:29 +00003027 // Now create the loop body.
3028 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003029 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003030
Ted Kremenekb50e7162012-07-14 05:04:10 +00003031 // Save the current values for Block, Succ, continue and break targets.
3032 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3033 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003034
Ted Kremenekb50e7162012-07-14 05:04:10 +00003035 // Create an empty block to represent the transition block for looping back
3036 // to the head of the loop. If we have increment code, it will
3037 // go in this block as well.
3038 Block = Succ = TransitionBlock = createBlock(false);
3039 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003040
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003041 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003042 // Generate increment code in its own basic block. This is the target of
3043 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003044 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003045 }
Mike Stump31feda52009-07-17 01:31:16 +00003046
Ted Kremenek902393b2009-04-28 00:51:56 +00003047 // Finish up the increment (or empty) block if it hasn't been already.
3048 if (Block) {
3049 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003050 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003051 return nullptr;
3052 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003053 }
Mike Stump31feda52009-07-17 01:31:16 +00003054
Ted Kremenekb50e7162012-07-14 05:04:10 +00003055 // The starting block for the loop increment is the block that should
3056 // represent the 'loop target' for looping back to the start of the loop.
3057 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3058 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003059
Ted Kremenekb50e7162012-07-14 05:04:10 +00003060 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003061 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003062
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003063 // If body is not a compound statement create implicit scope
3064 // and add destructors.
3065 if (!isa<CompoundStmt>(F->getBody()))
3066 addLocalScopeAndDtors(F->getBody());
3067
Mike Stump31feda52009-07-17 01:31:16 +00003068 // Now populate the body block, and in the process create new blocks as we
3069 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003070 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003071
Ted Kremenekb50e7162012-07-14 05:04:10 +00003072 if (!BodyBlock) {
3073 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3074 // Use the continue jump target as the proxy for the body.
3075 BodyBlock = ContinueJumpTarget.block;
3076 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003077 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003078 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003079 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00003080
3081 // Because of short-circuit evaluation, the condition of the loop can span
3082 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3083 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003084 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003085
Ted Kremenekb50e7162012-07-14 05:04:10 +00003086 do {
3087 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003088 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003089
3090 // Specially handle logical operators, which have a slightly
3091 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003092 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003093 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003094 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003095 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003096 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3097 break;
3098 }
3099
3100 // The default case when not handling logical operators.
3101 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3102 ExitConditionBlock->setTerminator(F);
3103
3104 // See if this is a known constant.
3105 TryResult KnownVal(true);
3106
3107 if (C) {
3108 // Now add the actual condition to the condition block.
3109 // Because the condition itself may contain control-flow, new blocks may
3110 // be created. Thus we update "Succ" after adding the condition.
3111 Block = ExitConditionBlock;
3112 EntryConditionBlock = addStmt(C);
3113
3114 // If this block contains a condition variable, add both the condition
3115 // variable and initializer to the CFG.
3116 if (VarDecl *VD = F->getConditionVariable()) {
3117 if (Expr *Init = VD->getInit()) {
3118 autoCreateBlock();
3119 appendStmt(Block, F->getConditionVariableDeclStmt());
3120 EntryConditionBlock = addStmt(Init);
3121 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003122 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003123 }
3124 }
3125
3126 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003127 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003128
3129 KnownVal = tryEvaluateBool(C);
3130 }
3131
3132 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003133 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003134 // Link up the condition block with the code that follows the loop. (the
3135 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003136 addSuccessor(ExitConditionBlock,
3137 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003138 } while (false);
3139
3140 // Link up the loop-back block to the entry condition block.
3141 addSuccessor(TransitionBlock, EntryConditionBlock);
3142
3143 // The condition block is the implicit successor for any code above the loop.
3144 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003145
Ted Kremenek9aae5132007-08-23 21:42:29 +00003146 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003147 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003148 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003149 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3150 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003151 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003152 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003153 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003154
3155 // There is no loop initialization. We are thus basically a while loop.
3156 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003157 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003158 Succ = EntryConditionBlock;
3159 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003160}
3161
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003162CFGBlock *
3163CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3164 AddStmtChoice asc) {
3165 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003166 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003167 MTE->getTemporary());
3168
3169 return VisitStmt(MTE, asc);
3170}
3171
Ted Kremenek5868ec62010-04-11 17:02:10 +00003172CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003173 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003174 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003175 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003176 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003177 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003178}
3179
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003180CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003181 // Objective-C fast enumeration 'for' statements:
3182 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3183 //
3184 // for ( Type newVariable in collection_expression ) { statements }
3185 //
3186 // becomes:
3187 //
3188 // prologue:
3189 // 1. collection_expression
3190 // T. jump to loop_entry
3191 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003192 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003193 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3194 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3195 // TB:
3196 // statements
3197 // T. jump to loop_entry
3198 // FB:
3199 // what comes after
3200 //
3201 // and
3202 //
3203 // Type existingItem;
3204 // for ( existingItem in expression ) { statements }
3205 //
3206 // becomes:
3207 //
Mike Stump31feda52009-07-17 01:31:16 +00003208 // the same with newVariable replaced with existingItem; the binding works
3209 // the same except that for one ObjCForCollectionStmt::getElement() returns
3210 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003211
Craig Topper25542942014-05-20 04:30:07 +00003212 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003213
Ted Kremenek9d56e642008-11-11 17:10:00 +00003214 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003215 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003216 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003217 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003218 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003219 } else
3220 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003221
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003222 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003223 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003224
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003225 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003226 ExitConditionBlock->setTerminator(S);
3227
3228 // The last statement in the block should be the ObjCForCollectionStmt, which
3229 // performs the actual binding to 'element' and determines if there are any
3230 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003231 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003232 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003233
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003234 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003235 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003236 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003237 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3238 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003239 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003240 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003241 return nullptr;
3242 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003243 }
Mike Stump31feda52009-07-17 01:31:16 +00003244
3245 // The condition block is the implicit successor for the loop body as well as
3246 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003247 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003248
Ted Kremenek9d56e642008-11-11 17:10:00 +00003249 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003250 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003251 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003252 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003253 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003254 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003255
Anna Zaks56b49752013-06-22 00:23:20 +00003256 // Add an intermediate block between the BodyBlock and the
3257 // EntryConditionBlock to represent the "loop back" transition, for looping
3258 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003259 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003260 Succ = LoopBackBlock = createBlock();
3261 LoopBackBlock->setLoopTarget(S);
3262
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003263 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003264 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003265
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003266 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003267
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003268 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003269 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003270 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003271 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003272 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003273 }
Mike Stump31feda52009-07-17 01:31:16 +00003274
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003275 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003276 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003277 }
Mike Stump31feda52009-07-17 01:31:16 +00003278
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003279 // Link up the condition block with the code that follows the loop.
3280 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003281 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003282
Ted Kremenek9d56e642008-11-11 17:10:00 +00003283 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003284 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003285 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003286}
3287
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003288CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3289 // Inline the body.
3290 return addStmt(S->getSubStmt());
3291 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3292}
3293
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003294CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003295 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003296
Ted Kremenek49805452009-05-02 01:49:13 +00003297 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003298 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003299
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003300 // The sync body starts its own basic block. This makes it a little easier
3301 // for diagnostic clients.
3302 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003303 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003304 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003305
Craig Topper25542942014-05-20 04:30:07 +00003306 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003307 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003308 }
Mike Stump31feda52009-07-17 01:31:16 +00003309
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003310 // Add the @synchronized to the CFG.
3311 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003312 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003313
Ted Kremenek49805452009-05-02 01:49:13 +00003314 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003315 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003316}
Mike Stump31feda52009-07-17 01:31:16 +00003317
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003318CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003319 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003320 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003321}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003322
John McCallfe96e0b2011-11-06 09:01:30 +00003323CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3324 autoCreateBlock();
3325
3326 // Add the PseudoObject as the last thing.
3327 appendStmt(Block, E);
3328
3329 CFGBlock *lastBlock = Block;
3330
3331 // Before that, evaluate all of the semantics in order. In
3332 // CFG-land, that means appending them in reverse order.
3333 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3334 Expr *Semantic = E->getSemanticExpr(--i);
3335
3336 // If the semantic is an opaque value, we're being asked to bind
3337 // it to its source expression.
3338 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3339 Semantic = OVE->getSourceExpr();
3340
3341 if (CFGBlock *B = Visit(Semantic))
3342 lastBlock = B;
3343 }
3344
3345 return lastBlock;
3346}
3347
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003348CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003349 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003350
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003351 // Save local scope position because in case of condition variable ScopePos
3352 // won't be restored when traversing AST.
3353 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3354
3355 // Create local scope for possible condition variable.
3356 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003357 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003358 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003359 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003360 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003361 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003362 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003363
Mike Stump014b3ea2009-07-21 01:12:51 +00003364 // "while" is a control-flow statement. Thus we stop processing the current
3365 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003366 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003367 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003368 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003369 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003370 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003371 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003372 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003373 }
Mike Stump31feda52009-07-17 01:31:16 +00003374
Craig Topper25542942014-05-20 04:30:07 +00003375 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003376
Ted Kremenek9aae5132007-08-23 21:42:29 +00003377 // Process the loop body.
3378 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003379 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003380
Ted Kremenekb50e7162012-07-14 05:04:10 +00003381 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003382 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3383 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003384 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003385
Mike Stump31feda52009-07-17 01:31:16 +00003386 // Create an empty block to represent the transition block for looping back
3387 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003388 Succ = TransitionBlock = createBlock(false);
3389 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003390 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003391
Ted Kremenek9aae5132007-08-23 21:42:29 +00003392 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003393 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003394
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003395 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003396 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003397
3398 // If body is not a compound statement create implicit scope
3399 // and add destructors.
3400 if (!isa<CompoundStmt>(W->getBody()))
3401 addLocalScopeAndDtors(W->getBody());
3402
Ted Kremenek9aae5132007-08-23 21:42:29 +00003403 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003404 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003405
Ted Kremeneke9610502007-08-30 18:39:40 +00003406 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003407 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003408 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003409 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003410 }
3411
3412 // Because of short-circuit evaluation, the condition of the loop can span
3413 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3414 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003415 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003416
3417 do {
3418 Expr *C = W->getCond();
3419
3420 // Specially handle logical operators, which have a slightly
3421 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003422 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003423 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003424 std::tie(EntryConditionBlock, ExitConditionBlock) =
3425 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003426 break;
3427 }
3428
3429 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003430 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003431 ExitConditionBlock->setTerminator(W);
3432
3433 // Now add the actual condition to the condition block.
3434 // Because the condition itself may contain control-flow, new blocks may
3435 // be created. Thus we update "Succ" after adding the condition.
3436 Block = ExitConditionBlock;
3437 Block = EntryConditionBlock = addStmt(C);
3438
3439 // If this block contains a condition variable, add both the condition
3440 // variable and initializer to the CFG.
3441 if (VarDecl *VD = W->getConditionVariable()) {
3442 if (Expr *Init = VD->getInit()) {
3443 autoCreateBlock();
3444 appendStmt(Block, W->getConditionVariableDeclStmt());
3445 EntryConditionBlock = addStmt(Init);
3446 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003447 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003448 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003449 }
Mike Stump31feda52009-07-17 01:31:16 +00003450
Ted Kremenekb50e7162012-07-14 05:04:10 +00003451 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003452 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003453
3454 // See if this is a known constant.
3455 const TryResult& KnownVal = tryEvaluateBool(C);
3456
Ted Kremenek30754282009-07-24 04:47:11 +00003457 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003458 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003459 // Link up the condition block with the code that follows the loop. (the
3460 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003461 addSuccessor(ExitConditionBlock,
3462 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003463 } while(false);
3464
3465 // Link up the loop-back block to the entry condition block.
3466 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003467
3468 // There can be no more statements in the condition block since we loop back
3469 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003470 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003471
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003472 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003473 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003474 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003475}
Mike Stump11289f42009-09-09 15:08:12 +00003476
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003477CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003478 // FIXME: For now we pretend that @catch and the code it contains does not
3479 // exit.
3480 return Block;
3481}
Mike Stump31feda52009-07-17 01:31:16 +00003482
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003483CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003484 // FIXME: This isn't complete. We basically treat @throw like a return
3485 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003486
Ted Kremenek0868eea2009-09-24 18:45:41 +00003487 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003488 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003489 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003490
Ted Kremenek93041ba2008-12-09 20:20:09 +00003491 // Create the new block.
3492 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003493
Ted Kremenek93041ba2008-12-09 20:20:09 +00003494 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003495 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003496
3497 // Add the statement to the block. This may create new blocks if S contains
3498 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003499 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003500}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003501
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003502CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003503 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003504 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003505 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003506
3507 // Create the new block.
3508 Block = createBlock(false);
3509
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003510 if (TryTerminatedBlock)
3511 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003512 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003513 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003514 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003515 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003516
3517 // Add the statement to the block. This may create new blocks if S contains
3518 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003519 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003520}
3521
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003522CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003523 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003524
Peter Szecsi999a25f2017-08-19 11:19:16 +00003525 addLoopExit(D);
3526
Mike Stump8d50b6a2009-07-21 01:27:50 +00003527 // "do...while" is a control-flow statement. Thus we stop processing the
3528 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003529 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003530 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003531 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003532 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003533 } else
3534 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003535
3536 // Because of short-circuit evaluation, the condition of the loop can span
3537 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3538 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003539 CFGBlock *ExitConditionBlock = createBlock(false);
3540 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003541
Ted Kremenek81e14852007-08-27 19:46:09 +00003542 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003543 ExitConditionBlock->setTerminator(D);
3544
3545 // Now add the actual condition to the condition block. Because the condition
3546 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003547 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003548 Block = ExitConditionBlock;
3549 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003550 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003551 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003552 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003553 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003554 }
Mike Stump31feda52009-07-17 01:31:16 +00003555
Ted Kremeneka1523a32008-02-27 07:20:00 +00003556 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003557 Succ = EntryConditionBlock;
3558
Mike Stump773582d2009-07-23 23:25:26 +00003559 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003560 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003561
Ted Kremenek9aae5132007-08-23 21:42:29 +00003562 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003563 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003564 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003565 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003566
Ted Kremenek9aae5132007-08-23 21:42:29 +00003567 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003568 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3569 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3570 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003571
Ted Kremenek9aae5132007-08-23 21:42:29 +00003572 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003573 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003574
Ted Kremenek9aae5132007-08-23 21:42:29 +00003575 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003576 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003577
Ted Kremenek9aae5132007-08-23 21:42:29 +00003578 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003579 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003580
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003581 // If body is not a compound statement create implicit scope
3582 // and add destructors.
3583 if (!isa<CompoundStmt>(D->getBody()))
3584 addLocalScopeAndDtors(D->getBody());
3585
Ted Kremenek9aae5132007-08-23 21:42:29 +00003586 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003587 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003588
Ted Kremeneke9610502007-08-30 18:39:40 +00003589 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003590 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003591 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003592 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003593 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003594 }
Mike Stump31feda52009-07-17 01:31:16 +00003595
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003596 // Add an intermediate block between the BodyBlock and the
3597 // ExitConditionBlock to represent the "loop back" transition. Create an
3598 // empty block to represent the transition block for looping back to the
3599 // head of the loop.
3600 // FIXME: Can we do this more efficiently without adding another block?
3601 Block = nullptr;
3602 Succ = BodyBlock;
3603 CFGBlock *LoopBackBlock = createBlock();
3604 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003605
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003606 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003607 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003608 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003609 else
Craig Topper25542942014-05-20 04:30:07 +00003610 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003611 }
Mike Stump31feda52009-07-17 01:31:16 +00003612
Ted Kremenek30754282009-07-24 04:47:11 +00003613 // Link up the condition block with the code that follows the loop.
3614 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003615 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003616
3617 // There can be no more statements in the body block(s) since we loop back to
3618 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003619 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003620
Ted Kremenek9aae5132007-08-23 21:42:29 +00003621 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003622 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003623 return BodyBlock;
3624}
3625
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003626CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003627 // "continue" is a control-flow statement. Thus we stop processing the
3628 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003629 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003630 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003631
Ted Kremenek9aae5132007-08-23 21:42:29 +00003632 // Now create a new block that ends with the continue statement.
3633 Block = createBlock(false);
3634 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003635
Ted Kremenek9aae5132007-08-23 21:42:29 +00003636 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003637 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003638 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003639 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003640 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003641 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003642 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003643
Ted Kremenek9aae5132007-08-23 21:42:29 +00003644 return Block;
3645}
Mike Stump11289f42009-09-09 15:08:12 +00003646
Peter Collingbournee190dee2011-03-11 19:24:49 +00003647CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3648 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003649 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003650 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003651 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003652 }
Mike Stump11289f42009-09-09 15:08:12 +00003653
Ted Kremenek93668002009-07-17 22:18:43 +00003654 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003655 CFGBlock *lastBlock = Block;
3656
Ted Kremenek93668002009-07-17 22:18:43 +00003657 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003658 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003659 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003660 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003661 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003662 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003663}
Mike Stump11289f42009-09-09 15:08:12 +00003664
Ted Kremenek93668002009-07-17 22:18:43 +00003665/// VisitStmtExpr - Utility method to handle (nested) statement
3666/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003667CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003668 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003669 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003670 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003671 }
Ted Kremenek93668002009-07-17 22:18:43 +00003672 return VisitCompoundStmt(SE->getSubStmt());
3673}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003674
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003675CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003676 // "switch" is a control-flow statement. Thus we stop processing the current
3677 // block.
Craig Topper25542942014-05-20 04:30:07 +00003678 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003679
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003680 // Save local scope position because in case of condition variable ScopePos
3681 // won't be restored when traversing AST.
3682 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3683
Richard Smitha547eb22016-07-14 00:11:03 +00003684 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003685 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003686 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003687
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003688 // Create local scope for possible condition variable.
3689 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003690 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003691 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003692
Matthias Gehre351c2182017-07-12 07:04:19 +00003693 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003694
Ted Kremenek9aae5132007-08-23 21:42:29 +00003695 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003696 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003697 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003698 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003699 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003700
3701 // Save the current "switch" context.
3702 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003703 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003704 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003705
Mike Stump31feda52009-07-17 01:31:16 +00003706 // Set the "default" case to be the block after the switch statement. If the
3707 // switch statement contains a "default:", this value will be overwritten with
3708 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003709 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003710
Ted Kremenek9aae5132007-08-23 21:42:29 +00003711 // Create a new block that will contain the switch statement.
3712 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003713
Ted Kremenek9aae5132007-08-23 21:42:29 +00003714 // Now process the switch body. The code after the switch is the implicit
3715 // successor.
3716 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003717 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003718
3719 // When visiting the body, the case statements should automatically get linked
3720 // up to the switch. We also don't keep a pointer to the body, since all
3721 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003722 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003723 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003724
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003725 // For pruning unreachable case statements, save the current state
3726 // for tracking the condition value.
3727 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3728 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003729
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003730 // Determine if the switch condition can be explicitly evaluated.
3731 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003732 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003733 bool b = tryEvaluate(Terminator->getCond(), result);
3734 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003735 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003736
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003737 // If body is not a compound statement create implicit scope
3738 // and add destructors.
3739 if (!isa<CompoundStmt>(Terminator->getBody()))
3740 addLocalScopeAndDtors(Terminator->getBody());
3741
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003742 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003743 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003744 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003745 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003746 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003747
Mike Stump31feda52009-07-17 01:31:16 +00003748 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003749 // following the switch body. Moreover, take into account if all the
3750 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003751 //
3752 // Note: We add a successor to a switch that is considered covered yet has no
3753 // case statements if the enumeration has no enumerators.
3754 bool SwitchAlwaysHasSuccessor = false;
3755 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3756 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3757 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003758 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3759 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003760
Ted Kremenek81e14852007-08-27 19:46:09 +00003761 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003762 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003763 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003764 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003765
Richard Smitha547eb22016-07-14 00:11:03 +00003766 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003767 // SwitchStmt and the condition variable initialization to the CFG.
3768 if (VarDecl *VD = Terminator->getConditionVariable()) {
3769 if (Expr *Init = VD->getInit()) {
3770 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003771 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003772 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003773 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003774 }
3775 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003776
Richard Smitha547eb22016-07-14 00:11:03 +00003777 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3778 if (Stmt *Init = Terminator->getInit()) {
3779 autoCreateBlock();
3780 LastBlock = addStmt(Init);
3781 }
3782
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003783 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003784}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003785
3786static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003787 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003788 const CaseStmt *CS,
3789 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003790 if (!switchCond)
3791 return true;
3792
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003793 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003794
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003795 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003796 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003797 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003798 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003799 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003800
3801 if (condInt == lhsInt) {
3802 addCase = true;
3803 switchExclusivelyCovered = true;
3804 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003805 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003806 if (const Expr *RHS = CS->getRHS()) {
3807 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003808 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003809 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003810 addCase = true;
3811 switchExclusivelyCovered = true;
3812 }
3813 }
3814 }
3815 }
3816 else
3817 addCase = true;
3818 }
3819 return addCase;
3820}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003821
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003822CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003823 // CaseStmts are essentially labels, so they are the first statement in a
3824 // block.
Craig Topper25542942014-05-20 04:30:07 +00003825 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003826
Ted Kremenek60fa6572010-08-04 23:54:30 +00003827 if (Stmt *Sub = CS->getSubStmt()) {
3828 // For deeply nested chains of CaseStmts, instead of doing a recursion
3829 // (which can blow out the stack), manually unroll and create blocks
3830 // along the way.
3831 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003832 CFGBlock *currentBlock = createBlock(false);
3833 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003834
Ted Kremenek60fa6572010-08-04 23:54:30 +00003835 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003836 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003837 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003838 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003839
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003840 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003841 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003842 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003843 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003844
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003845 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003846 CS = cast<CaseStmt>(Sub);
3847 Sub = CS->getSubStmt();
3848 }
3849
3850 addStmt(Sub);
3851 }
Mike Stump11289f42009-09-09 15:08:12 +00003852
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003853 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003854 if (!CaseBlock)
3855 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003856
3857 // Cases statements partition blocks, so this is the top of the basic block we
3858 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003859 CaseBlock->setLabel(CS);
3860
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003861 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003862 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003863
3864 // Add this block to the list of successors for the block with the switch
3865 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003866 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003867 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003868 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003869 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003870
Ted Kremenek9aae5132007-08-23 21:42:29 +00003871 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003872 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003873
Ted Kremenek60fa6572010-08-04 23:54:30 +00003874 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003875 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003876 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003877 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003878 // This block is now the implicit successor of other blocks.
3879 Succ = CaseBlock;
3880 }
Mike Stump31feda52009-07-17 01:31:16 +00003881
Ted Kremenek60fa6572010-08-04 23:54:30 +00003882 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003883}
Mike Stump31feda52009-07-17 01:31:16 +00003884
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003885CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003886 if (Terminator->getSubStmt())
3887 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003888
Ted Kremenek654c78f2008-02-13 22:05:39 +00003889 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003890
3891 if (!DefaultCaseBlock)
3892 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003893
3894 // Default statements partition blocks, so this is the top of the basic block
3895 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003896 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003897
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003898 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003899 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003900
Mike Stump31feda52009-07-17 01:31:16 +00003901 // Unlike case statements, we don't add the default block to the successors
3902 // for the switch statement immediately. This is done when we finish
3903 // processing the switch statement. This allows for the default case
3904 // (including a fall-through to the code after the switch statement) to always
3905 // be the last successor of a switch-terminated block.
3906
Ted Kremenek654c78f2008-02-13 22:05:39 +00003907 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003908 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003909
Ted Kremenek654c78f2008-02-13 22:05:39 +00003910 // This block is now the implicit successor of other blocks.
3911 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003912
3913 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003914}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003915
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003916CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3917 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3918 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003919 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003920
3921 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003922 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003923 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003924 TrySuccessor = Block;
3925 } else TrySuccessor = Succ;
3926
Mike Stump0bdba6c2010-01-20 01:15:34 +00003927 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003928
3929 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003930 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003931 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003932 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003933
Mike Stump0bdba6c2010-01-20 01:15:34 +00003934 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003935 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3936 // The code after the try is the implicit successor.
3937 Succ = TrySuccessor;
3938 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003939 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003940 HasCatchAll = true;
3941 }
Craig Topper25542942014-05-20 04:30:07 +00003942 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003943 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00003944 if (!CatchBlock)
3945 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003946 // Add this block to the list of successors for the block with the try
3947 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003948 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003949 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00003950 if (!HasCatchAll) {
3951 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003952 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00003953 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003954 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00003955 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003956
3957 // The code after the try is the implicit successor.
3958 Succ = TrySuccessor;
3959
Mike Stump845384a2010-01-20 01:30:58 +00003960 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00003961 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
3962 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00003963
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003964 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003965 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003966 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003967}
3968
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003969CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003970 // CXXCatchStmt are treated like labels, so they are the first statement in a
3971 // block.
3972
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003973 // Save local scope position because in case of exception variable ScopePos
3974 // won't be restored when traversing AST.
3975 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3976
3977 // Create local scope for possible exception variable.
3978 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003979 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003980 LocalScope::const_iterator BeginScopePos = ScopePos;
3981 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003982 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003983 }
3984
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003985 if (CS->getHandlerBlock())
3986 addStmt(CS->getHandlerBlock());
3987
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003988 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003989 if (!CatchBlock)
3990 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003991
3992 // CXXCatchStmt is more than just a label. They have semantic meaning
3993 // as well, as they implicitly "initialize" the catch variable. Add
3994 // it to the CFG as a CFGElement so that the control-flow of these
3995 // semantics gets captured.
3996 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003997
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003998 // Also add the CXXCatchStmt as a label, to mirror handling of regular
3999 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004000 CatchBlock->setLabel(CS);
4001
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004002 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004003 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004004 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004005
4006 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004007 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004008
4009 return CatchBlock;
4010}
4011
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004012CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004013 // C++0x for-range statements are specified as [stmt.ranged]:
4014 //
4015 // {
4016 // auto && __range = range-init;
4017 // for ( auto __begin = begin-expr,
4018 // __end = end-expr;
4019 // __begin != __end;
4020 // ++__begin ) {
4021 // for-range-declaration = *__begin;
4022 // statement
4023 // }
4024 // }
4025
4026 // Save local scope position before the addition of the implicit variables.
4027 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4028
4029 // Create local scopes and destructors for range, begin and end variables.
4030 if (Stmt *Range = S->getRangeStmt())
4031 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004032 if (Stmt *Begin = S->getBeginStmt())
4033 addLocalScopeForStmt(Begin);
4034 if (Stmt *End = S->getEndStmt())
4035 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004036 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004037
4038 LocalScope::const_iterator ContinueScopePos = ScopePos;
4039
4040 // "for" is a control-flow statement. Thus we stop processing the current
4041 // block.
Craig Topper25542942014-05-20 04:30:07 +00004042 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004043 if (Block) {
4044 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004045 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004046 LoopSuccessor = Block;
4047 } else
4048 LoopSuccessor = Succ;
4049
4050 // Save the current value for the break targets.
4051 // All breaks should go to the code following the loop.
4052 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4053 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4054
4055 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004056 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004057 ConditionBlock->setTerminator(S);
4058
4059 // Now add the actual condition to the condition block.
4060 if (Expr *C = S->getCond()) {
4061 Block = ConditionBlock;
4062 CFGBlock *BeginConditionBlock = addStmt(C);
4063 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004064 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004065 assert(BeginConditionBlock == ConditionBlock &&
4066 "condition block in for-range was unexpectedly complex");
4067 (void)BeginConditionBlock;
4068 }
4069
4070 // The condition block is the implicit successor for the loop body as well as
4071 // any code above the loop.
4072 Succ = ConditionBlock;
4073
4074 // See if this is a known constant.
4075 TryResult KnownVal(true);
4076
4077 if (S->getCond())
4078 KnownVal = tryEvaluateBool(S->getCond());
4079
4080 // Now create the loop body.
4081 {
4082 assert(S->getBody());
4083
4084 // Save the current values for Block, Succ, and continue targets.
4085 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4086 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4087
4088 // Generate increment code in its own basic block. This is the target of
4089 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004090 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004091 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004092 if (badCFG)
4093 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004094 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4095
4096 // The starting block for the loop increment is the block that should
4097 // represent the 'loop target' for looping back to the start of the loop.
4098 ContinueJumpTarget.block->setLoopTarget(S);
4099
4100 // Finish up the increment block and prepare to start the loop body.
4101 assert(Block);
4102 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004103 return nullptr;
4104 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004105
4106 // Add implicit scope and dtors for loop variable.
4107 addLocalScopeAndDtors(S->getLoopVarStmt());
4108
4109 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004110 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004111 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004112 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004113 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004114 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004115 return nullptr;
4116
Richard Smith02e85f32011-04-14 22:09:26 +00004117 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004118 addSuccessor(ConditionBlock,
4119 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004120 }
4121
4122 // Link up the condition block with the code that follows the loop (the
4123 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004124 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004125
4126 // Add the initialization statements.
4127 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004128 addStmt(S->getBeginStmt());
4129 addStmt(S->getEndStmt());
Richard Smith0c502d22011-04-18 15:49:25 +00004130 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004131}
4132
John McCall5d413782010-12-06 08:20:24 +00004133CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004134 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004135 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004136 // If adding implicit destructors visit the full expression for adding
4137 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004138 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004139 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004140
4141 // Full expression has to be added as CFGStmt so it will be sequenced
4142 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004143 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004144 }
4145 return Visit(E->getSubExpr(), asc);
4146}
4147
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004148CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4149 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004150 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004151 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004152 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004153
Artem Dergachev783a4572018-02-23 22:20:39 +00004154 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004155 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004156 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004157
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004158 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004159 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004160 }
4161 return Visit(E->getSubExpr(), asc);
4162}
4163
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004164CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4165 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004166 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004167 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004168
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004169 return VisitChildren(C);
4170}
4171
Jordan Rosec9176072014-01-13 17:59:19 +00004172CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4173 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004174 autoCreateBlock();
4175 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004176
Artem Dergachev783a4572018-02-23 22:20:39 +00004177 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004178 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004179 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004180
Jordan Rosec9176072014-01-13 17:59:19 +00004181 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004182 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004183
Jordan Rosec9176072014-01-13 17:59:19 +00004184 if (BuildOpts.AddCXXNewAllocator)
4185 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004186
Jordan Rosec9176072014-01-13 17:59:19 +00004187 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004188 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004189
Jordan Rosec9176072014-01-13 17:59:19 +00004190 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4191 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004192 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004193
Jordan Rosec9176072014-01-13 17:59:19 +00004194 return Block;
4195}
Jordan Rosed2f40792013-09-03 17:00:57 +00004196
4197CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4198 AddStmtChoice asc) {
4199 autoCreateBlock();
4200 appendStmt(Block, DE);
4201 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004202 if (!DTy.isNull()) {
4203 DTy = DTy.getNonReferenceType();
4204 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4205 if (RD) {
4206 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4207 appendDeleteDtor(Block, RD, DE);
4208 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004209 }
4210
4211 return VisitChildren(DE);
4212}
4213
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004214CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4215 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004216 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004217 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004218 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004219 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004220 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004221 }
4222 return Visit(E->getSubExpr(), asc);
4223}
4224
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004225CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4226 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004227 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004228 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004229 return VisitChildren(C);
4230}
4231
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004232CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4233 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004234 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004235 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004236 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004237 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004238 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004239}
4240
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004241CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004242 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004243 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004244
Ted Kremenekeda180e22007-08-28 19:26:49 +00004245 if (!IBlock) {
4246 IBlock = createBlock(false);
4247 cfg->setIndirectGotoBlock(IBlock);
4248 }
Mike Stump31feda52009-07-17 01:31:16 +00004249
Ted Kremenekeda180e22007-08-28 19:26:49 +00004250 // IndirectGoto is a control-flow statement. Thus we stop processing the
4251 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004252 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004253 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004254
Ted Kremenekeda180e22007-08-28 19:26:49 +00004255 Block = createBlock(false);
4256 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004257 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004258 return addStmt(I->getTarget());
4259}
4260
Manuel Klimekb5616c92014-08-07 10:42:17 +00004261CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4262 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004263 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4264
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004265tryAgain:
4266 if (!E) {
4267 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004268 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004269 }
4270 switch (E->getStmtClass()) {
4271 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004272 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004273
4274 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004275 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4276 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004277
4278 case Stmt::CXXBindTemporaryExprClass:
4279 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004280 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004281
John McCallc07a0c72011-02-17 10:25:35 +00004282 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004283 case Stmt::ConditionalOperatorClass:
4284 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004285 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004286
4287 case Stmt::ImplicitCastExprClass:
4288 // For implicit cast we want BindToTemporary to be passed further.
4289 E = cast<CastExpr>(E)->getSubExpr();
4290 goto tryAgain;
4291
Manuel Klimekb0042c42014-07-30 08:34:42 +00004292 case Stmt::CXXFunctionalCastExprClass:
4293 // For functional cast we want BindToTemporary to be passed further.
4294 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4295 goto tryAgain;
4296
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004297 case Stmt::ParenExprClass:
4298 E = cast<ParenExpr>(E)->getSubExpr();
4299 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004300
Manuel Klimekb0042c42014-07-30 08:34:42 +00004301 case Stmt::MaterializeTemporaryExprClass: {
4302 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4303 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4304 SmallVector<const Expr *, 2> CommaLHSs;
4305 SmallVector<SubobjectAdjustment, 2> Adjustments;
4306 // Find the expression whose lifetime needs to be extended.
4307 E = const_cast<Expr *>(
4308 cast<MaterializeTemporaryExpr>(E)
4309 ->GetTemporaryExpr()
4310 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4311 // Visit the skipped comma operator left-hand sides for other temporaries.
4312 for (const Expr *CommaLHS : CommaLHSs) {
4313 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004314 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004315 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004316 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004317 }
Richard Smith4137af22014-07-27 05:12:49 +00004318
4319 case Stmt::BlockExprClass:
4320 // Don't recurse into blocks; their subexpressions don't get evaluated
4321 // here.
4322 return Block;
4323
4324 case Stmt::LambdaExprClass: {
4325 // For lambda expressions, only recurse into the capture initializers,
4326 // and not the body.
4327 auto *LE = cast<LambdaExpr>(E);
4328 CFGBlock *B = Block;
4329 for (Expr *Init : LE->capture_inits()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004330 if (CFGBlock *R = VisitForTemporaryDtors(
4331 Init, /*BindToTemporary=*/false, Context))
Richard Smith4137af22014-07-27 05:12:49 +00004332 B = R;
4333 }
4334 return B;
4335 }
4336
4337 case Stmt::CXXDefaultArgExprClass:
4338 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4339 goto tryAgain;
4340
4341 case Stmt::CXXDefaultInitExprClass:
4342 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4343 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004344 }
4345}
4346
Manuel Klimekb5616c92014-08-07 10:42:17 +00004347CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4348 TempDtorContext &Context) {
4349 if (isa<LambdaExpr>(E)) {
4350 // Do not visit the children of lambdas; they have their own CFGs.
4351 return Block;
4352 }
4353
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004354 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004355 // order that they will appear in the CFG. Because the CFG is built
4356 // bottom-up, this means we visit them in their natural order, which
4357 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004358 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004359 for (Stmt *Child : E->children())
4360 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004361 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004362 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004363
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004364 return B;
4365}
4366
Manuel Klimekb5616c92014-08-07 10:42:17 +00004367CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4368 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004369 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004370 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004371 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4372 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4373 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004374
Manuel Klimekedf925b92014-08-07 18:44:19 +00004375 // We do not know at CFG-construction time whether the right-hand-side was
4376 // executed, thus we add a branch node that depends on the temporary
4377 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004378 TempDtorContext RHSContext(
4379 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004380 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004381 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004382
Manuel Klimekb5616c92014-08-07 10:42:17 +00004383 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004384 }
4385
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004386 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004387 // For assignment operator (=) LHS expression is visited
4388 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004389 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4390 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004391 return LHSBlock ? LHSBlock : RHSBlock;
4392 }
4393
4394 // For any other binary operator RHS expression is visited before
4395 // LHS expression (order of children). For destructors visit them in reverse
4396 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004397 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4398 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004399 return RHSBlock ? RHSBlock : LHSBlock;
4400}
4401
4402CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004403 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004404 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004405 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004406 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004407 // If lifetime of temporary is not prolonged (by assigning to constant
4408 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004409
Chandler Carruthad747252011-09-13 06:09:01 +00004410 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004411
Richard Trieu95a192a2015-05-28 00:14:02 +00004412 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004413 // If the destructor is marked as a no-return destructor, we need to
4414 // create a new block for the destructor which does not have as a
4415 // successor anything built thus far. Control won't flow out of this
4416 // block.
4417 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004418 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004419 } else if (Context.needsTempDtorBranch()) {
4420 // If we need to introduce a branch, we add a new block that we will hook
4421 // up to a decision block later.
4422 if (B) Succ = B;
4423 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004424 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004425 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004426 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004427 if (Context.needsTempDtorBranch()) {
4428 Context.setDecisionPoint(Succ, E);
4429 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004430 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004431
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004432 B = Block;
4433 }
4434 return B;
4435}
4436
Manuel Klimekb5616c92014-08-07 10:42:17 +00004437void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4438 CFGBlock *FalseSucc) {
4439 if (!Context.TerminatorExpr) {
4440 // If no temporary was found, we do not need to insert a decision point.
4441 return;
4442 }
4443 assert(Context.TerminatorExpr);
4444 CFGBlock *Decision = createBlock(false);
4445 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004446 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004447 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004448 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004449 Block = Decision;
4450}
4451
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004452CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004453 AbstractConditionalOperator *E, bool BindToTemporary,
4454 TempDtorContext &Context) {
4455 VisitForTemporaryDtors(E->getCond(), false, Context);
4456 CFGBlock *ConditionBlock = Block;
4457 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004458 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004459 TryResult NegatedVal = ConditionVal;
4460 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004461
Manuel Klimekdeb02622014-08-08 07:37:13 +00004462 TempDtorContext TrueContext(
4463 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004464 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004465 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004466
Manuel Klimekb5616c92014-08-07 10:42:17 +00004467 Block = ConditionBlock;
4468 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004469 TempDtorContext FalseContext(
4470 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004471 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004472
Manuel Klimekb5616c92014-08-07 10:42:17 +00004473 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004474 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004475 } else if (TrueContext.TerminatorExpr) {
4476 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004477 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004478 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004479 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004480 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004481 return Block;
4482}
4483
Mike Stump31feda52009-07-17 01:31:16 +00004484/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4485/// no successors or predecessors. If this is the first block created in the
4486/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004487CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004488 bool first_block = begin() == end();
4489
4490 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004491 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004492 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004493 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004494
4495 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004496 if (first_block)
4497 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004498
4499 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004500 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004501}
4502
David Blaikiee90195c2014-08-29 18:53:26 +00004503/// buildCFG - Constructs a CFG from an AST.
4504std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4505 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004506 CFGBuilder Builder(C, BO);
4507 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004508}
4509
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004510const CXXDestructorDecl *
4511CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004512 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004513 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004514 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004515 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004516 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004517 case CFGElement::Statement:
4518 case CFGElement::Constructor:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004519 case CFGElement::ScopeBegin:
4520 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004521 llvm_unreachable("getDestructorDecl should only be used with "
4522 "ImplicitDtors");
4523 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004524 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004525 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004526
4527 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4528 //
4529 // Lifetime-extending constructs are handled here. This works for a single
4530 // temporary in an initializer expression.
4531 if (ty->isReferenceType()) {
4532 if (const Expr *Init = var->getInit()) {
4533 ty = getReferenceInitTemporaryType(astContext, Init);
4534 }
4535 }
4536
Ted Kremeneke7d78882012-03-19 23:48:41 +00004537 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004538 ty = arrayType->getElementType();
4539 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004540 const RecordType *recordType = ty->getAs<RecordType>();
4541 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004542 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004543 return classDecl->getDestructor();
4544 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004545 case CFGElement::DeleteDtor: {
4546 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4547 QualType DTy = DE->getDestroyedType();
4548 DTy = DTy.getNonReferenceType();
4549 const CXXRecordDecl *classDecl =
4550 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4551 return classDecl->getDestructor();
4552 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004553 case CFGElement::TemporaryDtor: {
4554 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004555 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004556 const CXXTemporary *temp = bindExpr->getTemporary();
4557 return temp->getDestructor();
4558 }
4559 case CFGElement::BaseDtor:
4560 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004561 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004562 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004563 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004564 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004565}
4566
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004567bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004568 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4569 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004570 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004571}
4572
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004573//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004574// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004575//===----------------------------------------------------------------------===//
4576
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004577CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004578 : ReachableBlock(IsReachable ? B : nullptr),
4579 UnreachableBlock(!IsReachable ? B : nullptr,
4580 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004581
4582CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004583 : ReachableBlock(B),
4584 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4585 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004586
4587void CFGBlock::addSuccessor(AdjacentBlock Succ,
4588 BumpVectorContext &C) {
4589 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004590 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004591
4592 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004593 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004594
4595 Succs.push_back(Succ, C);
4596}
4597
Ted Kremenekb0371852010-09-09 00:06:04 +00004598bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004599 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004600 if (F.IgnoreNullPredecessors && !From)
4601 return true;
4602
4603 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004604 // If the 'To' has no label or is labeled but the label isn't a
4605 // CaseStmt then filter this edge.
4606 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004607 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004608 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004609 const Stmt *L = To->getLabel();
4610 if (!L || !isa<CaseStmt>(L))
4611 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004612 }
4613 }
4614 }
4615
4616 return false;
4617}
4618
4619//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004620// CFG pretty printing
4621//===----------------------------------------------------------------------===//
4622
Ted Kremenek7e776b12007-08-22 18:22:34 +00004623namespace {
4624
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004625class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004626 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4627 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4628
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004629 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004630 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004631 signed currentBlock = 0;
4632 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004633 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004634
Eugene Zelenko38c70522017-12-07 21:55:09 +00004635public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004636 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004637 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004638 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4639 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004640 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004641 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004642 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4643 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004644 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004645 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004646
Ted Kremenek96a7a592011-03-01 03:15:10 +00004647 switch (stmt->getStmtClass()) {
4648 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004649 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4650 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004651 case Stmt::IfStmtClass: {
4652 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4653 if (var)
4654 DeclMap[var] = P;
4655 break;
4656 }
4657 case Stmt::ForStmtClass: {
4658 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4659 if (var)
4660 DeclMap[var] = P;
4661 break;
4662 }
4663 case Stmt::WhileStmtClass: {
4664 const VarDecl *var =
4665 cast<WhileStmt>(stmt)->getConditionVariable();
4666 if (var)
4667 DeclMap[var] = P;
4668 break;
4669 }
4670 case Stmt::SwitchStmtClass: {
4671 const VarDecl *var =
4672 cast<SwitchStmt>(stmt)->getConditionVariable();
4673 if (var)
4674 DeclMap[var] = P;
4675 break;
4676 }
4677 case Stmt::CXXCatchStmtClass: {
4678 const VarDecl *var =
4679 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4680 if (var)
4681 DeclMap[var] = P;
4682 break;
4683 }
4684 default:
4685 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004686 }
4687 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004688 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004689 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004690 }
Mike Stump31feda52009-07-17 01:31:16 +00004691
Eugene Zelenko38c70522017-12-07 21:55:09 +00004692 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004693
Chris Lattnerc61089a2009-06-30 01:26:17 +00004694 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004695 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004696 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004697
Craig Topperb45acb82014-03-14 06:02:07 +00004698 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004699 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004700
4701 if (I == StmtMap.end())
4702 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004703
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004704 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004705 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004706 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004707 }
Mike Stump31feda52009-07-17 01:31:16 +00004708
Ted Kremenek60983dc2010-01-19 20:52:05 +00004709 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004710 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004711 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004712
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004713 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004714 DeclMapTy::iterator I = DeclMap.find(D);
4715
4716 if (I == DeclMap.end())
4717 return false;
4718
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004719 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004720 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004721 return false;
4722 }
4723
4724 OS << "[B" << I->second.first << "." << I->second.second << "]";
4725 return true;
4726 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004727};
4728
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004729class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004730 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004731 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004732 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004733 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004734
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004735public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004736 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004737 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004738 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004739 this->Policy.IncludeNewlines = false;
4740 }
Mike Stump31feda52009-07-17 01:31:16 +00004741
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004742 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004743 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004744 if (Stmt *C = I->getCond())
4745 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004746 }
Mike Stump31feda52009-07-17 01:31:16 +00004747
Ted Kremenek9aae5132007-08-23 21:42:29 +00004748 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004749 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004750 Terminator->printPretty(OS, Helper, Policy);
4751 }
4752
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004753 void VisitDeclStmt(DeclStmt *DS) {
4754 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4755 OS << "static init " << VD->getName();
4756 }
4757
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004758 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004759 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004760 if (F->getInit())
4761 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004762 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004763 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004764 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004765 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004766 if (F->getInc())
4767 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004768 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004769 }
Mike Stump31feda52009-07-17 01:31:16 +00004770
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004771 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004772 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004773 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004774 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004775 }
Mike Stump31feda52009-07-17 01:31:16 +00004776
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004777 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004778 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004779 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004780 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004781 }
Mike Stump31feda52009-07-17 01:31:16 +00004782
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004783 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004784 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004785 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004786 }
Mike Stump31feda52009-07-17 01:31:16 +00004787
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004788 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004789 OS << "try ...";
4790 }
4791
Nico Weber699670e2017-08-23 15:33:16 +00004792 void VisitSEHTryStmt(SEHTryStmt *CS) {
4793 OS << "__try ...";
4794 }
4795
John McCallc07a0c72011-02-17 10:25:35 +00004796 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004797 if (Stmt *Cond = C->getCond())
4798 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004799 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004800 }
Mike Stump31feda52009-07-17 01:31:16 +00004801
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004802 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004803 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004804 if (Stmt *Cond = C->getCond())
4805 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004806 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004807 }
Mike Stump31feda52009-07-17 01:31:16 +00004808
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004809 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004810 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004811 if (Stmt *T = I->getTarget())
4812 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004813 }
Mike Stump31feda52009-07-17 01:31:16 +00004814
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004815 void VisitBinaryOperator(BinaryOperator* B) {
4816 if (!B->isLogicalOp()) {
4817 VisitExpr(B);
4818 return;
4819 }
Mike Stump31feda52009-07-17 01:31:16 +00004820
Richard Trieuddd01ce2014-06-09 22:53:25 +00004821 if (B->getLHS())
4822 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004823
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004824 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004825 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004826 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004827 return;
John McCalle3027922010-08-25 11:45:40 +00004828 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004829 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004830 return;
4831 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004832 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004833 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004834 }
Mike Stump31feda52009-07-17 01:31:16 +00004835
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004836 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004837 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004838 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004839
4840public:
4841 void print(CFGTerminator T) {
4842 if (T.isTemporaryDtorsBranch())
4843 OS << "(Temp Dtor) ";
4844 Visit(T.getStmt());
4845 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004846};
Eugene Zelenko38c70522017-12-07 21:55:09 +00004847
4848} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00004849
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004850static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
4851 const CXXCtorInitializer *I) {
4852 if (I->isBaseInitializer())
4853 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
4854 else if (I->isDelegatingInitializer())
4855 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
4856 else
4857 OS << I->getAnyMember()->getName();
4858 OS << "(";
4859 if (Expr *IE = I->getInit())
4860 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
4861 OS << ")";
4862
4863 if (I->isBaseInitializer())
4864 OS << " (Base initializer)";
4865 else if (I->isDelegatingInitializer())
4866 OS << " (Delegating initializer)";
4867 else
4868 OS << " (Member initializer)";
4869}
4870
Aaron Ballmanff924b02013-11-18 20:11:50 +00004871static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00004872 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004873 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4874 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00004875 assert(S != nullptr && "Expecting non-null Stmt");
4876
Aaron Ballmanff924b02013-11-18 20:11:50 +00004877 // special printing for statement-expressions.
4878 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
4879 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00004880
Benjamin Kramer5733e352015-07-18 17:09:36 +00004881 auto Children = Sub->children();
4882 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00004883 OS << "({ ... ; ";
4884 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
4885 OS << " })\n";
4886 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004887 }
4888 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00004889 // special printing for comma expressions.
4890 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
4891 if (B->getOpcode() == BO_Comma) {
4892 OS << "... , ";
4893 Helper.handledStmt(B->getRHS(),OS);
4894 OS << '\n';
4895 return;
4896 }
4897 }
4898 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00004899
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004900 if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004901 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004902 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004903 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004904 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
4905 OS << " (CXXConstructExpr, ";
4906 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev40684812018-02-27 20:03:35 +00004907 const ConstructionContext *CC = CE->getConstructionContext();
4908 const Stmt *S1 = nullptr, *S2 = nullptr;
4909 switch (CC->getKind()) {
4910 case ConstructionContext::ConstructorInitializerKind: {
4911 const auto *ICC = cast<ConstructorInitializerConstructionContext>(CC);
4912 print_initializer(OS, Helper, ICC->getCXXCtorInitializer());
4913 OS << ", ";
4914 break;
4915 }
4916 case ConstructionContext::SimpleVariableKind: {
4917 const auto *DSCC = cast<SimpleVariableConstructionContext>(CC);
4918 S1 = DSCC->getDeclStmt();
4919 break;
4920 }
4921 case ConstructionContext::NewAllocatedObjectKind: {
4922 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
4923 S1 = NECC->getCXXNewExpr();
4924 break;
4925 }
4926 case ConstructionContext::ReturnedValueKind: {
4927 const auto *RSCC = cast<ReturnedValueConstructionContext>(CC);
4928 S1 = RSCC->getReturnStmt();
4929 break;
4930 }
4931 case ConstructionContext::TemporaryObjectKind: {
4932 const auto *TOCC = cast<TemporaryObjectConstructionContext>(CC);
4933 S1 = TOCC->getCXXBindTemporaryExpr();
4934 S2 = TOCC->getMaterializedTemporaryExpr();
4935 break;
4936 }
4937 }
4938 if (S1) {
4939 Helper.handledStmt(const_cast<Stmt *>(S1), OS);
4940 OS << ", ";
4941 }
4942 if (S2) {
4943 Helper.handledStmt(const_cast<Stmt *>(S2), OS);
4944 OS << ", ";
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00004945 }
Artem Dergachev41ffb302018-02-08 22:58:15 +00004946 }
4947 OS << CCE->getType().getAsString() << ")";
4948 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00004949 OS << " (" << CE->getStmtClassName() << ", "
4950 << CE->getCastKindName()
4951 << ", " << CE->getType().getAsString()
4952 << ")";
4953 }
Mike Stump31feda52009-07-17 01:31:16 +00004954
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004955 // Expressions need a newline.
4956 if (isa<Expr>(S))
4957 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00004958 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004959 print_initializer(OS, Helper, IE->getInitializer());
4960 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00004961 } else if (Optional<CFGAutomaticObjDtor> DE =
4962 E.getAs<CFGAutomaticObjDtor>()) {
4963 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00004964 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004965
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00004966 const Type* T = VD->getType().getTypePtr();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004967 if (const ReferenceType* RT = T->getAs<ReferenceType>())
4968 T = RT->getPointeeType().getTypePtr();
Richard Smithf676e452012-07-24 21:02:14 +00004969 T = T->getBaseElementTypeUnsafe();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004970
4971 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
4972 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00004973 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
4974 const VarDecl *VD = DE->getVarDecl();
4975 Helper.handleDecl(VD, OS);
4976
4977 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00004978 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
4979 const Stmt *LoopStmt = LE->getLoopStmt();
4980 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004981 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
4982 OS << "CFGScopeBegin(";
4983 if (const VarDecl *VD = SB->getVarDecl())
4984 OS << VD->getQualifiedNameAsString();
4985 OS << ")\n";
4986 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
4987 OS << "CFGScopeEnd(";
4988 if (const VarDecl *VD = SE->getVarDecl())
4989 OS << VD->getQualifiedNameAsString();
4990 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00004991 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
4992 OS << "CFGNewAllocator(";
4993 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
4994 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
4995 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00004996 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
4997 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
4998 if (!RD)
4999 return;
5000 CXXDeleteExpr *DelExpr =
5001 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005002 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005003 OS << "->~" << RD->getName().str() << "()";
5004 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005005 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5006 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005007 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005008 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005009 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5010 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005011 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005012 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005013 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005014 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005015 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5016 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005017 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005018 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005019 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005020 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005021}
Mike Stump31feda52009-07-17 01:31:16 +00005022
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005023static void print_block(raw_ostream &OS, const CFG* cfg,
5024 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005025 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005026 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005027 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005028
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005029 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005030 if (ShowColors)
5031 OS.changeColor(raw_ostream::YELLOW, true);
5032
5033 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005034
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005035 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005036 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005037 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005038 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005039 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005040 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005041 else if (B.hasNoReturnElement())
5042 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005043 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005044 OS << "]\n";
5045
5046 if (ShowColors)
5047 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005048
Ted Kremenek71eca012007-08-29 23:20:49 +00005049 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005050 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005051 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005052 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005053
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005054 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005055 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005056 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005057 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005058 if (C->getLHS())
5059 C->getLHS()->printPretty(OS, &Helper,
5060 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005061 if (C->getRHS()) {
5062 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005063 C->getRHS()->printPretty(OS, &Helper,
5064 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005065 }
Mike Stump92244b02010-01-19 22:00:14 +00005066 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005067 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005068 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005069 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005070 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005071 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005072 0);
5073 else
5074 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005075 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005076 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5077 OS << "__except (";
5078 ES->getFilterExpr()->printPretty(OS, &Helper,
5079 PrintingPolicy(Helper.getLangOpts()), 0);
5080 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005081 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005082 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005083
Ted Kremenek71eca012007-08-29 23:20:49 +00005084 OS << ":\n";
5085 }
Mike Stump31feda52009-07-17 01:31:16 +00005086
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005087 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005088 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005089
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005090 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5091 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005092 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005093 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005094 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005095
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005096 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005097
Aaron Ballmanff924b02013-11-18 20:11:50 +00005098 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005099
Ted Kremenek72be32a2011-12-22 23:33:52 +00005100 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005101 }
Mike Stump31feda52009-07-17 01:31:16 +00005102
Ted Kremenek71eca012007-08-29 23:20:49 +00005103 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005104 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005105 if (ShowColors)
5106 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005107
Ted Kremenek72be32a2011-12-22 23:33:52 +00005108 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005109
Aaron Ballmanff924b02013-11-18 20:11:50 +00005110 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005111
Aaron Ballmanff924b02013-11-18 20:11:50 +00005112 PrintingPolicy PP(Helper.getLangOpts());
5113 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005114 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005115 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00005116
5117 if (ShowColors)
5118 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005119 }
Mike Stump31feda52009-07-17 01:31:16 +00005120
Ted Kremenek71eca012007-08-29 23:20:49 +00005121 if (print_edges) {
5122 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005123 if (!B.pred_empty()) {
5124 const raw_ostream::Colors Color = raw_ostream::BLUE;
5125 if (ShowColors)
5126 OS.changeColor(Color);
5127 OS << " Preds " ;
5128 if (ShowColors)
5129 OS.resetColor();
5130 OS << '(' << B.pred_size() << "):";
5131 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005132
Ted Kremenek72be32a2011-12-22 23:33:52 +00005133 if (ShowColors)
5134 OS.changeColor(Color);
5135
5136 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5137 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005138 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005139 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005140
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005141 CFGBlock *B = *I;
5142 bool Reachable = true;
5143 if (!B) {
5144 Reachable = false;
5145 B = I->getPossiblyUnreachableBlock();
5146 }
5147
5148 OS << " B" << B->getBlockID();
5149 if (!Reachable)
5150 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005151 }
5152
5153 if (ShowColors)
5154 OS.resetColor();
5155
5156 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005157 }
Mike Stump31feda52009-07-17 01:31:16 +00005158
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005159 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005160 if (!B.succ_empty()) {
5161 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5162 if (ShowColors)
5163 OS.changeColor(Color);
5164 OS << " Succs ";
5165 if (ShowColors)
5166 OS.resetColor();
5167 OS << '(' << B.succ_size() << "):";
5168 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005169
Ted Kremenek72be32a2011-12-22 23:33:52 +00005170 if (ShowColors)
5171 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005172
Ted Kremenek72be32a2011-12-22 23:33:52 +00005173 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5174 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005175 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005176 OS << "\n ";
5177
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005178 CFGBlock *B = *I;
5179
5180 bool Reachable = true;
5181 if (!B) {
5182 Reachable = false;
5183 B = I->getPossiblyUnreachableBlock();
5184 }
5185
5186 if (B) {
5187 OS << " B" << B->getBlockID();
5188 if (!Reachable)
5189 OS << "(Unreachable)";
5190 }
5191 else {
5192 OS << " NULL";
5193 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005194 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005195
Ted Kremenek72be32a2011-12-22 23:33:52 +00005196 if (ShowColors)
5197 OS.resetColor();
5198 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005199 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005200 }
Mike Stump31feda52009-07-17 01:31:16 +00005201}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005202
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005203/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005204void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5205 print(llvm::errs(), LO, ShowColors);
5206}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005207
5208/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005209void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005210 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005211
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005212 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005213 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005214
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005215 // Iterate through the CFGBlocks and print them one by one.
5216 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5217 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005218 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005219 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005220
Aaron Ballmanff924b02013-11-18 20:11:50 +00005221 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005222 }
Mike Stump31feda52009-07-17 01:31:16 +00005223
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005224 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005225 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005226 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005227 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005228}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005229
5230/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005231void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5232 bool ShowColors) const {
5233 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005234}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005235
Yaron Kerencdae9412016-01-29 19:38:18 +00005236LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005237 dump(getParent(), LangOptions(), false);
5238}
5239
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005240/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5241/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005242void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005243 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005244 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005245 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005246 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005247}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005248
Ted Kremenek15647632008-01-30 23:02:42 +00005249/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005250void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005251 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005252 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005253 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005254}
5255
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005256Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00005257 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005258 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005259 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005260
Craig Topper25542942014-05-20 04:30:07 +00005261 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005262
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005263 switch (Terminator->getStmtClass()) {
5264 default:
5265 break;
Mike Stump31feda52009-07-17 01:31:16 +00005266
Jordan Rosecf10ea82013-06-06 21:53:45 +00005267 case Stmt::CXXForRangeStmtClass:
5268 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5269 break;
5270
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005271 case Stmt::ForStmtClass:
5272 E = cast<ForStmt>(Terminator)->getCond();
5273 break;
Mike Stump31feda52009-07-17 01:31:16 +00005274
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005275 case Stmt::WhileStmtClass:
5276 E = cast<WhileStmt>(Terminator)->getCond();
5277 break;
Mike Stump31feda52009-07-17 01:31:16 +00005278
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005279 case Stmt::DoStmtClass:
5280 E = cast<DoStmt>(Terminator)->getCond();
5281 break;
Mike Stump31feda52009-07-17 01:31:16 +00005282
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005283 case Stmt::IfStmtClass:
5284 E = cast<IfStmt>(Terminator)->getCond();
5285 break;
Mike Stump31feda52009-07-17 01:31:16 +00005286
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005287 case Stmt::ChooseExprClass:
5288 E = cast<ChooseExpr>(Terminator)->getCond();
5289 break;
Mike Stump31feda52009-07-17 01:31:16 +00005290
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005291 case Stmt::IndirectGotoStmtClass:
5292 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5293 break;
Mike Stump31feda52009-07-17 01:31:16 +00005294
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005295 case Stmt::SwitchStmtClass:
5296 E = cast<SwitchStmt>(Terminator)->getCond();
5297 break;
Mike Stump31feda52009-07-17 01:31:16 +00005298
John McCallc07a0c72011-02-17 10:25:35 +00005299 case Stmt::BinaryConditionalOperatorClass:
5300 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5301 break;
5302
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005303 case Stmt::ConditionalOperatorClass:
5304 E = cast<ConditionalOperator>(Terminator)->getCond();
5305 break;
Mike Stump31feda52009-07-17 01:31:16 +00005306
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005307 case Stmt::BinaryOperatorClass: // '&&' and '||'
5308 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005309 break;
Mike Stump31feda52009-07-17 01:31:16 +00005310
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005311 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005312 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005313 }
Mike Stump31feda52009-07-17 01:31:16 +00005314
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005315 if (!StripParens)
5316 return E;
5317
Craig Topper25542942014-05-20 04:30:07 +00005318 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005319}
5320
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005321//===----------------------------------------------------------------------===//
5322// CFG Graphviz Visualization
5323//===----------------------------------------------------------------------===//
5324
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005325#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005326static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005327#endif
5328
Chris Lattnerc61089a2009-06-30 01:26:17 +00005329void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005330#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005331 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005332 GraphHelper = &H;
5333 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005334 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005335#endif
5336}
5337
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005338namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005339
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005340template<>
5341struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005342 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005343
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005344 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005345#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005346 std::string OutSStr;
5347 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005348 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005349 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005350
5351 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5352
5353 // Process string output to make it nicer...
5354 for (unsigned i = 0; i != OutStr.length(); ++i)
5355 if (OutStr[i] == '\n') { // Left justify
5356 OutStr[i] = '\\';
5357 OutStr.insert(OutStr.begin()+i+1, 'l');
5358 }
Mike Stump31feda52009-07-17 01:31:16 +00005359
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005360 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005361#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005362 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005363#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005364 }
5365};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005366
5367} // namespace llvm