blob: 86816997f0719dcdc60149bf4b86b4707fea84da [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//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the CFG and CFGBuilder classes for representing and
10// building Control-Flow Graphs (CFGs) from ASTs.
11//
12//===----------------------------------------------------------------------===//
13
Ted Kremenek6796fbd2009-07-16 18:13:04 +000014#include "clang/Analysis/CFG.h"
Benjamin Kramer1ea8e092012-07-04 17:04:04 +000015#include "clang/AST/ASTContext.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000016#include "clang/AST/Attr.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000017#include "clang/AST/Decl.h"
18#include "clang/AST/DeclBase.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000019#include "clang/AST/DeclCXX.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000020#include "clang/AST/DeclGroup.h"
21#include "clang/AST/Expr.h"
22#include "clang/AST/ExprCXX.h"
23#include "clang/AST/OperationKinds.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000024#include "clang/AST/PrettyPrinter.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000025#include "clang/AST/Stmt.h"
26#include "clang/AST/StmtCXX.h"
27#include "clang/AST/StmtObjC.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000028#include "clang/AST/StmtVisitor.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000029#include "clang/AST/Type.h"
Artem Dergachev40684812018-02-27 20:03:35 +000030#include "clang/Analysis/ConstructionContext.h"
Csaba Dabisdea605e2019-05-29 18:29:31 +000031#include "clang/Analysis/Support/BumpVector.h"
Jordan Rose5374c072013-08-19 16:27:28 +000032#include "clang/Basic/Builtins.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000033#include "clang/Basic/ExceptionSpecificationType.h"
Csaba Dabisdea605e2019-05-29 18:29:31 +000034#include "clang/Basic/JsonSupport.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000035#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
Richard Trieu6541c792019-09-21 02:37:10 +000073/// Returns true on constant values based around a single IntegerLiteral.
74/// Allow for use of parentheses, integer casts, and negative signs.
75static bool IsIntegerLiteralConstantExpr(const Expr *E) {
76 // Allow parentheses
77 E = E->IgnoreParens();
78
79 // Allow conversions to different integer kind.
80 if (const auto *CE = dyn_cast<CastExpr>(E)) {
81 if (CE->getCastKind() != CK_IntegralCast)
82 return false;
83 E = CE->getSubExpr();
84 }
85
86 // Allow negative numbers.
87 if (const auto *UO = dyn_cast<UnaryOperator>(E)) {
88 if (UO->getOpcode() != UO_Minus)
89 return false;
90 E = UO->getSubExpr();
91 }
92
93 return isa<IntegerLiteral>(E);
94}
95
George Burgess IVced56e62015-10-01 18:47:52 +000096/// Helper for tryNormalizeBinaryOperator. Attempts to extract an IntegerLiteral
Richard Trieu6541c792019-09-21 02:37:10 +000097/// constant expression or EnumConstantDecl from the given Expr. If it fails,
98/// returns nullptr.
Eugene Zelenko38c70522017-12-07 21:55:09 +000099static const Expr *tryTransformToIntOrEnumConstant(const Expr *E) {
George Burgess IVced56e62015-10-01 18:47:52 +0000100 E = E->IgnoreParens();
Richard Trieu6541c792019-09-21 02:37:10 +0000101 if (IsIntegerLiteralConstantExpr(E))
George Burgess IVced56e62015-10-01 18:47:52 +0000102 return E;
103 if (auto *DR = dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
104 return isa<EnumConstantDecl>(DR->getDecl()) ? DR : nullptr;
105 return nullptr;
106}
107
108/// Tries to interpret a binary operator into `Decl Op Expr` form, if Expr is
109/// an integer literal or an enum constant.
110///
111/// If this fails, at least one of the returned DeclRefExpr or Expr will be
112/// null.
113static std::tuple<const DeclRefExpr *, BinaryOperatorKind, const Expr *>
114tryNormalizeBinaryOperator(const BinaryOperator *B) {
115 BinaryOperatorKind Op = B->getOpcode();
116
117 const Expr *MaybeDecl = B->getLHS();
118 const Expr *Constant = tryTransformToIntOrEnumConstant(B->getRHS());
119 // Expr looked like `0 == Foo` instead of `Foo == 0`
120 if (Constant == nullptr) {
121 // Flip the operator
122 if (Op == BO_GT)
123 Op = BO_LT;
124 else if (Op == BO_GE)
125 Op = BO_LE;
126 else if (Op == BO_LT)
127 Op = BO_GT;
128 else if (Op == BO_LE)
129 Op = BO_GE;
130
131 MaybeDecl = B->getRHS();
132 Constant = tryTransformToIntOrEnumConstant(B->getLHS());
133 }
134
135 auto *D = dyn_cast<DeclRefExpr>(MaybeDecl->IgnoreParenImpCasts());
136 return std::make_tuple(D, Op, Constant);
137}
138
139/// For an expression `x == Foo && x == Bar`, this determines whether the
140/// `Foo` and `Bar` are either of the same enumeration type, or both integer
141/// literals.
142///
143/// It's an error to pass this arguments that are not either IntegerLiterals
144/// or DeclRefExprs (that have decls of type EnumConstantDecl)
145static bool areExprTypesCompatible(const Expr *E1, const Expr *E2) {
146 // User intent isn't clear if they're mixing int literals with enum
147 // constants.
Richard Trieu6541c792019-09-21 02:37:10 +0000148 if (isa<DeclRefExpr>(E1) != isa<DeclRefExpr>(E2))
George Burgess IVced56e62015-10-01 18:47:52 +0000149 return false;
150
151 // Integer literal comparisons, regardless of literal type, are acceptable.
Richard Trieu6541c792019-09-21 02:37:10 +0000152 if (!isa<DeclRefExpr>(E1))
George Burgess IVced56e62015-10-01 18:47:52 +0000153 return true;
154
155 // IntegerLiterals are handled above and only EnumConstantDecls are expected
156 // beyond this point
157 assert(isa<DeclRefExpr>(E1) && isa<DeclRefExpr>(E2));
158 auto *Decl1 = cast<DeclRefExpr>(E1)->getDecl();
159 auto *Decl2 = cast<DeclRefExpr>(E2)->getDecl();
160
161 assert(isa<EnumConstantDecl>(Decl1) && isa<EnumConstantDecl>(Decl2));
162 const DeclContext *DC1 = Decl1->getDeclContext();
163 const DeclContext *DC2 = Decl2->getDeclContext();
164
165 assert(isa<EnumDecl>(DC1) && isa<EnumDecl>(DC2));
166 return DC1 == DC2;
167}
168
Eugene Zelenko38c70522017-12-07 21:55:09 +0000169namespace {
170
Ted Kremenek7c58d352011-03-10 01:14:11 +0000171class CFGBuilder;
Fangrui Song6907ce22018-07-30 19:24:48 +0000172
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000173/// The CFG builder uses a recursive algorithm to build the CFG. When
174/// we process an expression, sometimes we know that we must add the
175/// subexpressions as block-level expressions. For example:
176///
177/// exp1 || exp2
178///
179/// When processing the '||' expression, we know that exp1 and exp2
180/// need to be added as block-level expressions, even though they
181/// might not normally need to be. AddStmtChoice records this
182/// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then
183/// the builder has an option not to add a subexpression as a
184/// block-level expression.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000185class AddStmtChoice {
186public:
Ted Kremenek8219b822010-12-16 07:46:53 +0000187 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 };
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000188
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000189 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000190
Ted Kremenek7c58d352011-03-10 01:14:11 +0000191 bool alwaysAdd(CFGBuilder &builder,
192 const Stmt *stmt) const;
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000193
194 /// Return a copy of this object, except with the 'always-add' bit
195 /// set as specified.
196 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const {
Ted Kremenek7c58d352011-03-10 01:14:11 +0000197 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000198 }
199
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000200private:
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000201 Kind kind;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000202};
Mike Stump31feda52009-07-17 01:31:16 +0000203
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000204/// LocalScope - Node in tree of local scopes created for C++ implicit
205/// destructor calls generation. It contains list of automatic variables
206/// declared in the scope and link to position in previous scope this scope
207/// began in.
208///
209/// The process of creating local scopes is as follows:
210/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
211/// - Before processing statements in scope (e.g. CompoundStmt) create
212/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
213/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000214/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000215/// at this VarDecl,
216/// - For every normal (without jump) end of scope add to CFGBlock destructors
217/// for objects in the current scope,
218/// - For every jump add to CFGBlock destructors for objects
219/// between CFGBuilder::ScopePos and local scope position saved for jump
220/// target. Thanks to C++ restrictions on goto jumps we can be sure that
221/// jump target position will be on the path to root from CFGBuilder::ScopePos
222/// (adding any variable that doesn't need constructor to be called to
223/// LocalScope can break this assumption),
224///
225class LocalScope {
226public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000227 friend class const_iterator;
228
229 using AutomaticVarsTy = BumpVector<VarDecl *>;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000230
231 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000232 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000233 class const_iterator {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000234 const LocalScope* Scope = nullptr;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000235
236 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
237 /// Invalid iterator (with null Scope) has VarIter equal to 0.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000238 unsigned VarIter = 0;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000239
240 public:
241 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
242 /// Incrementing invalid iterator is allowed and will result in invalid
243 /// iterator.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000244 const_iterator() = default;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000245
246 /// Create valid iterator. In case when S.Prev is an invalid iterator and
247 /// I is equal to 0, this will create invalid iterator.
248 const_iterator(const LocalScope& S, unsigned I)
249 : Scope(&S), VarIter(I) {
250 // Iterator to "end" of scope is not allowed. Handle it by going up
251 // in scopes tree possibly up to invalid iterator in the root.
252 if (VarIter == 0 && Scope)
253 *this = Scope->Prev;
254 }
255
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000256 VarDecl *const* operator->() const {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000257 assert(Scope && "Dereferencing invalid iterator is not allowed");
258 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000259 return &Scope->Vars[VarIter - 1];
260 }
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000261
262 const VarDecl *getFirstVarInScope() const {
263 assert(Scope && "Dereferencing invalid iterator is not allowed");
264 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
265 return Scope->Vars[0];
266 }
267
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000268 VarDecl *operator*() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000269 return *this->operator->();
270 }
271
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000272 const_iterator &operator++() {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000273 if (!Scope)
274 return *this;
275
Eugene Zelenko38c70522017-12-07 21:55:09 +0000276 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000277 --VarIter;
278 if (VarIter == 0)
279 *this = Scope->Prev;
280 return *this;
281 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000282 const_iterator operator++(int) {
283 const_iterator P = *this;
284 ++*this;
285 return P;
286 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000287
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000288 bool operator==(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000289 return Scope == rhs.Scope && VarIter == rhs.VarIter;
290 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000291 bool operator!=(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000292 return !(*this == rhs);
293 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000294
Aaron Ballman67347662015-02-15 22:00:28 +0000295 explicit operator bool() const {
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000296 return *this != const_iterator();
297 }
298
299 int distance(const_iterator L);
Matthias Gehre351c2182017-07-12 07:04:19 +0000300 const_iterator shared_parent(const_iterator L);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000301 bool pointsToFirstDeclaredVar() { return VarIter == 1; }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000302 };
303
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000304private:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000305 BumpVectorContext ctx;
Fangrui Song6907ce22018-07-30 19:24:48 +0000306
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000307 /// Automatic variables in order of declaration.
308 AutomaticVarsTy Vars;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000309
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000310 /// Iterator to variable in previous scope that was declared just before
311 /// begin of this scope.
312 const_iterator Prev;
313
314public:
315 /// Constructs empty scope linked to previous scope in specified place.
David Blaikiec1334cc2015-08-13 22:12:21 +0000316 LocalScope(BumpVectorContext ctx, const_iterator P)
317 : ctx(std::move(ctx)), Vars(this->ctx, 4), Prev(P) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000318
319 /// Begin of scope in direction of CFG building (backwards).
320 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000321
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000322 void addVar(VarDecl *VD) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000323 Vars.push_back(VD, ctx);
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000324 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000325};
326
Eugene Zelenko38c70522017-12-07 21:55:09 +0000327} // namespace
328
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000329/// distance - Calculates distance from this to L. L must be reachable from this
330/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
331/// number of scopes between this and L.
332int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
333 int D = 0;
334 const_iterator F = *this;
335 while (F.Scope != L.Scope) {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000336 assert(F != const_iterator() &&
337 "L iterator is not reachable from F iterator.");
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000338 D += F.VarIter;
339 F = F.Scope->Prev;
340 }
341 D += F.VarIter - L.VarIter;
342 return D;
343}
344
Matthias Gehre351c2182017-07-12 07:04:19 +0000345/// Calculates the closest parent of this iterator
346/// that is in a scope reachable through the parents of L.
347/// I.e. when using 'goto' from this to L, the lifetime of all variables
348/// between this and shared_parent(L) end.
349LocalScope::const_iterator
350LocalScope::const_iterator::shared_parent(LocalScope::const_iterator L) {
351 llvm::SmallPtrSet<const LocalScope *, 4> ScopesOfL;
352 while (true) {
353 ScopesOfL.insert(L.Scope);
354 if (L == const_iterator())
355 break;
356 L = L.Scope->Prev;
357 }
358
359 const_iterator F = *this;
360 while (true) {
361 if (ScopesOfL.count(F.Scope))
362 return F;
363 assert(F != const_iterator() &&
364 "L iterator is not reachable from F iterator.");
365 F = F.Scope->Prev;
366 }
367}
368
Eugene Zelenko38c70522017-12-07 21:55:09 +0000369namespace {
370
Jonathan Roelofs99bdd982015-05-19 18:51:56 +0000371/// Structure for specifying position in CFG during its build process. It
372/// consists of CFGBlock that specifies position in CFG and
373/// LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000374struct BlockScopePosPair {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000375 CFGBlock *block = nullptr;
376 LocalScope::const_iterator scopePosition;
377
378 BlockScopePosPair() = default;
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000379 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos)
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000380 : block(b), scopePosition(scopePos) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000381};
382
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000383/// TryResult - a class representing a variant over the values
384/// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool,
385/// and is used by the CFGBuilder to decide if a branch condition
386/// can be decided up front during CFG construction.
387class TryResult {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000388 int X = -1;
389
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000390public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000391 TryResult() = default;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000392 TryResult(bool b) : X(b ? 1 : 0) {}
Fangrui Song6907ce22018-07-30 19:24:48 +0000393
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000394 bool isTrue() const { return X == 1; }
395 bool isFalse() const { return X == 0; }
396 bool isKnown() const { return X >= 0; }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000397
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000398 void negate() {
399 assert(isKnown());
400 X ^= 0x1;
401 }
402};
403
Eugene Zelenko38c70522017-12-07 21:55:09 +0000404} // namespace
405
406static TryResult bothKnownTrue(TryResult R1, TryResult R2) {
Manuel Klimekdeb02622014-08-08 07:37:13 +0000407 if (!R1.isKnown() || !R2.isKnown())
408 return TryResult();
409 return TryResult(R1.isTrue() && R2.isTrue());
410}
411
Eugene Zelenko38c70522017-12-07 21:55:09 +0000412namespace {
413
Ted Kremenek8ae67872013-02-05 22:00:19 +0000414class reverse_children {
415 llvm::SmallVector<Stmt *, 12> childrenBuf;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000416 ArrayRef<Stmt *> children;
417
Ted Kremenek8ae67872013-02-05 22:00:19 +0000418public:
419 reverse_children(Stmt *S);
420
Eugene Zelenko38c70522017-12-07 21:55:09 +0000421 using iterator = ArrayRef<Stmt *>::reverse_iterator;
422
Ted Kremenek8ae67872013-02-05 22:00:19 +0000423 iterator begin() const { return children.rbegin(); }
424 iterator end() const { return children.rend(); }
425};
426
Eugene Zelenko38c70522017-12-07 21:55:09 +0000427} // namespace
Ted Kremenek8ae67872013-02-05 22:00:19 +0000428
429reverse_children::reverse_children(Stmt *S) {
430 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
431 children = CE->getRawSubExprs();
432 return;
433 }
434 switch (S->getStmtClass()) {
Ted Kremenek7d86b9c2013-02-05 22:03:14 +0000435 // Note: Fill in this switch with more cases we want to optimize.
Ted Kremenek8ae67872013-02-05 22:00:19 +0000436 case Stmt::InitListExprClass: {
437 InitListExpr *IE = cast<InitListExpr>(S);
438 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()),
439 IE->getNumInits());
440 return;
441 }
442 default:
443 break;
444 }
445
446 // Default case for all other statements.
Benjamin Kramer642f1732015-07-02 21:03:14 +0000447 for (Stmt *SubStmt : S->children())
448 childrenBuf.push_back(SubStmt);
Ted Kremenek8ae67872013-02-05 22:00:19 +0000449
450 // This needs to be done *after* childrenBuf has been populated.
451 children = childrenBuf;
452}
453
Eugene Zelenko38c70522017-12-07 21:55:09 +0000454namespace {
455
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000456/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000457/// The builder is stateful: an instance of the builder should be used to only
458/// construct a single CFG.
459///
460/// Example usage:
461///
462/// CFGBuilder builder;
Jonathan Roelofsab046c52015-07-27 16:05:36 +0000463/// std::unique_ptr<CFG> cfg = builder.buildCFG(decl, stmt1);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000464///
Mike Stump31feda52009-07-17 01:31:16 +0000465/// CFG construction is done via a recursive walk of an AST. We actually parse
466/// the AST in reverse order so that the successor of a basic block is
467/// constructed prior to its predecessor. This allows us to nicely capture
468/// implicit fall-throughs without extra basic blocks.
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000469class CFGBuilder {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000470 using JumpTarget = BlockScopePosPair;
471 using JumpSource = BlockScopePosPair;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000472
Mike Stump0d76d072009-07-20 23:24:15 +0000473 ASTContext *Context;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000474 std::unique_ptr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000475
Eugene Zelenko38c70522017-12-07 21:55:09 +0000476 // Current block.
477 CFGBlock *Block = nullptr;
478
479 // Block after the current block.
480 CFGBlock *Succ = nullptr;
481
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000482 JumpTarget ContinueJumpTarget;
483 JumpTarget BreakJumpTarget;
Nico Weber699670e2017-08-23 15:33:16 +0000484 JumpTarget SEHLeaveJumpTarget;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000485 CFGBlock *SwitchTerminatedBlock = nullptr;
486 CFGBlock *DefaultCaseBlock = nullptr;
Nico Weber699670e2017-08-23 15:33:16 +0000487
488 // This can point either to a try or a __try block. The frontend forbids
489 // mixing both kinds in one function, so having one for both is enough.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000490 CFGBlock *TryTerminatedBlock = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000491
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000492 // Current position in local scope.
493 LocalScope::const_iterator ScopePos;
494
495 // LabelMap records the mapping from Label expressions to their jump targets.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000496 using LabelMapTy = llvm::DenseMap<LabelDecl *, JumpTarget>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000497 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000498
499 // A list of blocks that end with a "goto" that must be backpatched to their
500 // resolved targets upon completion of CFG construction.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000501 using BackpatchBlocksTy = std::vector<JumpSource>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000502 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000503
Ted Kremenekeda180e22007-08-28 19:26:49 +0000504 // A list of labels whose address has been taken (for indirect gotos).
Eugene Zelenko38c70522017-12-07 21:55:09 +0000505 using LabelSetTy = llvm::SmallSetVector<LabelDecl *, 8>;
Ted Kremenekeda180e22007-08-28 19:26:49 +0000506 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000507
Artem Dergachev41ffb302018-02-08 22:58:15 +0000508 // Information about the currently visited C++ object construction site.
509 // This is set in the construction trigger and read when the constructor
Artem Dergachev1527dec2018-03-12 23:12:40 +0000510 // or a function that returns an object by value is being visited.
511 llvm::DenseMap<Expr *, const ConstructionContextLayer *>
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000512 ConstructionContextMap;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000513
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000514 using DeclsWithEndedScopeSetTy = llvm::SmallSetVector<VarDecl *, 16>;
515 DeclsWithEndedScopeSetTy DeclsWithEndedScope;
516
Eugene Zelenko38c70522017-12-07 21:55:09 +0000517 bool badCFG = false;
Ted Kremenekf9d82902011-03-10 01:14:05 +0000518 const CFG::BuildOptions &BuildOpts;
Fangrui Song6907ce22018-07-30 19:24:48 +0000519
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000520 // State to track for building switch statements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000521 bool switchExclusivelyCovered = false;
522 Expr::EvalResult *switchCond = nullptr;
Fangrui Song6907ce22018-07-30 19:24:48 +0000523
Eugene Zelenko38c70522017-12-07 21:55:09 +0000524 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry = nullptr;
525 const Stmt *lastLookup = nullptr;
Zhongxing Xud38fb842010-09-16 03:28:18 +0000526
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000527 // Caches boolean evaluations of expressions to avoid multiple re-evaluations
528 // during construction of branches for chained logical operators.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000529 using CachedBoolEvalsTy = llvm::DenseMap<Expr *, TryResult>;
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000530 CachedBoolEvalsTy CachedBoolEvals;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000531
Mike Stump31feda52009-07-17 01:31:16 +0000532public:
Ted Kremenekf9d82902011-03-10 01:14:05 +0000533 explicit CFGBuilder(ASTContext *astContext,
Nico Weber699670e2017-08-23 15:33:16 +0000534 const CFG::BuildOptions &buildOpts)
535 : Context(astContext), cfg(new CFG()), // crew a new CFG
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000536 ConstructionContextMap(), BuildOpts(buildOpts) {}
537
Mike Stump31feda52009-07-17 01:31:16 +0000538
Ted Kremenek9aae5132007-08-23 21:42:29 +0000539 // buildCFG - Used by external clients to construct the CFG.
David Blaikiee90195c2014-08-29 18:53:26 +0000540 std::unique_ptr<CFG> buildCFG(const Decl *D, Stmt *Statement);
Mike Stump31feda52009-07-17 01:31:16 +0000541
Ted Kremeneka099c592011-03-10 03:50:34 +0000542 bool alwaysAdd(const Stmt *stmt);
Fangrui Song6907ce22018-07-30 19:24:48 +0000543
Ted Kremenek93668002009-07-17 22:18:43 +0000544private:
545 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000546 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
547 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000548 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000549 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000550 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000551 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Artem Dergachevead98ea2019-08-28 18:44:42 +0000552 CFGBlock *VisitCompoundStmt(CompoundStmt *C, bool ExternallyDestructed);
John McCallc07a0c72011-02-17 10:25:35 +0000553 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C,
554 AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000555 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek6f400242012-07-14 05:04:01 +0000556 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
557 AddStmtChoice asc);
558 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
559 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc);
Jordan Rosec9176072014-01-13 17:59:19 +0000560 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc);
Jordan Rosed2f40792013-09-03 17:00:57 +0000561 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000562 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S);
563 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
564 AddStmtChoice asc);
565 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
566 AddStmtChoice asc);
567 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
568 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000569 CFGBlock *VisitDeclStmt(DeclStmt *DS);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000570 CFGBlock *VisitDeclSubExpr(DeclStmt *DS);
Ted Kremenek21822592009-07-17 18:20:32 +0000571 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
572 CFGBlock *VisitDoStmt(DoStmt *D);
Artem Dergachevead98ea2019-08-28 18:44:42 +0000573 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E,
574 AddStmtChoice asc, bool ExternallyDestructed);
Ted Kremenek21822592009-07-17 18:20:32 +0000575 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000576 CFGBlock *VisitGotoStmt(GotoStmt *G);
Jennifer Yub8fee672019-06-03 15:57:25 +0000577 CFGBlock *VisitGCCAsmStmt(GCCAsmStmt *G, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000578 CFGBlock *VisitIfStmt(IfStmt *I);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +0000579 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *E, AddStmtChoice asc);
Bill Wendling8003edc2018-11-09 00:41:36 +0000580 CFGBlock *VisitConstantExpr(ConstantExpr *E, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000581 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I);
582 CFGBlock *VisitLabelStmt(LabelStmt *L);
Devin Coughlinb6029b72015-11-25 22:35:37 +0000583 CFGBlock *VisitBlockExpr(BlockExpr *E, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000584 CFGBlock *VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc);
Ted Kremeneka16436f2012-07-14 05:04:06 +0000585 CFGBlock *VisitLogicalOperator(BinaryOperator *B);
Ted Kremenekb50e7162012-07-14 05:04:10 +0000586 std::pair<CFGBlock *, CFGBlock *> VisitLogicalOperator(BinaryOperator *B,
587 Stmt *Term,
588 CFGBlock *TrueBlock,
589 CFGBlock *FalseBlock);
Artem Dergachevf43ac4c2018-02-24 02:00:30 +0000590 CFGBlock *VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
591 AddStmtChoice asc);
Ted Kremenek5868ec62010-04-11 17:02:10 +0000592 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000593 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S);
594 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S);
595 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S);
596 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000597 CFGBlock *VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000598 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S);
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000599 CFGBlock *VisitObjCMessageExpr(ObjCMessageExpr *E, AddStmtChoice asc);
John McCallfe96e0b2011-11-06 09:01:30 +0000600 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E);
Brian Gesiaka87ecf62018-11-03 22:35:17 +0000601 CFGBlock *VisitReturnStmt(Stmt *S);
Nico Weber699670e2017-08-23 15:33:16 +0000602 CFGBlock *VisitSEHExceptStmt(SEHExceptStmt *S);
603 CFGBlock *VisitSEHFinallyStmt(SEHFinallyStmt *S);
604 CFGBlock *VisitSEHLeaveStmt(SEHLeaveStmt *S);
605 CFGBlock *VisitSEHTryStmt(SEHTryStmt *S);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000606 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000607 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000608 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
609 AddStmtChoice asc);
Zhanyong Wan6dace612010-11-22 08:45:56 +0000610 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000611 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000612
Artem Dergachevead98ea2019-08-28 18:44:42 +0000613 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd,
614 bool ExternallyDestructed = false);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000615 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000616 CFGBlock *VisitChildren(Stmt *S);
Ted Kremeneke2499842012-04-12 20:03:44 +0000617 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc);
Alexey Bataevc2c21ef2019-07-11 14:54:17 +0000618 CFGBlock *VisitOMPExecutableDirective(OMPExecutableDirective *D,
619 AddStmtChoice asc);
Mike Stump48871a22009-07-17 01:04:31 +0000620
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000621 void maybeAddScopeBeginForVarDecl(CFGBlock *B, const VarDecl *VD,
622 const Stmt *S) {
623 if (ScopePos && (VD == ScopePos.getFirstVarInScope()))
624 appendScopeBegin(B, VD, S);
625 }
626
Manuel Klimekb5616c92014-08-07 10:42:17 +0000627 /// When creating the CFG for temporary destructors, we want to mirror the
628 /// branch structure of the corresponding constructor calls.
629 /// Thus, while visiting a statement for temporary destructors, we keep a
630 /// context to keep track of the following information:
631 /// - whether a subexpression is executed unconditionally
632 /// - if a subexpression is executed conditionally, the first
633 /// CXXBindTemporaryExpr we encounter in that subexpression (which
634 /// corresponds to the last temporary destructor we have to call for this
635 /// subexpression) and the CFG block at that point (which will become the
636 /// successor block when inserting the decision point).
637 ///
638 /// That way, we can build the branch structure for temporary destructors as
639 /// follows:
640 /// 1. If a subexpression is executed unconditionally, we add the temporary
641 /// destructor calls to the current block.
642 /// 2. If a subexpression is executed conditionally, when we encounter a
643 /// CXXBindTemporaryExpr:
644 /// a) If it is the first temporary destructor call in the subexpression,
645 /// we remember the CXXBindTemporaryExpr and the current block in the
646 /// TempDtorContext; we start a new block, and insert the temporary
647 /// destructor call.
648 /// b) Otherwise, add the temporary destructor call to the current block.
649 /// 3. When we finished visiting a conditionally executed subexpression,
650 /// and we found at least one temporary constructor during the visitation
651 /// (2.a has executed), we insert a decision block that uses the
652 /// CXXBindTemporaryExpr as terminator, and branches to the current block
653 /// if the CXXBindTemporaryExpr was marked executed, and otherwise
654 /// branches to the stored successor.
655 struct TempDtorContext {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000656 TempDtorContext() = default;
Manuel Klimekdeb02622014-08-08 07:37:13 +0000657 TempDtorContext(TryResult KnownExecuted)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000658 : IsConditional(true), KnownExecuted(KnownExecuted) {}
Manuel Klimekb5616c92014-08-07 10:42:17 +0000659
660 /// Returns whether we need to start a new branch for a temporary destructor
Eric Christopher2c4555a2015-06-19 01:52:53 +0000661 /// call. This is the case when the temporary destructor is
Manuel Klimekb5616c92014-08-07 10:42:17 +0000662 /// conditionally executed, and it is the first one we encounter while
663 /// visiting a subexpression - other temporary destructors at the same level
664 /// will be added to the same block and are executed under the same
665 /// condition.
666 bool needsTempDtorBranch() const {
667 return IsConditional && !TerminatorExpr;
668 }
669
670 /// Remember the successor S of a temporary destructor decision branch for
671 /// the corresponding CXXBindTemporaryExpr E.
672 void setDecisionPoint(CFGBlock *S, CXXBindTemporaryExpr *E) {
673 Succ = S;
674 TerminatorExpr = E;
675 }
676
Eugene Zelenko38c70522017-12-07 21:55:09 +0000677 const bool IsConditional = false;
678 const TryResult KnownExecuted = true;
679 CFGBlock *Succ = nullptr;
680 CXXBindTemporaryExpr *TerminatorExpr = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000681 };
682
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000683 // Visitors to walk an AST and generate destructors of temporaries in
684 // full expression.
Artem Dergachevead98ea2019-08-28 18:44:42 +0000685 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +0000686 TempDtorContext &Context);
Artem Dergachevead98ea2019-08-28 18:44:42 +0000687 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E, bool ExternallyDestructed,
688 TempDtorContext &Context);
Manuel Klimekb5616c92014-08-07 10:42:17 +0000689 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E,
Artem Dergachevead98ea2019-08-28 18:44:42 +0000690 bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +0000691 TempDtorContext &Context);
692 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +0000693 CXXBindTemporaryExpr *E, bool ExternallyDestructed, TempDtorContext &Context);
Manuel Klimekb5616c92014-08-07 10:42:17 +0000694 CFGBlock *VisitConditionalOperatorForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +0000695 AbstractConditionalOperator *E, bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +0000696 TempDtorContext &Context);
697 void InsertTempDtorDecisionBlock(const TempDtorContext &Context,
698 CFGBlock *FalseSucc = nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000699
Ted Kremenek6065ef62008-04-28 18:00:46 +0000700 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000701 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000702 badCFG = true;
703 return Block;
704 }
Mike Stump31feda52009-07-17 01:31:16 +0000705
Artem Dergachev40684812018-02-27 20:03:35 +0000706 // Remember to apply the construction context based on the current \p Layer
707 // when constructing the CFG element for \p CE.
708 void consumeConstructionContext(const ConstructionContextLayer *Layer,
Artem Dergachev1527dec2018-03-12 23:12:40 +0000709 Expr *E);
Artem Dergachevc1b07bd2018-02-23 23:38:41 +0000710
Artem Dergachev40684812018-02-27 20:03:35 +0000711 // Scan \p Child statement to find constructors in it, while keeping in mind
712 // that its parent statement is providing a partial construction context
713 // described by \p Layer. If a constructor is found, it would be assigned
714 // the context based on the layer. If an additional construction context layer
715 // is found, the function recurses into that.
716 void findConstructionContexts(const ConstructionContextLayer *Layer,
Artem Dergachev783a4572018-02-23 22:20:39 +0000717 Stmt *Child);
Artem Dergachev40684812018-02-27 20:03:35 +0000718
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000719 // Scan all arguments of a call expression for a construction context.
720 // These sorts of call expressions don't have a common superclass,
721 // hence strict duck-typing.
722 template <typename CallLikeExpr,
723 typename = typename std::enable_if<
724 std::is_same<CallLikeExpr, CallExpr>::value ||
725 std::is_same<CallLikeExpr, CXXConstructExpr>::value ||
726 std::is_same<CallLikeExpr, ObjCMessageExpr>::value>>
727 void findConstructionContextsForArguments(CallLikeExpr *E) {
Artem Dergacheva657a322018-07-31 20:45:53 +0000728 for (unsigned i = 0, e = E->getNumArgs(); i != e; ++i) {
729 Expr *Arg = E->getArg(i);
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000730 if (Arg->getType()->getAsCXXRecordDecl() && !Arg->isGLValue())
731 findConstructionContexts(
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +0000732 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
733 ConstructionContextItem(E, i)),
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000734 Arg);
Artem Dergacheva657a322018-07-31 20:45:53 +0000735 }
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000736 }
737
Artem Dergachev41ffb302018-02-08 22:58:15 +0000738 // Unset the construction context after consuming it. This is done immediately
Artem Dergachev1527dec2018-03-12 23:12:40 +0000739 // after adding the CFGConstructor or CFGCXXRecordTypedCall element, so
740 // there's no need to do this manually in every Visit... function.
741 void cleanupConstructionContext(Expr *E);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000742
Ted Kremenek93668002009-07-17 22:18:43 +0000743 void autoCreateBlock() { if (!Block) Block = createBlock(); }
744 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000745 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000746
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000747 CFGBlock *addStmt(Stmt *S) {
748 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000749 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000750
Alexis Hunt1d792652011-01-08 20:30:50 +0000751 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000752 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000753 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000754 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000755 void addLifetimeEnds(LocalScope::const_iterator B,
756 LocalScope::const_iterator E, Stmt *S);
757 void addAutomaticObjHandling(LocalScope::const_iterator B,
758 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000759 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000760 void addScopesEnd(LocalScope::const_iterator B, LocalScope::const_iterator E,
761 Stmt *S);
762
763 void getDeclsWithEndedScope(LocalScope::const_iterator B,
764 LocalScope::const_iterator E, Stmt *S);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000765
Marcin Swiderski5e415732010-09-30 23:05:00 +0000766 // Local scopes creation.
767 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
768
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000769 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000770 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
771 LocalScope* Scope = nullptr);
772 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000773
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000774 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000775
Artem Dergacheve1f30622018-07-31 19:46:14 +0000776 const ConstructionContext *retrieveAndCleanupConstructionContext(Expr *E) {
777 if (!BuildOpts.AddRichCXXConstructors)
778 return nullptr;
779
780 const ConstructionContextLayer *Layer = ConstructionContextMap.lookup(E);
781 if (!Layer)
782 return nullptr;
783
784 cleanupConstructionContext(E);
785 return ConstructionContext::createFromLayers(cfg->getBumpVectorContext(),
786 Layer);
787 }
788
Marcin Swiderski5e415732010-09-30 23:05:00 +0000789 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000790
Ted Kremenek37881932011-04-04 23:29:12 +0000791 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000792 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000793 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000794
Jordy Rose17347372011-06-10 08:49:37 +0000795 // All block-level expressions should have already been IgnoreParens()ed.
796 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000797 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000798 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000799
Artem Dergachev41ffb302018-02-08 22:58:15 +0000800 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
Artem Dergacheve1f30622018-07-31 19:46:14 +0000801 if (const ConstructionContext *CC =
802 retrieveAndCleanupConstructionContext(CE)) {
803 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
804 return;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000805 }
806
807 // No valid construction context found. Fall back to statement.
808 B->appendStmt(CE, cfg->getBumpVectorContext());
809 }
810
Artem Dergachev1527dec2018-03-12 23:12:40 +0000811 void appendCall(CFGBlock *B, CallExpr *CE) {
Richard Trieuf4a0e9a2018-03-15 00:09:26 +0000812 if (alwaysAdd(CE) && cachedEntry)
813 cachedEntry->second = B;
814
Artem Dergacheve1f30622018-07-31 19:46:14 +0000815 if (const ConstructionContext *CC =
816 retrieveAndCleanupConstructionContext(CE)) {
817 B->appendCXXRecordTypedCall(CE, CC, cfg->getBumpVectorContext());
818 return;
Artem Dergachev1527dec2018-03-12 23:12:40 +0000819 }
820
821 // No valid construction context found. Fall back to statement.
822 B->appendStmt(CE, cfg->getBumpVectorContext());
823 }
824
Alexis Hunt1d792652011-01-08 20:30:50 +0000825 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000826 B->appendInitializer(I, cfg->getBumpVectorContext());
827 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000828
Jordan Rosec9176072014-01-13 17:59:19 +0000829 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
830 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
831 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000832
Marcin Swiderski20b88732010-10-05 05:37:00 +0000833 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
834 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
835 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000836
Marcin Swiderski20b88732010-10-05 05:37:00 +0000837 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
838 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
839 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000840
Artem Dergacheve1f30622018-07-31 19:46:14 +0000841 void appendObjCMessage(CFGBlock *B, ObjCMessageExpr *ME) {
842 if (alwaysAdd(ME) && cachedEntry)
843 cachedEntry->second = B;
844
845 if (const ConstructionContext *CC =
846 retrieveAndCleanupConstructionContext(ME)) {
847 B->appendCXXRecordTypedCall(ME, CC, cfg->getBumpVectorContext());
848 return;
849 }
850
851 B->appendStmt(const_cast<ObjCMessageExpr *>(ME),
852 cfg->getBumpVectorContext());
853 }
854
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000855 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
856 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
857 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000858
Chandler Carruthad747252011-09-13 06:09:01 +0000859 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
860 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
861 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000862
Matthias Gehre351c2182017-07-12 07:04:19 +0000863 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
864 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
865 }
866
Peter Szecsi999a25f2017-08-19 11:19:16 +0000867 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
868 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
869 }
870
Jordan Rosed2f40792013-09-03 17:00:57 +0000871 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
872 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
873 }
874
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000875 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000876 LocalScope::const_iterator B, LocalScope::const_iterator E);
877
Matthias Gehre351c2182017-07-12 07:04:19 +0000878 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
879 LocalScope::const_iterator B,
880 LocalScope::const_iterator E);
881
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000882 const VarDecl *
883 prependAutomaticObjScopeEndWithTerminator(CFGBlock *Blk,
884 LocalScope::const_iterator B,
885 LocalScope::const_iterator E);
886
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000887 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
888 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
889 cfg->getBumpVectorContext());
890 }
891
892 /// Add a reachable successor to a block, with the alternate variant that is
893 /// unreachable.
894 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
895 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
896 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000897 }
Mike Stump11289f42009-09-09 15:08:12 +0000898
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000899 void appendScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
900 if (BuildOpts.AddScopes)
901 B->appendScopeBegin(VD, S, cfg->getBumpVectorContext());
902 }
903
904 void prependScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
905 if (BuildOpts.AddScopes)
906 B->prependScopeBegin(VD, S, cfg->getBumpVectorContext());
907 }
908
909 void appendScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
910 if (BuildOpts.AddScopes)
911 B->appendScopeEnd(VD, S, cfg->getBumpVectorContext());
912 }
913
914 void prependScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
915 if (BuildOpts.AddScopes)
916 B->prependScopeEnd(VD, S, cfg->getBumpVectorContext());
917 }
918
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000919 /// Find a relational comparison with an expression evaluating to a
Richard Trieuf935b562014-04-05 05:17:01 +0000920 /// boolean and a constant other than 0 and 1.
921 /// e.g. if ((x < y) == 10)
922 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
923 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
924 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
925
926 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
927 const Expr *BoolExpr = RHSExpr;
928 bool IntFirst = true;
929 if (!IntLiteral) {
930 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
931 BoolExpr = LHSExpr;
932 IntFirst = false;
933 }
934
935 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
936 return TryResult();
937
938 llvm::APInt IntValue = IntLiteral->getValue();
939 if ((IntValue == 1) || (IntValue == 0))
940 return TryResult();
941
942 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
943 !IntValue.isNegative();
944
945 BinaryOperatorKind Bok = B->getOpcode();
946 if (Bok == BO_GT || Bok == BO_GE) {
947 // Always true for 10 > bool and bool > -1
948 // Always false for -1 > bool and bool > 10
949 return TryResult(IntFirst == IntLarger);
950 } else {
951 // Always true for -1 < bool and bool < 10
952 // Always false for 10 < bool and bool < -1
953 return TryResult(IntFirst != IntLarger);
954 }
955 }
956
Jordan Rose7afd71e2014-05-20 17:31:11 +0000957 /// Find an incorrect equality comparison. Either with an expression
958 /// evaluating to a boolean and a constant other than 0 and 1.
959 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
960 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000961 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
962 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
963 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
964
965 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
966 const Expr *BoolExpr = RHSExpr;
967
968 if (!IntLiteral) {
969 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
970 BoolExpr = LHSExpr;
971 }
972
Jordan Rose7afd71e2014-05-20 17:31:11 +0000973 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000974 return TryResult();
975
Jordan Rose7afd71e2014-05-20 17:31:11 +0000976 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
977 if (BitOp && (BitOp->getOpcode() == BO_And ||
978 BitOp->getOpcode() == BO_Or)) {
979 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
980 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
981
982 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
983
984 if (!IntLiteral2)
985 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
986
987 if (!IntLiteral2)
988 return TryResult();
989
990 llvm::APInt L1 = IntLiteral->getValue();
991 llvm::APInt L2 = IntLiteral2->getValue();
992 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
993 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
994 if (BuildOpts.Observer)
995 BuildOpts.Observer->compareBitwiseEquality(B,
996 B->getOpcode() != BO_EQ);
997 TryResult(B->getOpcode() != BO_EQ);
998 }
999 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
1000 llvm::APInt IntValue = IntLiteral->getValue();
1001 if ((IntValue == 1) || (IntValue == 0)) {
1002 return TryResult();
1003 }
1004 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +00001005 }
1006
Jordan Rose7afd71e2014-05-20 17:31:11 +00001007 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +00001008 }
1009
1010 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
1011 const llvm::APSInt &Value1,
1012 const llvm::APSInt &Value2) {
1013 assert(Value1.isSigned() == Value2.isSigned());
1014 switch (Relation) {
1015 default:
1016 return TryResult();
1017 case BO_EQ:
1018 return TryResult(Value1 == Value2);
1019 case BO_NE:
1020 return TryResult(Value1 != Value2);
1021 case BO_LT:
1022 return TryResult(Value1 < Value2);
1023 case BO_LE:
1024 return TryResult(Value1 <= Value2);
1025 case BO_GT:
1026 return TryResult(Value1 > Value2);
1027 case BO_GE:
1028 return TryResult(Value1 >= Value2);
1029 }
1030 }
1031
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001032 /// Find a pair of comparison expressions with or without parentheses
Richard Trieuf935b562014-04-05 05:17:01 +00001033 /// with a shared variable and constants and a logical operator between them
1034 /// that always evaluates to either true or false.
1035 /// e.g. if (x != 3 || x != 4)
1036 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
1037 assert(B->isLogicalOp());
1038 const BinaryOperator *LHS =
1039 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
1040 const BinaryOperator *RHS =
1041 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
1042 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001043 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001044
1045 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001046 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001047
George Burgess IVced56e62015-10-01 18:47:52 +00001048 const DeclRefExpr *Decl1;
1049 const Expr *Expr1;
1050 BinaryOperatorKind BO1;
1051 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001052
George Burgess IVced56e62015-10-01 18:47:52 +00001053 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001054 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001055
George Burgess IVced56e62015-10-01 18:47:52 +00001056 const DeclRefExpr *Decl2;
1057 const Expr *Expr2;
1058 BinaryOperatorKind BO2;
1059 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001060
George Burgess IVced56e62015-10-01 18:47:52 +00001061 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001062 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001063
1064 // Check that it is the same variable on both sides.
1065 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001066 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001067
George Burgess IVced56e62015-10-01 18:47:52 +00001068 // Make sure the user's intent is clear (e.g. they're comparing against two
1069 // int literals, or two things from the same enum)
1070 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001071 return {};
George Burgess IVced56e62015-10-01 18:47:52 +00001072
Fangrui Song407659a2018-11-30 23:41:18 +00001073 Expr::EvalResult L1Result, L2Result;
1074 if (!Expr1->EvaluateAsInt(L1Result, *Context) ||
1075 !Expr2->EvaluateAsInt(L2Result, *Context))
Fangrui Songf5d33352018-11-30 21:26:09 +00001076 return {};
Hans Wennborg48ee4ad2018-11-28 14:04:12 +00001077
Fangrui Song407659a2018-11-30 23:41:18 +00001078 llvm::APSInt L1 = L1Result.Val.getInt();
1079 llvm::APSInt L2 = L2Result.Val.getInt();
1080
Richard Trieuf935b562014-04-05 05:17:01 +00001081 // Can't compare signed with unsigned or with different bit width.
1082 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001083 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001084
1085 // Values that will be used to determine if result of logical
1086 // operator is always true/false
1087 const llvm::APSInt Values[] = {
1088 // Value less than both Value1 and Value2
1089 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
1090 // L1
1091 L1,
1092 // Value between Value1 and Value2
1093 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
1094 L1.isUnsigned()),
1095 // L2
1096 L2,
1097 // Value greater than both Value1 and Value2
1098 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
1099 };
1100
1101 // Check whether expression is always true/false by evaluating the following
1102 // * variable x is less than the smallest literal.
1103 // * variable x is equal to the smallest literal.
1104 // * Variable x is between smallest and largest literal.
1105 // * Variable x is equal to the largest literal.
1106 // * Variable x is greater than largest literal.
1107 bool AlwaysTrue = true, AlwaysFalse = true;
Richard Trieu6541c792019-09-21 02:37:10 +00001108 // Track value of both subexpressions. If either side is always
1109 // true/false, another warning should have already been emitted.
1110 bool LHSAlwaysTrue = true, LHSAlwaysFalse = true;
1111 bool RHSAlwaysTrue = true, RHSAlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001112 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +00001113 TryResult Res1, Res2;
1114 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
1115 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
1116
1117 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001118 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001119
1120 if (B->getOpcode() == BO_LAnd) {
1121 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
1122 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
1123 } else {
1124 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
1125 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
1126 }
Richard Trieu6541c792019-09-21 02:37:10 +00001127
1128 LHSAlwaysTrue &= Res1.isTrue();
1129 LHSAlwaysFalse &= Res1.isFalse();
1130 RHSAlwaysTrue &= Res2.isTrue();
1131 RHSAlwaysFalse &= Res2.isFalse();
Richard Trieuf935b562014-04-05 05:17:01 +00001132 }
1133
1134 if (AlwaysTrue || AlwaysFalse) {
Richard Trieu6541c792019-09-21 02:37:10 +00001135 if (!LHSAlwaysTrue && !LHSAlwaysFalse && !RHSAlwaysTrue &&
1136 !RHSAlwaysFalse && BuildOpts.Observer)
Richard Trieuf935b562014-04-05 05:17:01 +00001137 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
1138 return TryResult(AlwaysTrue);
1139 }
Eugene Zelenko38c70522017-12-07 21:55:09 +00001140 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001141 }
1142
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001143 /// Try and evaluate an expression to an integer constant.
1144 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
1145 if (!BuildOpts.PruneTriviallyFalseEdges)
1146 return false;
Fangrui Song6907ce22018-07-30 19:24:48 +00001147 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001148 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001149 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001150 }
Mike Stump11289f42009-09-09 15:08:12 +00001151
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001152 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001153 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001154 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001155 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001156 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001157 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001158
1159 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1160 if (Bop->isLogicalOp()) {
1161 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001162 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1163 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001164 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001165
1166 // Retrieve result at first, or the map might be updated.
1167 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1168 CachedBoolEvals[S] = Result; // update or insert
1169 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001170 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001171 else {
1172 switch (Bop->getOpcode()) {
1173 default: break;
1174 // For 'x & 0' and 'x * 0', we can determine that
1175 // the value is always false.
1176 case BO_Mul:
1177 case BO_And: {
1178 // If either operand is zero, we know the value
1179 // must be false.
Fangrui Song407659a2018-11-30 23:41:18 +00001180 Expr::EvalResult LHSResult;
1181 if (Bop->getLHS()->EvaluateAsInt(LHSResult, *Context)) {
1182 llvm::APSInt IntVal = LHSResult.Val.getInt();
David Blaikie7a3cbb22015-03-09 02:02:07 +00001183 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001184 return TryResult(false);
1185 }
1186 }
Fangrui Song407659a2018-11-30 23:41:18 +00001187 Expr::EvalResult RHSResult;
1188 if (Bop->getRHS()->EvaluateAsInt(RHSResult, *Context)) {
1189 llvm::APSInt IntVal = RHSResult.Val.getInt();
David Blaikie7a3cbb22015-03-09 02:02:07 +00001190 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001191 return TryResult(false);
1192 }
1193 }
1194 }
1195 break;
1196 }
1197 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001198 }
1199
1200 return evaluateAsBooleanConditionNoCache(S);
1201 }
1202
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001203 /// Evaluate as boolean \param E without using the cache.
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001204 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1205 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1206 if (Bop->isLogicalOp()) {
1207 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1208 if (LHS.isKnown()) {
1209 // We were able to evaluate the LHS, see if we can get away with not
1210 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1211 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1212 return LHS.isTrue();
1213
1214 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1215 if (RHS.isKnown()) {
1216 if (Bop->getOpcode() == BO_LOr)
1217 return LHS.isTrue() || RHS.isTrue();
1218 else
1219 return LHS.isTrue() && RHS.isTrue();
1220 }
1221 } else {
1222 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1223 if (RHS.isKnown()) {
1224 // We can't evaluate the LHS; however, sometimes the result
1225 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1226 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1227 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001228 } else {
1229 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1230 if (BopRes.isKnown())
1231 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001232 }
1233 }
1234
Eugene Zelenko38c70522017-12-07 21:55:09 +00001235 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001236 } else if (Bop->isEqualityOp()) {
1237 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1238 if (BopRes.isKnown())
1239 return BopRes.isTrue();
1240 } else if (Bop->isRelationalOp()) {
1241 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1242 if (BopRes.isKnown())
1243 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001244 }
1245 }
1246
1247 bool Result;
1248 if (E->EvaluateAsBooleanCondition(Result, *Context))
1249 return Result;
1250
Eugene Zelenko38c70522017-12-07 21:55:09 +00001251 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001252 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001253
1254 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001255};
Mike Stump31feda52009-07-17 01:31:16 +00001256
Eugene Zelenko38c70522017-12-07 21:55:09 +00001257} // namespace
1258
Ted Kremeneka099c592011-03-10 03:50:34 +00001259inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1260 const Stmt *stmt) const {
1261 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1262}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001263
Ted Kremeneka099c592011-03-10 03:50:34 +00001264bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001265 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
Fangrui Song6907ce22018-07-30 19:24:48 +00001266
Ted Kremeneka099c592011-03-10 03:50:34 +00001267 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001268 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001269
Fangrui Song6907ce22018-07-30 19:24:48 +00001270 if (lastLookup == stmt) {
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001271 if (cachedEntry) {
1272 assert(cachedEntry->first == stmt);
1273 return true;
1274 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001275 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001276 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001277
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001278 lastLookup = stmt;
1279
1280 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001281 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1282
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001283 if (!fb) {
1284 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001285 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001286 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001287 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001288
1289 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001290 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001291 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001292 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001293 }
1294
Ted Kremeneka099c592011-03-10 03:50:34 +00001295 cachedEntry = &*itr;
1296 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001297}
Fangrui Song6907ce22018-07-30 19:24:48 +00001298
Douglas Gregor4619e432008-12-05 23:32:09 +00001299// FIXME: Add support for dependent-sized array types in C++?
1300// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001301static const VariableArrayType *FindVA(const Type *t) {
1302 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1303 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001304 if (vat->getSizeExpr())
1305 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001306
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001307 t = vt->getElementType().getTypePtr();
1308 }
Mike Stump31feda52009-07-17 01:31:16 +00001309
Craig Topper25542942014-05-20 04:30:07 +00001310 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001311}
Mike Stump31feda52009-07-17 01:31:16 +00001312
Artem Dergachev40684812018-02-27 20:03:35 +00001313void CFGBuilder::consumeConstructionContext(
Artem Dergachev1527dec2018-03-12 23:12:40 +00001314 const ConstructionContextLayer *Layer, Expr *E) {
Artem Dergacheve1f30622018-07-31 19:46:14 +00001315 assert((isa<CXXConstructExpr>(E) || isa<CallExpr>(E) ||
1316 isa<ObjCMessageExpr>(E)) && "Expression cannot construct an object!");
Artem Dergachev40684812018-02-27 20:03:35 +00001317 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachev1527dec2018-03-12 23:12:40 +00001318 ConstructionContextMap.lookup(E)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001319 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001320 // We might have visited this child when we were finding construction
1321 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001322 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001323 "Already within a different construction context!");
1324 } else {
Artem Dergachev1527dec2018-03-12 23:12:40 +00001325 ConstructionContextMap[E] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001326 }
1327}
1328
Artem Dergachev783a4572018-02-23 22:20:39 +00001329void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001330 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001331 if (!BuildOpts.AddRichCXXConstructors)
1332 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001333
Artem Dergachev41ffb302018-02-08 22:58:15 +00001334 if (!Child)
1335 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001336
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001337 auto withExtraLayer = [this, Layer](const ConstructionContextItem &Item) {
1338 return ConstructionContextLayer::create(cfg->getBumpVectorContext(), Item,
1339 Layer);
Artem Dergachevff267df2018-06-28 00:04:54 +00001340 };
1341
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001342 switch(Child->getStmtClass()) {
1343 case Stmt::CXXConstructExprClass:
1344 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachevff267df2018-06-28 00:04:54 +00001345 // Support pre-C++17 copy elision AST.
1346 auto *CE = cast<CXXConstructExpr>(Child);
1347 if (BuildOpts.MarkElidedCXXConstructors && CE->isElidable()) {
Artem Dergachevff267df2018-06-28 00:04:54 +00001348 findConstructionContexts(withExtraLayer(CE), CE->getArg(0));
1349 }
1350
1351 consumeConstructionContext(Layer, CE);
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001352 break;
1353 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00001354 // FIXME: This, like the main visit, doesn't support CUDAKernelCallExpr.
1355 // FIXME: An isa<> would look much better but this whole switch is a
1356 // workaround for an internal compiler error in MSVC 2015 (see r326021).
1357 case Stmt::CallExprClass:
1358 case Stmt::CXXMemberCallExprClass:
1359 case Stmt::CXXOperatorCallExprClass:
Artem Dergacheve1f30622018-07-31 19:46:14 +00001360 case Stmt::UserDefinedLiteralClass:
1361 case Stmt::ObjCMessageExprClass: {
1362 auto *E = cast<Expr>(Child);
1363 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(E))
1364 consumeConstructionContext(Layer, E);
Artem Dergachev1527dec2018-03-12 23:12:40 +00001365 break;
1366 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001367 case Stmt::ExprWithCleanupsClass: {
1368 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001369 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001370 break;
1371 }
1372 case Stmt::CXXFunctionalCastExprClass: {
1373 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001374 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001375 break;
1376 }
1377 case Stmt::ImplicitCastExprClass: {
1378 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev317291e2018-03-22 21:37:39 +00001379 // Should we support other implicit cast kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001380 switch (Cast->getCastKind()) {
1381 case CK_NoOp:
1382 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001383 findConstructionContexts(Layer, Cast->getSubExpr());
Reid Kleckner4dc0b1a2018-11-01 19:54:45 +00001384 break;
Artem Dergachev13f96642018-03-09 01:39:59 +00001385 default:
1386 break;
1387 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001388 break;
1389 }
1390 case Stmt::CXXBindTemporaryExprClass: {
1391 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachevff267df2018-06-28 00:04:54 +00001392 findConstructionContexts(withExtraLayer(BTE), BTE->getSubExpr());
1393 break;
1394 }
1395 case Stmt::MaterializeTemporaryExprClass: {
1396 // Normally we don't want to search in MaterializeTemporaryExpr because
1397 // it indicates the beginning of a temporary object construction context,
1398 // so it shouldn't be found in the middle. However, if it is the beginning
1399 // of an elidable copy or move construction context, we need to include it.
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001400 if (Layer->getItem().getKind() ==
1401 ConstructionContextItem::ElidableConstructorKind) {
1402 auto *MTE = cast<MaterializeTemporaryExpr>(Child);
1403 findConstructionContexts(withExtraLayer(MTE), MTE->GetTemporaryExpr());
Artem Dergachevff267df2018-06-28 00:04:54 +00001404 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001405 break;
1406 }
1407 case Stmt::ConditionalOperatorClass: {
1408 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001409 if (Layer->getItem().getKind() !=
1410 ConstructionContextItem::MaterializationKind) {
Artem Dergachev9d3a7d82018-03-30 19:21:18 +00001411 // If the object returned by the conditional operator is not going to be a
1412 // temporary object that needs to be immediately materialized, then
1413 // it must be C++17 with its mandatory copy elision. Do not yet promise
1414 // to support this case.
1415 assert(!CO->getType()->getAsCXXRecordDecl() || CO->isGLValue() ||
1416 Context->getLangOpts().CPlusPlus17);
1417 break;
1418 }
Artem Dergachev40684812018-02-27 20:03:35 +00001419 findConstructionContexts(Layer, CO->getLHS());
1420 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001421 break;
1422 }
Artem Dergachevaa403152019-03-21 00:15:07 +00001423 case Stmt::InitListExprClass: {
1424 auto *ILE = cast<InitListExpr>(Child);
1425 if (ILE->isTransparent()) {
1426 findConstructionContexts(Layer, ILE->getInit(0));
1427 break;
1428 }
1429 // TODO: Handle other cases. For now, fail to find construction contexts.
1430 break;
1431 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001432 default:
1433 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001434 }
1435}
1436
Artem Dergachev1527dec2018-03-12 23:12:40 +00001437void CFGBuilder::cleanupConstructionContext(Expr *E) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001438 assert(BuildOpts.AddRichCXXConstructors &&
1439 "We should not be managing construction contexts!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001440 assert(ConstructionContextMap.count(E) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001441 "Cannot exit construction context without the context!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001442 ConstructionContextMap.erase(E);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001443}
1444
1445
Mike Stump31feda52009-07-17 01:31:16 +00001446/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1447/// arbitrary statement. Examples include a single expression or a function
1448/// body (compound statement). The ownership of the returned CFG is
1449/// transferred to the caller. If CFG construction fails, this method returns
1450/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001451std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001452 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001453 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001454 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001455
Mike Stump31feda52009-07-17 01:31:16 +00001456 // Create an empty block that will serve as the exit block for the CFG. Since
1457 // this is the first block added to the CFG, it will be implicitly registered
1458 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001459 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001460 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001461 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001462
Matthias Gehre351c2182017-07-12 07:04:19 +00001463 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1464 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1465
Marcin Swiderski20b88732010-10-05 05:37:00 +00001466 if (BuildOpts.AddImplicitDtors)
1467 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1468 addImplicitDtorsForDestructor(DD);
1469
Ted Kremenek9aae5132007-08-23 21:42:29 +00001470 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001471 CFGBlock *B = addStmt(Statement);
1472
1473 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001474 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001475
Artem Dergachev192a7472019-05-24 23:37:08 +00001476 // For C++ constructor add initializers to CFG. Constructors of virtual bases
1477 // are ignored unless the object is of the most derived class.
1478 // class VBase { VBase() = default; VBase(int) {} };
1479 // class A : virtual public VBase { A() : VBase(0) {} };
1480 // class B : public A {};
1481 // B b; // Constructor calls in order: VBase(), A(), B().
1482 // // VBase(0) is ignored because A isn't the most derived class.
1483 // This may result in the virtual base(s) being already initialized at this
1484 // point, in which case we should jump right onto non-virtual bases and
1485 // fields. To handle this, make a CFG branch. We only need to add one such
1486 // branch per constructor, since the Standard states that all virtual bases
1487 // shall be initialized before non-virtual bases and direct data members.
1488 if (const auto *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
1489 CFGBlock *VBaseSucc = nullptr;
Pete Cooper57d3f142015-07-30 17:22:52 +00001490 for (auto *I : llvm::reverse(CD->inits())) {
Artem Dergachev192a7472019-05-24 23:37:08 +00001491 if (BuildOpts.AddVirtualBaseBranches && !VBaseSucc &&
1492 I->isBaseInitializer() && I->isBaseVirtual()) {
1493 // We've reached the first virtual base init while iterating in reverse
1494 // order. Make a new block for virtual base initializers so that we
1495 // could skip them.
1496 VBaseSucc = Succ = B ? B : &cfg->getExit();
1497 Block = createBlock();
1498 }
Pete Cooper57d3f142015-07-30 17:22:52 +00001499 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001500 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001501 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001502 }
Artem Dergachev192a7472019-05-24 23:37:08 +00001503 if (VBaseSucc) {
1504 // Make a branch block for potentially skipping virtual base initializers.
1505 Succ = VBaseSucc;
1506 B = createBlock();
1507 B->setTerminator(
1508 CFGTerminator(nullptr, CFGTerminator::VirtualBaseBranch));
1509 addSuccessor(B, Block, true);
1510 }
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001511 }
1512
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001513 if (B)
1514 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001515
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001516 // Backpatch the gotos whose label -> block mappings we didn't know when we
1517 // encountered them.
1518 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1519 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001520
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001521 CFGBlock *B = I->block;
Jennifer Yub8fee672019-06-03 15:57:25 +00001522 if (auto *G = dyn_cast<GotoStmt>(B->getTerminator())) {
1523 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
1524 // If there is no target for the goto, then we are looking at an
1525 // incomplete AST. Handle this by not registering a successor.
1526 if (LI == LabelMap.end())
1527 continue;
1528 JumpTarget JT = LI->second;
1529 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1530 JT.scopePosition);
1531 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1532 JT.scopePosition);
1533 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1534 B, I->scopePosition, JT.scopePosition);
1535 appendScopeBegin(JT.block, VD, G);
1536 addSuccessor(B, JT.block);
1537 };
1538 if (auto *G = dyn_cast<GCCAsmStmt>(B->getTerminator())) {
1539 CFGBlock *Successor = (I+1)->block;
1540 for (auto *L : G->labels()) {
1541 LabelMapTy::iterator LI = LabelMap.find(L->getLabel());
1542 // If there is no target for the goto, then we are looking at an
1543 // incomplete AST. Handle this by not registering a successor.
1544 if (LI == LabelMap.end())
1545 continue;
1546 JumpTarget JT = LI->second;
1547 // Successor has been added, so skip it.
1548 if (JT.block == Successor)
1549 continue;
1550 addSuccessor(B, JT.block);
1551 }
1552 I++;
1553 }
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001554 }
1555
1556 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001557 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001558 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1559 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001560 // Lookup the target block.
1561 LabelMapTy::iterator LI = LabelMap.find(*I);
1562
1563 // If there is no target block that contains label, then we are looking
1564 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001565 if (LI == LabelMap.end()) continue;
Fangrui Song6907ce22018-07-30 19:24:48 +00001566
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001567 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001568 }
Mike Stump31feda52009-07-17 01:31:16 +00001569
Mike Stump31feda52009-07-17 01:31:16 +00001570 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001571 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001572
Artem Dergachev783a4572018-02-23 22:20:39 +00001573 if (BuildOpts.AddRichCXXConstructors)
1574 assert(ConstructionContextMap.empty() &&
1575 "Not all construction contexts were cleaned up!");
1576
David Blaikiee90195c2014-08-29 18:53:26 +00001577 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001578}
Mike Stump31feda52009-07-17 01:31:16 +00001579
Ted Kremenek9aae5132007-08-23 21:42:29 +00001580/// createBlock - Used to lazily create blocks that are connected
1581/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001582CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1583 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001584 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001585 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001586 return B;
1587}
Mike Stump31feda52009-07-17 01:31:16 +00001588
Chandler Carrutha70991b2011-09-13 09:13:49 +00001589/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1590/// CFG. It is *not* connected to the current (global) successor, and instead
1591/// directly tied to the exit block in order to be reachable.
1592CFGBlock *CFGBuilder::createNoReturnBlock() {
1593 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001594 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001595 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001596 return B;
1597}
1598
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001599/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001600CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001601 if (!BuildOpts.AddInitializers)
1602 return Block;
1603
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001604 bool HasTemporaries = false;
1605
1606 // Destructors of temporaries in initialization expression should be called
1607 // after initialization finishes.
1608 Expr *Init = I->getInit();
1609 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001610 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001611
Jordan Rose6d671cc2012-09-05 22:55:23 +00001612 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001613 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001614 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001615 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
Artem Dergachevead98ea2019-08-28 18:44:42 +00001616 /*ExternallyDestructed=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001617 }
1618 }
1619
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001620 autoCreateBlock();
1621 appendInitializer(Block, I);
1622
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001623 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001624 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001625 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001626 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001627
Ted Kremenek8219b822010-12-16 07:46:53 +00001628 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001629 // For expression with temporaries go directly to subexpression to omit
1630 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001631 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1632 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001633 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1634 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1635 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1636 // may cause the same Expr to appear more than once in the CFG. Doing it
1637 // here is safe because there's only one initializer per field.
1638 autoCreateBlock();
1639 appendStmt(Block, Default);
1640 if (Stmt *Child = Default->getExpr())
1641 if (CFGBlock *R = Visit(Child))
1642 Block = R;
1643 return Block;
1644 }
1645 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001646 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001647 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001648
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001649 return Block;
1650}
1651
Fangrui Song6907ce22018-07-30 19:24:48 +00001652/// Retrieve the type of the temporary object whose lifetime was
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001653/// extended by a local reference with the given initializer.
Artem Dergacheva25809f2018-06-04 18:56:25 +00001654static QualType getReferenceInitTemporaryType(const Expr *Init,
Richard Smithb8c0f552016-12-09 18:49:13 +00001655 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001656 while (true) {
1657 // Skip parentheses.
1658 Init = Init->IgnoreParens();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001659
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001660 // Skip through cleanups.
1661 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1662 Init = EWC->getSubExpr();
1663 continue;
1664 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001665
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001666 // Skip through the temporary-materialization expression.
1667 if (const MaterializeTemporaryExpr *MTE
1668 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1669 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001670 if (FoundMTE)
1671 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001672 continue;
1673 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001674
1675 // Skip sub-object accesses into rvalues.
1676 SmallVector<const Expr *, 2> CommaLHSs;
1677 SmallVector<SubobjectAdjustment, 2> Adjustments;
1678 const Expr *SkippedInit =
1679 Init->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments);
1680 if (SkippedInit != Init) {
1681 Init = SkippedInit;
1682 continue;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001683 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001684
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001685 break;
1686 }
1687
1688 return Init->getType();
1689}
Matthias Gehre351c2182017-07-12 07:04:19 +00001690
Peter Szecsi999a25f2017-08-19 11:19:16 +00001691// TODO: Support adding LoopExit element to the CFG in case where the loop is
1692// ended by ReturnStmt, GotoStmt or ThrowExpr.
1693void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1694 if(!BuildOpts.AddLoopExit)
1695 return;
1696 autoCreateBlock();
1697 appendLoopExit(Block, LoopStmt);
1698}
1699
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001700void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1701 LocalScope::const_iterator E, Stmt *S) {
1702 if (!BuildOpts.AddScopes)
1703 return;
1704
1705 if (B == E)
1706 return;
1707
1708 // To go from B to E, one first goes up the scopes from B to P
1709 // then sideways in one scope from P to P' and then down
1710 // the scopes from P' to E.
1711 // The lifetime of all objects between B and P end.
1712 LocalScope::const_iterator P = B.shared_parent(E);
1713 int Dist = B.distance(P);
1714 if (Dist <= 0)
1715 return;
1716
1717 for (LocalScope::const_iterator I = B; I != P; ++I)
1718 if (I.pointsToFirstDeclaredVar())
1719 DeclsWithEndedScope.insert(*I);
1720}
1721
Matthias Gehre351c2182017-07-12 07:04:19 +00001722void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1723 LocalScope::const_iterator E,
1724 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001725 getDeclsWithEndedScope(B, E, S);
1726 if (BuildOpts.AddScopes)
1727 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001728 if (BuildOpts.AddImplicitDtors)
1729 addAutomaticObjDtors(B, E, S);
1730 if (BuildOpts.AddLifetime)
1731 addLifetimeEnds(B, E, S);
1732}
1733
1734/// Add to current block automatic objects that leave the scope.
1735void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1736 LocalScope::const_iterator E, Stmt *S) {
1737 if (!BuildOpts.AddLifetime)
1738 return;
1739
1740 if (B == E)
1741 return;
1742
1743 // To go from B to E, one first goes up the scopes from B to P
1744 // then sideways in one scope from P to P' and then down
1745 // the scopes from P' to E.
1746 // The lifetime of all objects between B and P end.
1747 LocalScope::const_iterator P = B.shared_parent(E);
1748 int dist = B.distance(P);
1749 if (dist <= 0)
1750 return;
1751
1752 // We need to perform the scope leaving in reverse order
1753 SmallVector<VarDecl *, 10> DeclsTrivial;
1754 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1755 DeclsTrivial.reserve(dist);
1756 DeclsNonTrivial.reserve(dist);
1757
1758 for (LocalScope::const_iterator I = B; I != P; ++I)
1759 if (hasTrivialDestructor(*I))
1760 DeclsTrivial.push_back(*I);
1761 else
1762 DeclsNonTrivial.push_back(*I);
1763
1764 autoCreateBlock();
1765 // object with trivial destructor end their lifetime last (when storage
1766 // duration ends)
1767 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1768 E = DeclsTrivial.rend();
1769 I != E; ++I)
1770 appendLifetimeEnds(Block, *I, S);
1771
1772 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1773 I = DeclsNonTrivial.rbegin(),
1774 E = DeclsNonTrivial.rend();
1775 I != E; ++I)
1776 appendLifetimeEnds(Block, *I, S);
1777}
1778
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001779/// Add to current block markers for ending scopes.
1780void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1781 LocalScope::const_iterator E, Stmt *S) {
1782 // If implicit destructors are enabled, we'll add scope ends in
1783 // addAutomaticObjDtors.
1784 if (BuildOpts.AddImplicitDtors)
1785 return;
1786
1787 autoCreateBlock();
1788
1789 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1790 I != E; ++I)
1791 appendScopeEnd(Block, *I, S);
1792
1793 return;
1794}
1795
Marcin Swiderski5e415732010-09-30 23:05:00 +00001796/// addAutomaticObjDtors - Add to current block automatic objects destructors
1797/// for objects in range of local scope positions. Use S as trigger statement
1798/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001799void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001800 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001801 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001802 return;
1803
Marcin Swiderski5e415732010-09-30 23:05:00 +00001804 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001805 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001806
Chandler Carruthad747252011-09-13 06:09:01 +00001807 // We need to append the destructors in reverse order, but any one of them
1808 // may be a no-return destructor which changes the CFG. As a result, buffer
1809 // this sequence up and replay them in reverse order when appending onto the
1810 // CFGBlock(s).
1811 SmallVector<VarDecl*, 10> Decls;
1812 Decls.reserve(B.distance(E));
1813 for (LocalScope::const_iterator I = B; I != E; ++I)
1814 Decls.push_back(*I);
1815
1816 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1817 E = Decls.rend();
1818 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001819 if (hasTrivialDestructor(*I)) {
1820 // If AddScopes is enabled and *I is a first variable in a scope, add a
1821 // ScopeEnd marker in a Block.
1822 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1823 autoCreateBlock();
1824 appendScopeEnd(Block, *I, S);
1825 }
1826 continue;
1827 }
Chandler Carruthad747252011-09-13 06:09:01 +00001828 // If this destructor is marked as a no-return destructor, we need to
1829 // create a new block for the destructor which does not have as a successor
1830 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001831 QualType Ty = (*I)->getType();
1832 if (Ty->isReferenceType()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00001833 Ty = getReferenceInitTemporaryType((*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001834 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001835 Ty = Context->getBaseElementType(Ty);
1836
Richard Trieu95a192a2015-05-28 00:14:02 +00001837 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001838 Block = createNoReturnBlock();
1839 else
Chandler Carruthad747252011-09-13 06:09:01 +00001840 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001841
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001842 // Add ScopeEnd just after automatic obj destructor.
1843 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1844 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001845 appendAutomaticObjDtor(Block, *I, S);
1846 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001847}
1848
Marcin Swiderski20b88732010-10-05 05:37:00 +00001849/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1850/// base and member objects in destructor.
1851void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001852 assert(BuildOpts.AddImplicitDtors &&
1853 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001854 const CXXRecordDecl *RD = DD->getParent();
1855
1856 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001857 for (const auto &VI : RD->vbases()) {
Artem Dergachev192a7472019-05-24 23:37:08 +00001858 // TODO: Add a VirtualBaseBranch to see if the most derived class
1859 // (which is different from the current class) is responsible for
1860 // destroying them.
Aaron Ballman445a9392014-03-13 16:15:17 +00001861 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001862 if (!CD->hasTrivialDestructor()) {
1863 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001864 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001865 }
1866 }
1867
1868 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001869 for (const auto &BI : RD->bases()) {
1870 if (!BI.isVirtual()) {
1871 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001872 if (!CD->hasTrivialDestructor()) {
1873 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001874 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001875 }
1876 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001877 }
1878
1879 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001880 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001881 // Check for constant size array. Set type to array element type.
1882 QualType QT = FI->getType();
1883 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1884 if (AT->getSize() == 0)
1885 continue;
1886 QT = AT->getElementType();
1887 }
1888
1889 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001890 if (!CD->hasTrivialDestructor()) {
1891 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001892 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001893 }
1894 }
1895}
1896
Marcin Swiderski5e415732010-09-30 23:05:00 +00001897/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1898/// way return valid LocalScope object.
1899LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001900 if (Scope)
1901 return Scope;
1902 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1903 return new (alloc.Allocate<LocalScope>())
1904 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001905}
1906
1907/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Fangrui Song6907ce22018-07-30 19:24:48 +00001908/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001909void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001910 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1911 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001912 return;
1913
Craig Topper25542942014-05-20 04:30:07 +00001914 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001915
1916 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001917 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001918 for (auto *BI : CS->body()) {
1919 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001920 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001921 Scope = addLocalScopeForDeclStmt(DS, Scope);
1922 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001923 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001924 }
1925
1926 // For any other statement scope will be implicit and as such will be
1927 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001928 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001929 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001930}
1931
1932/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1933/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001934LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001935 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001936 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1937 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001938 return Scope;
1939
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001940 for (auto *DI : DS->decls())
1941 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001942 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001943 return Scope;
1944}
1945
Matthias Gehre351c2182017-07-12 07:04:19 +00001946bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1947 // Check for const references bound to temporary. Set type to pointee.
1948 QualType QT = VD->getType();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001949 if (QT->isReferenceType()) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001950 // Attempt to determine whether this declaration lifetime-extends a
1951 // temporary.
1952 //
1953 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1954 // temporaries, and a single declaration can extend multiple temporaries.
1955 // We should look at the storage duration on each nested
1956 // MaterializeTemporaryExpr instead.
1957
1958 const Expr *Init = VD->getInit();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001959 if (!Init) {
1960 // Probably an exception catch-by-reference variable.
1961 // FIXME: It doesn't really mean that the object has a trivial destructor.
1962 // Also are there other cases?
Matthias Gehre351c2182017-07-12 07:04:19 +00001963 return true;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001964 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001965
Artem Dergacheva25809f2018-06-04 18:56:25 +00001966 // Lifetime-extending a temporary?
Matthias Gehre351c2182017-07-12 07:04:19 +00001967 bool FoundMTE = false;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001968 QT = getReferenceInitTemporaryType(Init, &FoundMTE);
Matthias Gehre351c2182017-07-12 07:04:19 +00001969 if (!FoundMTE)
1970 return true;
1971 }
1972
1973 // Check for constant size array. Set type to array element type.
1974 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1975 if (AT->getSize() == 0)
1976 return true;
1977 QT = AT->getElementType();
1978 }
1979
1980 // Check if type is a C++ class with non-trivial destructor.
1981 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1982 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1983 return true;
1984}
1985
Marcin Swiderski5e415732010-09-30 23:05:00 +00001986/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1987/// create add scope for automatic objects and temporary objects bound to
1988/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001989LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001990 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001991 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1992 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001993 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1994 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001995 return Scope;
1996
1997 // Check if variable is local.
1998 switch (VD->getStorageClass()) {
1999 case SC_None:
2000 case SC_Auto:
2001 case SC_Register:
2002 break;
2003 default: return Scope;
2004 }
2005
Matthias Gehre351c2182017-07-12 07:04:19 +00002006 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002007 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00002008 // Add the variable to scope
2009 Scope = createOrReuseLocalScope(Scope);
2010 Scope->addVar(VD);
2011 ScopePos = Scope->begin();
2012 }
Matthias Gehre351c2182017-07-12 07:04:19 +00002013 return Scope;
2014 }
2015
2016 assert(BuildOpts.AddLifetime);
2017 // Add the variable to scope
2018 Scope = createOrReuseLocalScope(Scope);
2019 Scope->addVar(VD);
2020 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00002021 return Scope;
2022}
2023
2024/// addLocalScopeAndDtors - For given statement add local scope for it and
2025/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002026void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00002027 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00002028 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00002029 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00002030}
2031
Marcin Swiderski321a7072010-09-30 22:54:37 +00002032/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
2033/// variables with automatic storage duration to CFGBlock's elements vector.
2034/// Elements will be prepended to physical beginning of the vector which
2035/// happens to be logical end. Use blocks terminator as statement that specifies
2036/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00002037/// FIXME: This mechanism for adding automatic destructors doesn't handle
2038/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002039void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00002040 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002041 if (!BuildOpts.AddImplicitDtors)
2042 return;
Chandler Carruthad747252011-09-13 06:09:01 +00002043 BumpVectorContext &C = cfg->getBumpVectorContext();
2044 CFGBlock::iterator InsertPos
2045 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
2046 for (LocalScope::const_iterator I = B; I != E; ++I)
2047 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
Artem Dergachev4e530322019-05-24 01:34:22 +00002048 Blk->getTerminatorStmt());
Marcin Swiderski321a7072010-09-30 22:54:37 +00002049}
2050
Matthias Gehre351c2182017-07-12 07:04:19 +00002051/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
2052/// variables with automatic storage duration to CFGBlock's elements vector.
2053/// Elements will be prepended to physical beginning of the vector which
2054/// happens to be logical end. Use blocks terminator as statement that specifies
2055/// where lifetime ends.
2056void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
2057 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
2058 if (!BuildOpts.AddLifetime)
2059 return;
2060 BumpVectorContext &C = cfg->getBumpVectorContext();
2061 CFGBlock::iterator InsertPos =
2062 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
Artem Dergachev4e530322019-05-24 01:34:22 +00002063 for (LocalScope::const_iterator I = B; I != E; ++I) {
2064 InsertPos =
2065 Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminatorStmt());
2066 }
Matthias Gehre351c2182017-07-12 07:04:19 +00002067}
Eugene Zelenko38c70522017-12-07 21:55:09 +00002068
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002069/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
2070/// variables with automatic storage duration to CFGBlock's elements vector.
2071/// Elements will be prepended to physical beginning of the vector which
2072/// happens to be logical end. Use blocks terminator as statement that specifies
2073/// where scope ends.
2074const VarDecl *
2075CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
2076 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
2077 if (!BuildOpts.AddScopes)
2078 return nullptr;
2079 BumpVectorContext &C = cfg->getBumpVectorContext();
2080 CFGBlock::iterator InsertPos =
2081 Blk->beginScopeEndInsert(Blk->end(), 1, C);
2082 LocalScope::const_iterator PlaceToInsert = B;
2083 for (LocalScope::const_iterator I = B; I != E; ++I)
2084 PlaceToInsert = I;
Artem Dergachev4e530322019-05-24 01:34:22 +00002085 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminatorStmt());
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002086 return *PlaceToInsert;
2087}
2088
Ted Kremenek93668002009-07-17 22:18:43 +00002089/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00002090/// blocks for ternary operators, &&, and ||. We also process "," and
2091/// DeclStmts (which may contain nested control-flow).
Artem Dergachevead98ea2019-08-28 18:44:42 +00002092CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc,
2093 bool ExternallyDestructed) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00002094 if (!S) {
2095 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00002096 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00002097 }
Jordy Rose17347372011-06-10 08:49:37 +00002098
2099 if (Expr *E = dyn_cast<Expr>(S))
2100 S = E->IgnoreParens();
2101
Alexey Bataevc2c21ef2019-07-11 14:54:17 +00002102 if (Context->getLangOpts().OpenMP)
2103 if (auto *D = dyn_cast<OMPExecutableDirective>(S))
2104 return VisitOMPExecutableDirective(D, asc);
2105
Ted Kremenek93668002009-07-17 22:18:43 +00002106 switch (S->getStmtClass()) {
2107 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002108 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002109
2110 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002111 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002112
John McCallc07a0c72011-02-17 10:25:35 +00002113 case Stmt::BinaryConditionalOperatorClass:
2114 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
2115
Ted Kremenek93668002009-07-17 22:18:43 +00002116 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002117 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002118
Ted Kremenek93668002009-07-17 22:18:43 +00002119 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00002120 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002121
Ted Kremenek93668002009-07-17 22:18:43 +00002122 case Stmt::BreakStmtClass:
2123 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002124
Ted Kremenek93668002009-07-17 22:18:43 +00002125 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00002126 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00002127 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00002128 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002129 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002130
Ted Kremenek93668002009-07-17 22:18:43 +00002131 case Stmt::CaseStmtClass:
2132 return VisitCaseStmt(cast<CaseStmt>(S));
2133
2134 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002135 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002136
Ted Kremenek93668002009-07-17 22:18:43 +00002137 case Stmt::CompoundStmtClass:
Artem Dergachevead98ea2019-08-28 18:44:42 +00002138 return VisitCompoundStmt(cast<CompoundStmt>(S), ExternallyDestructed);
Mike Stump11289f42009-09-09 15:08:12 +00002139
Ted Kremenek93668002009-07-17 22:18:43 +00002140 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002141 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002142
Ted Kremenek93668002009-07-17 22:18:43 +00002143 case Stmt::ContinueStmtClass:
2144 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002145
Ted Kremenekb27378c2010-01-19 20:40:33 +00002146 case Stmt::CXXCatchStmtClass:
2147 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
2148
John McCall5d413782010-12-06 08:20:24 +00002149 case Stmt::ExprWithCleanupsClass:
Artem Dergachevead98ea2019-08-28 18:44:42 +00002150 return VisitExprWithCleanups(cast<ExprWithCleanups>(S),
2151 asc, ExternallyDestructed);
Ted Kremenek82bfc862010-08-28 00:19:02 +00002152
Jordan Rosee5d53932012-08-23 18:10:53 +00002153 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00002154 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00002155 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
2156 // called function's declaration, not by the caller. If we simply add
2157 // this expression to the CFG, we could end up with the same Expr
2158 // appearing multiple times.
2159 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00002160 //
2161 // It's likewise possible for multiple CXXDefaultInitExprs for the same
2162 // expression to be used in the same function (through aggregate
2163 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00002164 return VisitStmt(S, asc);
2165
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002166 case Stmt::CXXBindTemporaryExprClass:
2167 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
2168
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002169 case Stmt::CXXConstructExprClass:
2170 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
2171
Jordan Rosec9176072014-01-13 17:59:19 +00002172 case Stmt::CXXNewExprClass:
2173 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2174
Jordan Rosed2f40792013-09-03 17:00:57 +00002175 case Stmt::CXXDeleteExprClass:
2176 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2177
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002178 case Stmt::CXXFunctionalCastExprClass:
2179 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2180
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002181 case Stmt::CXXTemporaryObjectExprClass:
2182 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2183
Ted Kremenekb27378c2010-01-19 20:40:33 +00002184 case Stmt::CXXThrowExprClass:
2185 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002186
Ted Kremenekb27378c2010-01-19 20:40:33 +00002187 case Stmt::CXXTryStmtClass:
2188 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002189
Richard Smith02e85f32011-04-14 22:09:26 +00002190 case Stmt::CXXForRangeStmtClass:
2191 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2192
Ted Kremenek93668002009-07-17 22:18:43 +00002193 case Stmt::DeclStmtClass:
2194 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002195
Ted Kremenek93668002009-07-17 22:18:43 +00002196 case Stmt::DefaultStmtClass:
2197 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002198
Ted Kremenek93668002009-07-17 22:18:43 +00002199 case Stmt::DoStmtClass:
2200 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002201
Ted Kremenek93668002009-07-17 22:18:43 +00002202 case Stmt::ForStmtClass:
2203 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002204
Ted Kremenek93668002009-07-17 22:18:43 +00002205 case Stmt::GotoStmtClass:
2206 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002207
Jennifer Yub8fee672019-06-03 15:57:25 +00002208 case Stmt::GCCAsmStmtClass:
2209 return VisitGCCAsmStmt(cast<GCCAsmStmt>(S), asc);
2210
Ted Kremenek93668002009-07-17 22:18:43 +00002211 case Stmt::IfStmtClass:
2212 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002213
Ted Kremenek8219b822010-12-16 07:46:53 +00002214 case Stmt::ImplicitCastExprClass:
2215 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002216
Bill Wendling8003edc2018-11-09 00:41:36 +00002217 case Stmt::ConstantExprClass:
2218 return VisitConstantExpr(cast<ConstantExpr>(S), asc);
2219
Ted Kremenek93668002009-07-17 22:18:43 +00002220 case Stmt::IndirectGotoStmtClass:
2221 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002222
Ted Kremenek93668002009-07-17 22:18:43 +00002223 case Stmt::LabelStmtClass:
2224 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002225
Ted Kremenekda76a942012-04-12 20:34:52 +00002226 case Stmt::LambdaExprClass:
2227 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2228
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002229 case Stmt::MaterializeTemporaryExprClass:
2230 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2231 asc);
2232
Ted Kremenek5868ec62010-04-11 17:02:10 +00002233 case Stmt::MemberExprClass:
2234 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2235
Ted Kremenek04268232011-11-05 00:10:15 +00002236 case Stmt::NullStmtClass:
2237 return Block;
2238
Ted Kremenek93668002009-07-17 22:18:43 +00002239 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002240 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2241
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002242 case Stmt::ObjCAutoreleasePoolStmtClass:
2243 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2244
Ted Kremenek93668002009-07-17 22:18:43 +00002245 case Stmt::ObjCAtSynchronizedStmtClass:
2246 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002247
Ted Kremenek93668002009-07-17 22:18:43 +00002248 case Stmt::ObjCAtThrowStmtClass:
2249 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002250
Ted Kremenek93668002009-07-17 22:18:43 +00002251 case Stmt::ObjCAtTryStmtClass:
2252 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002253
Ted Kremenek93668002009-07-17 22:18:43 +00002254 case Stmt::ObjCForCollectionStmtClass:
2255 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002256
Artem Dergachevbd880fe2018-07-31 19:39:37 +00002257 case Stmt::ObjCMessageExprClass:
2258 return VisitObjCMessageExpr(cast<ObjCMessageExpr>(S), asc);
2259
Ted Kremenek04268232011-11-05 00:10:15 +00002260 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002261 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002262
John McCallfe96e0b2011-11-06 09:01:30 +00002263 case Stmt::PseudoObjectExprClass:
2264 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2265
Ted Kremenek93668002009-07-17 22:18:43 +00002266 case Stmt::ReturnStmtClass:
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002267 case Stmt::CoreturnStmtClass:
2268 return VisitReturnStmt(S);
Mike Stump11289f42009-09-09 15:08:12 +00002269
Nico Weber699670e2017-08-23 15:33:16 +00002270 case Stmt::SEHExceptStmtClass:
2271 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2272
2273 case Stmt::SEHFinallyStmtClass:
2274 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2275
2276 case Stmt::SEHLeaveStmtClass:
2277 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2278
2279 case Stmt::SEHTryStmtClass:
2280 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2281
Peter Collingbournee190dee2011-03-11 19:24:49 +00002282 case Stmt::UnaryExprOrTypeTraitExprClass:
2283 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2284 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002285
Ted Kremenek93668002009-07-17 22:18:43 +00002286 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002287 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002288
Ted Kremenek93668002009-07-17 22:18:43 +00002289 case Stmt::SwitchStmtClass:
2290 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002291
Zhanyong Wan6dace612010-11-22 08:45:56 +00002292 case Stmt::UnaryOperatorClass:
2293 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2294
Ted Kremenek93668002009-07-17 22:18:43 +00002295 case Stmt::WhileStmtClass:
2296 return VisitWhileStmt(cast<WhileStmt>(S));
2297 }
2298}
Mike Stump11289f42009-09-09 15:08:12 +00002299
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002300CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002301 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002302 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002303 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002304 }
Mike Stump11289f42009-09-09 15:08:12 +00002305
Ted Kremenek93668002009-07-17 22:18:43 +00002306 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002307}
Mike Stump31feda52009-07-17 01:31:16 +00002308
Ted Kremenek93668002009-07-17 22:18:43 +00002309/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002310CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2311 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002312
Ted Kremenek8ae67872013-02-05 22:00:19 +00002313 // Visit the children in their reverse order so that they appear in
2314 // left-to-right (natural) order in the CFG.
2315 reverse_children RChildren(S);
2316 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2317 I != E; ++I) {
2318 if (Stmt *Child = *I)
2319 if (CFGBlock *R = Visit(Child))
2320 B = R;
2321 }
2322 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002323}
Mike Stump11289f42009-09-09 15:08:12 +00002324
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002325CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2326 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002327 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002328
Ted Kremenek7c58d352011-03-10 01:14:11 +00002329 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002330 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002331 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002332 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002333
Ted Kremenek9aae5132007-08-23 21:42:29 +00002334 return Block;
2335}
Mike Stump11289f42009-09-09 15:08:12 +00002336
Zhanyong Wan6dace612010-11-22 08:45:56 +00002337CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002338 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002339 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002340 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002341 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002342 }
2343
Ted Kremenek8219b822010-12-16 07:46:53 +00002344 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002345}
2346
Ted Kremeneka16436f2012-07-14 05:04:06 +00002347CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2348 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2349 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002350
Ted Kremeneka16436f2012-07-14 05:04:06 +00002351 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002352 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002353
Craig Topper25542942014-05-20 04:30:07 +00002354 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2355 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002356}
2357
2358std::pair<CFGBlock*, CFGBlock*>
2359CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2360 Stmt *Term,
2361 CFGBlock *TrueBlock,
2362 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002363 // Introspect the RHS. If it is a nested logical operation, we recursively
2364 // build the CFG using this function. Otherwise, resort to default
2365 // CFG construction behavior.
2366 Expr *RHS = B->getRHS()->IgnoreParens();
2367 CFGBlock *RHSBlock, *ExitBlock;
2368
2369 do {
2370 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2371 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002372 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002373 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2374 break;
2375 }
2376
2377 // The RHS is not a nested logical operation. Don't push the terminator
2378 // down further, but instead visit RHS and construct the respective
2379 // pieces of the CFG, and link up the RHSBlock with the terminator
2380 // we have been provided.
2381 ExitBlock = RHSBlock = createBlock(false);
2382
Richard Trieu6a6af522017-01-04 00:46:30 +00002383 // Even though KnownVal is only used in the else branch of the next
2384 // conditional, tryEvaluateBool performs additional checking on the
2385 // Expr, so it should be called unconditionally.
2386 TryResult KnownVal = tryEvaluateBool(RHS);
2387 if (!KnownVal.isKnown())
2388 KnownVal = tryEvaluateBool(B);
2389
Ted Kremenekb50e7162012-07-14 05:04:10 +00002390 if (!Term) {
2391 assert(TrueBlock == FalseBlock);
2392 addSuccessor(RHSBlock, TrueBlock);
2393 }
2394 else {
2395 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002396 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2397 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002398 }
2399
2400 Block = RHSBlock;
2401 RHSBlock = addStmt(RHS);
2402 }
2403 while (false);
2404
2405 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002406 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002407
2408 // Generate the blocks for evaluating the LHS.
2409 Expr *LHS = B->getLHS()->IgnoreParens();
2410
2411 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2412 if (B_LHS->isLogicalOp()) {
2413 if (B->getOpcode() == BO_LOr)
2414 FalseBlock = RHSBlock;
2415 else
2416 TrueBlock = RHSBlock;
2417
2418 // For the LHS, treat 'B' as the terminator that we want to sink
2419 // into the nested branch. The RHS always gets the top-most
2420 // terminator.
2421 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2422 }
2423
2424 // Create the block evaluating the LHS.
2425 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002426 CFGBlock *LHSBlock = createBlock(false);
2427 LHSBlock->setTerminator(B);
2428
Ted Kremeneka16436f2012-07-14 05:04:06 +00002429 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002430 CFGBlock *EntryLHSBlock = addStmt(LHS);
2431
2432 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002433 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002434
2435 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002436 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002437
2438 // Now link the LHSBlock with RHSBlock.
2439 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002440 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2441 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002442 } else {
2443 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002444 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2445 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002446 }
2447
Ted Kremenekb50e7162012-07-14 05:04:10 +00002448 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002449}
2450
2451CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2452 AddStmtChoice asc) {
2453 // && or ||
2454 if (B->isLogicalOp())
2455 return VisitLogicalOperator(B);
2456
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002457 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002458 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002459 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002460 addStmt(B->getRHS());
2461 return addStmt(B->getLHS());
2462 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002463
2464 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002465 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002466 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002467 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002468 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002469 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002470 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002471 }
Mike Stump11289f42009-09-09 15:08:12 +00002472
Ted Kremenek7c58d352011-03-10 01:14:11 +00002473 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002474 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002475 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002476 }
2477
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002478 CFGBlock *RBlock = Visit(B->getRHS());
2479 CFGBlock *LBlock = Visit(B->getLHS());
2480 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2481 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2482 // return RBlock. Otherwise we'll incorrectly return NULL.
2483 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002484}
2485
Ted Kremeneke2499842012-04-12 20:03:44 +00002486CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002487 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002488 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002489 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002490 }
2491 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002492}
2493
Ted Kremenek93668002009-07-17 22:18:43 +00002494CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2495 // "break" is a control-flow statement. Thus we stop processing the current
2496 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002497 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002498 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002499
Ted Kremenek93668002009-07-17 22:18:43 +00002500 // Now create a new block that ends with the break statement.
2501 Block = createBlock(false);
2502 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002503
Ted Kremenek93668002009-07-17 22:18:43 +00002504 // If there is no target for the break, then we are looking at an incomplete
2505 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002506 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002507 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002508 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002509 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002510 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002511
Ted Kremenek9aae5132007-08-23 21:42:29 +00002512 return Block;
2513}
Mike Stump11289f42009-09-09 15:08:12 +00002514
Sebastian Redl31ad7542011-03-13 17:09:40 +00002515static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002516 QualType Ty = E->getType();
Artem Dergachev3517d102019-08-28 21:19:58 +00002517 if (Ty->isFunctionPointerType() || Ty->isBlockPointerType())
2518 Ty = Ty->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002519
Mike Stump04c68512010-01-21 15:20:48 +00002520 const FunctionType *FT = Ty->getAs<FunctionType>();
2521 if (FT) {
2522 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002523 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00002524 Proto->isNothrow())
Mike Stump04c68512010-01-21 15:20:48 +00002525 return false;
2526 }
2527 return true;
2528}
2529
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002530CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002531 // Compute the callee type.
2532 QualType calleeType = C->getCallee()->getType();
2533 if (calleeType == Context->BoundMemberTy) {
2534 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2535
2536 // We should only get a null bound type if processing a dependent
2537 // CFG. Recover by assuming nothing.
2538 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002539 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002540
John McCallc67067f2011-05-11 07:19:11 +00002541 // If this is a call to a no-return function, this stops the block here.
2542 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2543
Mike Stump04c68512010-01-21 15:20:48 +00002544 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002545
2546 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002547 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002548 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002549 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002550 }
2551
Jordan Rose5374c072013-08-19 16:27:28 +00002552 // If this is a call to a builtin function, it might not actually evaluate
2553 // its arguments. Don't add them to the CFG if this is the case.
2554 bool OmitArguments = false;
2555
Mike Stump92244b02010-01-19 22:00:14 +00002556 if (FunctionDecl *FD = C->getDirectCallee()) {
Artem Dergachev594b5412018-08-29 21:50:52 +00002557 // TODO: Support construction contexts for variadic function arguments.
2558 // These are a bit problematic and not very useful because passing
2559 // C++ objects as C-style variadic arguments doesn't work in general
2560 // (see [expr.call]).
2561 if (!FD->isVariadic())
2562 findConstructionContextsForArguments(C);
2563
Nico Weber758fbac2018-02-13 21:31:47 +00002564 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002565 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002566 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002567 AddEHEdge = false;
Erik Pilkington9c3b5882019-01-30 20:34:53 +00002568 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size ||
2569 FD->getBuiltinID() == Builtin::BI__builtin_dynamic_object_size)
Jordan Rose5374c072013-08-19 16:27:28 +00002570 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002571 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002572
Sebastian Redl31ad7542011-03-13 17:09:40 +00002573 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002574 AddEHEdge = false;
2575
Jordan Rose5374c072013-08-19 16:27:28 +00002576 if (OmitArguments) {
2577 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2578 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2579 autoCreateBlock();
2580 appendStmt(Block, C);
2581 return Visit(C->getCallee());
2582 }
2583
2584 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002585 autoCreateBlock();
2586 appendCall(Block, C);
2587
2588 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002589 }
Mike Stump11289f42009-09-09 15:08:12 +00002590
Mike Stump92244b02010-01-19 22:00:14 +00002591 if (Block) {
2592 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002593 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002594 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002595 }
Mike Stump11289f42009-09-09 15:08:12 +00002596
Chandler Carrutha70991b2011-09-13 09:13:49 +00002597 if (NoReturn)
2598 Block = createNoReturnBlock();
2599 else
2600 Block = createBlock();
2601
Artem Dergachev1527dec2018-03-12 23:12:40 +00002602 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002603
Mike Stump04c68512010-01-21 15:20:48 +00002604 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002605 // Add exceptional edges.
2606 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002607 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002608 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002609 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002610 }
Mike Stump11289f42009-09-09 15:08:12 +00002611
Mike Stump8c5d7992009-07-25 21:26:53 +00002612 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002613}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002614
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002615CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2616 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002617 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002618 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002619 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002620 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002621
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002622 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002623 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002624 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002625 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002626 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002627 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002628
Ted Kremenek21822592009-07-17 18:20:32 +00002629 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002630 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002631 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002632 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002633 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002634
Ted Kremenek21822592009-07-17 18:20:32 +00002635 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002636 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002637 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002638 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2639 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002640 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002641 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002642}
Mike Stump11289f42009-09-09 15:08:12 +00002643
Artem Dergachevead98ea2019-08-28 18:44:42 +00002644CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C, bool ExternallyDestructed) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002645 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002646 addLocalScopeForStmt(C);
2647
Matthias Gehre09a134e2015-11-14 00:36:50 +00002648 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002649 // If the body ends with a ReturnStmt, the dtors will be added in
2650 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002651 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002652 }
2653
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002654 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002655
2656 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2657 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002658 // If we hit a segment of code just containing ';' (NullStmts), we can
2659 // get a null block back. In such cases, just use the LastBlock
Artem Dergachevead98ea2019-08-28 18:44:42 +00002660 CFGBlock *newBlock = Visit(*I, AddStmtChoice::AlwaysAdd,
2661 ExternallyDestructed);
2662
2663 if (newBlock)
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002664 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002665
Ted Kremenekce499c22009-08-27 23:16:26 +00002666 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002667 return nullptr;
Artem Dergachevead98ea2019-08-28 18:44:42 +00002668
2669 ExternallyDestructed = false;
Mike Stump11289f42009-09-09 15:08:12 +00002670 }
Mike Stump92244b02010-01-19 22:00:14 +00002671
Ted Kremenek93668002009-07-17 22:18:43 +00002672 return LastBlock;
2673}
Mike Stump11289f42009-09-09 15:08:12 +00002674
John McCallc07a0c72011-02-17 10:25:35 +00002675CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002676 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002677 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002678 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002679
Ted Kremenek51d40b02009-07-17 18:15:54 +00002680 // Create the confluence block that will "merge" the results of the ternary
2681 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002682 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002683 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002684 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002685 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002686
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002687 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002688
Ted Kremenek51d40b02009-07-17 18:15:54 +00002689 // Create a block for the LHS expression if there is an LHS expression. A
2690 // GCC extension allows LHS to be NULL, causing the condition to be the
2691 // value that is returned instead.
2692 // e.g: x ?: y is shorthand for: x ? x : y;
2693 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002694 Block = nullptr;
2695 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002696 const Expr *trueExpr = C->getTrueExpr();
2697 if (trueExpr != opaqueValue) {
2698 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002699 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002700 return nullptr;
2701 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002702 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002703 else
2704 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002705
Ted Kremenek51d40b02009-07-17 18:15:54 +00002706 // Create the block for the RHS expression.
2707 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002708 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002709 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002710 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002711
Richard Smithf676e452012-07-24 21:02:14 +00002712 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2713 if (BinaryOperator *Cond =
2714 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2715 if (Cond->isLogicalOp())
2716 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2717
Ted Kremenek51d40b02009-07-17 18:15:54 +00002718 // Create the block that will contain the condition.
2719 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002720
Mike Stump773582d2009-07-23 23:25:26 +00002721 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002722 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002723 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2724 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002725 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002726 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002727
Ted Kremenekd8138012011-02-24 03:09:15 +00002728 if (opaqueValue) {
2729 // Run the condition expression if it's not trivially expressed in
2730 // terms of the opaque value (or if there is no opaque value).
2731 if (condExpr != opaqueValue)
2732 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002733
Ted Kremenekd8138012011-02-24 03:09:15 +00002734 // Before that, run the common subexpression if there was one.
2735 // At least one of this or the above will be run.
2736 return addStmt(BCO->getCommon());
2737 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002738
Ted Kremenekd8138012011-02-24 03:09:15 +00002739 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002740}
2741
Ted Kremenek93668002009-07-17 22:18:43 +00002742CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002743 // Check if the Decl is for an __label__. If so, elide it from the
2744 // CFG entirely.
2745 if (isa<LabelDecl>(*DS->decl_begin()))
2746 return Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00002747
Ted Kremenek3a601142011-05-24 20:41:31 +00002748 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002749 if (DS->isSingleDecl())
2750 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002751
Craig Topper25542942014-05-20 04:30:07 +00002752 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002753
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002754 // Build an individual DeclStmt for each decl.
2755 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2756 E = DS->decl_rend();
2757 I != E; ++I) {
Mike Stump11289f42009-09-09 15:08:12 +00002758
Ted Kremenek93668002009-07-17 22:18:43 +00002759 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2760 // automatically freed with the CFG.
2761 DeclGroupRef DG(*I);
2762 Decl *D = *I;
George Karpenkovc1ac8082018-10-02 21:19:01 +00002763 DeclStmt *DSNew = new (Context) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002764 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002765
Ted Kremenek93668002009-07-17 22:18:43 +00002766 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002767 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002768 }
Mike Stump11289f42009-09-09 15:08:12 +00002769
2770 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002771}
Mike Stump11289f42009-09-09 15:08:12 +00002772
Ted Kremenek93668002009-07-17 22:18:43 +00002773/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002774/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002775CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002776 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002777 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002778
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002779 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002780 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2781 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002782 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002783 }
Mike Stump11289f42009-09-09 15:08:12 +00002784
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002785 bool HasTemporaries = false;
2786
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002787 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002788 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002789
2790 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2791 // For static variables, we need to create a branch to track
2792 // whether or not they are initialized.
2793 if (Block) {
2794 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002795 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002796 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002797 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002798 }
2799 blockAfterStaticInit = Succ;
2800 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002801
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002802 // Destructors of temporaries in initialization expression should be called
2803 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002804 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002805 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002806 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002807
Jordan Rose6d671cc2012-09-05 22:55:23 +00002808 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002809 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002810 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002811 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
Artem Dergachevead98ea2019-08-28 18:44:42 +00002812 /*ExternallyDestructed=*/true, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002813 }
2814 }
2815
2816 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002817 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002818
Artem Dergachev783a4572018-02-23 22:20:39 +00002819 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002820 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002821 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002822
Ted Kremenek213d0532012-03-22 05:57:43 +00002823 // Keep track of the last non-null block, as 'Block' can be nulled out
2824 // if the initializer expression is something like a 'while' in a
2825 // statement-expression.
2826 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002827
Ted Kremenek93668002009-07-17 22:18:43 +00002828 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002829 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002830 // For expression with temporaries go directly to subexpression to omit
2831 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002832 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2833 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2834 LastBlock = newBlock;
2835 }
2836 else {
2837 if (CFGBlock *newBlock = Visit(Init))
2838 LastBlock = newBlock;
2839 }
Ted Kremenek93668002009-07-17 22:18:43 +00002840 }
Mike Stump11289f42009-09-09 15:08:12 +00002841
Ted Kremenek93668002009-07-17 22:18:43 +00002842 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002843 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002844 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002845 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2846 LastBlock = newBlock;
2847 }
Mike Stump11289f42009-09-09 15:08:12 +00002848
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002849 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2850
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002851 // Remove variable from local scope.
2852 if (ScopePos && VD == *ScopePos)
2853 ++ScopePos;
2854
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002855 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002856 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002857 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002858 Block = createBlock(false);
2859 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002860 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002861 addSuccessor(Block, B);
2862 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002863 }
2864
2865 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002866}
2867
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002868CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002869 // We may see an if statement in the middle of a basic block, or it may be the
2870 // first statement we are processing. In either case, we create a new basic
2871 // block. First, we create the blocks for the then...else statements, and
2872 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002873 // middle of a block, we stop processing that block. That block is then the
2874 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002875
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002876 // Save local scope position because in case of condition variable ScopePos
2877 // won't be restored when traversing AST.
2878 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2879
Richard Smitha547eb22016-07-14 00:11:03 +00002880 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002881 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002882 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002883
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002884 // Create local scope for possible condition variable.
2885 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002886 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002887 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002888
Matthias Gehre351c2182017-07-12 07:04:19 +00002889 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002890
Chris Lattner57540c52011-04-15 05:22:18 +00002891 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002892 // block.
2893 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002894 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002895 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002896 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002897 }
Mike Stump31feda52009-07-17 01:31:16 +00002898
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002899 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002900 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002901
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002902 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002903 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002904
Ted Kremenek9aae5132007-08-23 21:42:29 +00002905 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002906 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002907 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002908
2909 // If branch is not a compound statement create implicit scope
2910 // and add destructors.
2911 if (!isa<CompoundStmt>(Else))
2912 addLocalScopeAndDtors(Else);
2913
Ted Kremenek93668002009-07-17 22:18:43 +00002914 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002915
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002916 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2917 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002918 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002919 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002920 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002921 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002922 }
Mike Stump31feda52009-07-17 01:31:16 +00002923
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002924 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002925 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002926 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002927 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002928 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002929 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002930 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002931
2932 // If branch is not a compound statement create implicit scope
2933 // and add destructors.
2934 if (!isa<CompoundStmt>(Then))
2935 addLocalScopeAndDtors(Then);
2936
Ted Kremenek93668002009-07-17 22:18:43 +00002937 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002938
Ted Kremenek1b379512009-04-01 03:52:47 +00002939 if (!ThenBlock) {
2940 // We can reach here if the "then" body has all NullStmts.
2941 // Create an empty block so we can distinguish between true and false
2942 // branches in path-sensitive analyses.
2943 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002944 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002945 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002946 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002947 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002948 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002949 }
2950
Ted Kremenekb50e7162012-07-14 05:04:10 +00002951 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2952 // having these handle the actual control-flow jump. Note that
2953 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2954 // we resort to the old control-flow behavior. This special handling
2955 // removes infeasible paths from the control-flow graph by having the
2956 // control-flow transfer of '&&' or '||' go directly into the then/else
2957 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002958 BinaryOperator *Cond =
2959 I->getConditionVariable()
2960 ? nullptr
2961 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2962 CFGBlock *LastBlock;
2963 if (Cond && Cond->isLogicalOp())
2964 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2965 else {
2966 // Now create a new block containing the if statement.
2967 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002968
Richard Smith509bbd12017-01-13 22:16:41 +00002969 // Set the terminator of the new block to the If statement.
2970 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002971
Richard Smith509bbd12017-01-13 22:16:41 +00002972 // See if this is a known constant.
2973 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002974
Richard Smith509bbd12017-01-13 22:16:41 +00002975 // Add the successors. If we know that specific branches are
2976 // unreachable, inform addSuccessor() of that knowledge.
Rui Ueyama49a3ad22019-07-16 04:46:31 +00002977 addSuccessor(Block, ThenBlock, /* IsReachable = */ !KnownVal.isFalse());
2978 addSuccessor(Block, ElseBlock, /* IsReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002979
Richard Smith509bbd12017-01-13 22:16:41 +00002980 // Add the condition as the last statement in the new block. This may
2981 // create new blocks as the condition may contain control-flow. Any newly
2982 // created blocks will be pointed to be "Block".
2983 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002984
Richard Smith509bbd12017-01-13 22:16:41 +00002985 // If the IfStmt contains a condition variable, add it and its
2986 // initializer to the CFG.
2987 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2988 autoCreateBlock();
2989 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2990 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002991 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002992
Richard Smitha547eb22016-07-14 00:11:03 +00002993 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2994 if (Stmt *Init = I->getInit()) {
2995 autoCreateBlock();
2996 LastBlock = addStmt(Init);
2997 }
2998
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002999 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003000}
Mike Stump31feda52009-07-17 01:31:16 +00003001
Brian Gesiaka87ecf62018-11-03 22:35:17 +00003002CFGBlock *CFGBuilder::VisitReturnStmt(Stmt *S) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003003 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003004 //
Brian Gesiaka87ecf62018-11-03 22:35:17 +00003005 // NOTE: If a "return" or "co_return" appears in the middle of a block, this
3006 // means that the code afterwards is DEAD (unreachable). We still keep
3007 // a basic block for that code; a simple "mark-and-sweep" from the entry
3008 // block will be able to report such dead blocks.
3009 assert(isa<ReturnStmt>(S) || isa<CoreturnStmt>(S));
Ted Kremenek9aae5132007-08-23 21:42:29 +00003010
3011 // Create the new block.
3012 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003013
Brian Gesiaka87ecf62018-11-03 22:35:17 +00003014 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), S);
Pavel Labath921e7652013-09-06 08:12:48 +00003015
Brian Gesiaka87ecf62018-11-03 22:35:17 +00003016 if (auto *R = dyn_cast<ReturnStmt>(S))
3017 findConstructionContexts(
3018 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
3019 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00003020
Pavel Labath921e7652013-09-06 08:12:48 +00003021 // If the one of the destructors does not return, we already have the Exit
3022 // block as a successor.
3023 if (!Block->hasNoReturnElement())
3024 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003025
Artem Dergachevead98ea2019-08-28 18:44:42 +00003026 // Add the return statement to the block.
3027 appendStmt(Block, S);
3028
3029 // Visit children
3030 if (ReturnStmt *RS = dyn_cast<ReturnStmt>(S)) {
Artem Dergacheve5c09942019-08-29 20:37:28 +00003031 if (Expr *O = RS->getRetValue())
3032 return Visit(O, AddStmtChoice::AlwaysAdd, /*ExternallyDestructed=*/true);
Artem Dergachevead98ea2019-08-28 18:44:42 +00003033 return Block;
3034 } else { // co_return
3035 return VisitChildren(S);
3036 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003037}
3038
Nico Weber699670e2017-08-23 15:33:16 +00003039CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
3040 // SEHExceptStmt are treated like labels, so they are the first statement in a
3041 // block.
3042
3043 // Save local scope position because in case of exception variable ScopePos
3044 // won't be restored when traversing AST.
3045 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3046
3047 addStmt(ES->getBlock());
3048 CFGBlock *SEHExceptBlock = Block;
3049 if (!SEHExceptBlock)
3050 SEHExceptBlock = createBlock();
3051
3052 appendStmt(SEHExceptBlock, ES);
3053
3054 // Also add the SEHExceptBlock as a label, like with regular labels.
3055 SEHExceptBlock->setLabel(ES);
3056
3057 // Bail out if the CFG is bad.
3058 if (badCFG)
3059 return nullptr;
3060
3061 // We set Block to NULL to allow lazy creation of a new block (if necessary).
3062 Block = nullptr;
3063
3064 return SEHExceptBlock;
3065}
3066
3067CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
Artem Dergachevead98ea2019-08-28 18:44:42 +00003068 return VisitCompoundStmt(FS->getBlock(), /*ExternallyDestructed=*/false);
Nico Weber699670e2017-08-23 15:33:16 +00003069}
3070
3071CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
3072 // "__leave" is a control-flow statement. Thus we stop processing the current
3073 // block.
3074 if (badCFG)
3075 return nullptr;
3076
3077 // Now create a new block that ends with the __leave statement.
3078 Block = createBlock(false);
3079 Block->setTerminator(LS);
3080
3081 // If there is no target for the __leave, then we are looking at an incomplete
3082 // AST. This means that the CFG cannot be constructed.
3083 if (SEHLeaveJumpTarget.block) {
3084 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
3085 addSuccessor(Block, SEHLeaveJumpTarget.block);
3086 } else
3087 badCFG = true;
3088
3089 return Block;
3090}
3091
3092CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
3093 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
3094 // processing the current block.
3095 CFGBlock *SEHTrySuccessor = nullptr;
3096
3097 if (Block) {
3098 if (badCFG)
3099 return nullptr;
3100 SEHTrySuccessor = Block;
3101 } else SEHTrySuccessor = Succ;
3102
3103 // FIXME: Implement __finally support.
3104 if (Terminator->getFinallyHandler())
3105 return NYS();
3106
3107 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
3108
3109 // Create a new block that will contain the __try statement.
3110 CFGBlock *NewTryTerminatedBlock = createBlock(false);
3111
3112 // Add the terminator in the __try block.
3113 NewTryTerminatedBlock->setTerminator(Terminator);
3114
3115 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
3116 // The code after the try is the implicit successor if there's an __except.
3117 Succ = SEHTrySuccessor;
3118 Block = nullptr;
3119 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
3120 if (!ExceptBlock)
3121 return nullptr;
3122 // Add this block to the list of successors for the block with the try
3123 // statement.
3124 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
3125 }
3126 if (PrevSEHTryTerminatedBlock)
3127 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
3128 else
3129 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
3130
3131 // The code after the try is the implicit successor.
3132 Succ = SEHTrySuccessor;
3133
3134 // Save the current "__try" context.
3135 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
3136 NewTryTerminatedBlock);
3137 cfg->addTryDispatchBlock(TryTerminatedBlock);
3138
3139 // Save the current value for the __leave target.
3140 // All __leaves should go to the code following the __try
3141 // (FIXME: or if the __try has a __finally, to the __finally.)
3142 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
3143 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
3144
3145 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
3146 Block = nullptr;
3147 return addStmt(Terminator->getTryBlock());
3148}
3149
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003150CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003151 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00003152 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003153 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003154
Ted Kremenek93668002009-07-17 22:18:43 +00003155 if (!LabelBlock) // This can happen when the body is empty, i.e.
3156 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00003157
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003158 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
3159 "label already in map");
3160 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003161
3162 // Labels partition blocks, so this is the end of the basic block we were
3163 // processing (L is the block's label). Because this is label (and we have
3164 // already processed the substatement) there is no extra control-flow to worry
3165 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00003166 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003167 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003168 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003169
3170 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00003171 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003172
Ted Kremenek9aae5132007-08-23 21:42:29 +00003173 // This block is now the implicit successor of other blocks.
3174 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003175
Ted Kremenek9aae5132007-08-23 21:42:29 +00003176 return LabelBlock;
3177}
3178
Devin Coughlinb6029b72015-11-25 22:35:37 +00003179CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
3180 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3181 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
3182 if (Expr *CopyExpr = CI.getCopyExpr()) {
3183 CFGBlock *Tmp = Visit(CopyExpr);
3184 if (Tmp)
3185 LastBlock = Tmp;
3186 }
3187 }
3188 return LastBlock;
3189}
3190
Ted Kremenekda76a942012-04-12 20:34:52 +00003191CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
3192 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3193 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
3194 et = E->capture_init_end(); it != et; ++it) {
3195 if (Expr *Init = *it) {
3196 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00003197 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00003198 LastBlock = Tmp;
3199 }
3200 }
3201 return LastBlock;
3202}
Fangrui Song6907ce22018-07-30 19:24:48 +00003203
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003204CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003205 // Goto is a control-flow statement. Thus we stop processing the current
3206 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003207
Ted Kremenek9aae5132007-08-23 21:42:29 +00003208 Block = createBlock(false);
3209 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003210
3211 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003212 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003213
Ted Kremenek9aae5132007-08-23 21:42:29 +00003214 if (I == LabelMap.end())
3215 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003216 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3217 else {
3218 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003219 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003220 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003221 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003222
Mike Stump31feda52009-07-17 01:31:16 +00003223 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003224}
3225
Jennifer Yub8fee672019-06-03 15:57:25 +00003226CFGBlock *CFGBuilder::VisitGCCAsmStmt(GCCAsmStmt *G, AddStmtChoice asc) {
3227 // Goto is a control-flow statement. Thus we stop processing the current
3228 // block and create a new one.
3229
3230 if (!G->isAsmGoto())
3231 return VisitStmt(G, asc);
3232
3233 if (Block) {
3234 Succ = Block;
3235 if (badCFG)
3236 return nullptr;
3237 }
3238 Block = createBlock();
3239 Block->setTerminator(G);
3240 // We will backpatch this block later for all the labels.
3241 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3242 // Save "Succ" in BackpatchBlocks. In the backpatch processing, "Succ" is
3243 // used to avoid adding "Succ" again.
3244 BackpatchBlocks.push_back(JumpSource(Succ, ScopePos));
3245 return Block;
3246}
3247
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003248CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003249 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003250
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003251 // Save local scope position because in case of condition variable ScopePos
3252 // won't be restored when traversing AST.
3253 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3254
3255 // Create local scope for init statement and possible condition variable.
3256 // Add destructor for init statement and condition variable.
3257 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003258 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003259 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003260 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3261
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003262 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003263 addLocalScopeForVarDecl(VD);
3264 LocalScope::const_iterator ContinueScopePos = ScopePos;
3265
Matthias Gehre351c2182017-07-12 07:04:19 +00003266 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003267
Peter Szecsi999a25f2017-08-19 11:19:16 +00003268 addLoopExit(F);
3269
Mike Stump014b3ea2009-07-21 01:12:51 +00003270 // "for" is a control-flow statement. Thus we stop processing the current
3271 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003272 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003273 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003274 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003275 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003276 } else
3277 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003278
Ted Kremenek304a9532010-05-21 20:30:15 +00003279 // Save the current value for the break targets.
3280 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003281 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003282 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003283
Craig Topper25542942014-05-20 04:30:07 +00003284 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003285
Ted Kremenek9aae5132007-08-23 21:42:29 +00003286 // Now create the loop body.
3287 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003288 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003289
Ted Kremenekb50e7162012-07-14 05:04:10 +00003290 // Save the current values for Block, Succ, continue and break targets.
3291 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3292 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003293
Ted Kremenekb50e7162012-07-14 05:04:10 +00003294 // Create an empty block to represent the transition block for looping back
3295 // to the head of the loop. If we have increment code, it will
3296 // go in this block as well.
3297 Block = Succ = TransitionBlock = createBlock(false);
3298 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003299
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003300 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003301 // Generate increment code in its own basic block. This is the target of
3302 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003303 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003304 }
Mike Stump31feda52009-07-17 01:31:16 +00003305
Ted Kremenek902393b2009-04-28 00:51:56 +00003306 // Finish up the increment (or empty) block if it hasn't been already.
3307 if (Block) {
3308 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003309 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003310 return nullptr;
3311 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003312 }
Mike Stump31feda52009-07-17 01:31:16 +00003313
Ted Kremenekb50e7162012-07-14 05:04:10 +00003314 // The starting block for the loop increment is the block that should
3315 // represent the 'loop target' for looping back to the start of the loop.
3316 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3317 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003318
Ted Kremenekb50e7162012-07-14 05:04:10 +00003319 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003320 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003321
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003322 // If body is not a compound statement create implicit scope
3323 // and add destructors.
3324 if (!isa<CompoundStmt>(F->getBody()))
3325 addLocalScopeAndDtors(F->getBody());
3326
Mike Stump31feda52009-07-17 01:31:16 +00003327 // Now populate the body block, and in the process create new blocks as we
3328 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003329 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003330
Ted Kremenekb50e7162012-07-14 05:04:10 +00003331 if (!BodyBlock) {
3332 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3333 // Use the continue jump target as the proxy for the body.
3334 BodyBlock = ContinueJumpTarget.block;
3335 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003336 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003337 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003338 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003339
Ted Kremenekb50e7162012-07-14 05:04:10 +00003340 // Because of short-circuit evaluation, the condition of the loop can span
3341 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3342 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003343 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003344
Ted Kremenekb50e7162012-07-14 05:04:10 +00003345 do {
3346 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003347 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003348
3349 // Specially handle logical operators, which have a slightly
3350 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003351 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003352 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003353 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003354 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003355 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3356 break;
3357 }
3358
3359 // The default case when not handling logical operators.
3360 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3361 ExitConditionBlock->setTerminator(F);
3362
3363 // See if this is a known constant.
3364 TryResult KnownVal(true);
3365
3366 if (C) {
3367 // Now add the actual condition to the condition block.
3368 // Because the condition itself may contain control-flow, new blocks may
3369 // be created. Thus we update "Succ" after adding the condition.
3370 Block = ExitConditionBlock;
3371 EntryConditionBlock = addStmt(C);
3372
3373 // If this block contains a condition variable, add both the condition
3374 // variable and initializer to the CFG.
3375 if (VarDecl *VD = F->getConditionVariable()) {
3376 if (Expr *Init = VD->getInit()) {
3377 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003378 const DeclStmt *DS = F->getConditionVariableDeclStmt();
3379 assert(DS->isSingleDecl());
3380 findConstructionContexts(
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00003381 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003382 Init);
3383 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003384 EntryConditionBlock = addStmt(Init);
3385 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003386 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003387 }
3388 }
3389
3390 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003391 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003392
3393 KnownVal = tryEvaluateBool(C);
3394 }
3395
3396 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003397 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003398 // Link up the condition block with the code that follows the loop. (the
3399 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003400 addSuccessor(ExitConditionBlock,
3401 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003402 } while (false);
3403
3404 // Link up the loop-back block to the entry condition block.
3405 addSuccessor(TransitionBlock, EntryConditionBlock);
Fangrui Song6907ce22018-07-30 19:24:48 +00003406
Ted Kremenekb50e7162012-07-14 05:04:10 +00003407 // The condition block is the implicit successor for any code above the loop.
3408 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003409
Ted Kremenek9aae5132007-08-23 21:42:29 +00003410 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003411 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003412 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003413 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3414 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003415 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003416 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003417 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003418
3419 // There is no loop initialization. We are thus basically a while loop.
3420 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003421 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003422 Succ = EntryConditionBlock;
3423 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003424}
3425
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003426CFGBlock *
3427CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3428 AddStmtChoice asc) {
3429 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003430 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003431 MTE->getTemporary());
3432
3433 return VisitStmt(MTE, asc);
3434}
3435
Ted Kremenek5868ec62010-04-11 17:02:10 +00003436CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003437 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003438 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003439 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003440 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003441 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003442}
3443
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003444CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003445 // Objective-C fast enumeration 'for' statements:
3446 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3447 //
3448 // for ( Type newVariable in collection_expression ) { statements }
3449 //
3450 // becomes:
3451 //
3452 // prologue:
3453 // 1. collection_expression
3454 // T. jump to loop_entry
3455 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003456 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003457 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3458 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3459 // TB:
3460 // statements
3461 // T. jump to loop_entry
3462 // FB:
3463 // what comes after
3464 //
3465 // and
3466 //
3467 // Type existingItem;
3468 // for ( existingItem in expression ) { statements }
3469 //
3470 // becomes:
3471 //
Mike Stump31feda52009-07-17 01:31:16 +00003472 // the same with newVariable replaced with existingItem; the binding works
3473 // the same except that for one ObjCForCollectionStmt::getElement() returns
3474 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003475
Craig Topper25542942014-05-20 04:30:07 +00003476 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003477
Ted Kremenek9d56e642008-11-11 17:10:00 +00003478 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003479 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003480 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003481 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003482 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003483 } else
3484 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003485
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003486 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003487 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003488
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003489 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003490 ExitConditionBlock->setTerminator(S);
3491
3492 // The last statement in the block should be the ObjCForCollectionStmt, which
3493 // performs the actual binding to 'element' and determines if there are any
3494 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003495 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003496 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003497
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003498 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003499 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003500 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003501 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3502 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003503 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003504 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003505 return nullptr;
3506 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003507 }
Mike Stump31feda52009-07-17 01:31:16 +00003508
3509 // The condition block is the implicit successor for the loop body as well as
3510 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003511 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003512
Ted Kremenek9d56e642008-11-11 17:10:00 +00003513 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003514 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003515 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003516 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003517 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003518 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003519
Anna Zaks56b49752013-06-22 00:23:20 +00003520 // Add an intermediate block between the BodyBlock and the
3521 // EntryConditionBlock to represent the "loop back" transition, for looping
3522 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003523 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003524 Succ = LoopBackBlock = createBlock();
3525 LoopBackBlock->setLoopTarget(S);
Fangrui Song6907ce22018-07-30 19:24:48 +00003526
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003527 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003528 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003529
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003530 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003531
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003532 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003533 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003534 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003535 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003536 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003537 }
Mike Stump31feda52009-07-17 01:31:16 +00003538
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003539 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003540 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003541 }
Mike Stump31feda52009-07-17 01:31:16 +00003542
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003543 // Link up the condition block with the code that follows the loop.
3544 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003545 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003546
Ted Kremenek9d56e642008-11-11 17:10:00 +00003547 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003548 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003549 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003550}
3551
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003552CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3553 // Inline the body.
3554 return addStmt(S->getSubStmt());
3555 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3556}
3557
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003558CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003559 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003560
Ted Kremenek49805452009-05-02 01:49:13 +00003561 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003562 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003563
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003564 // The sync body starts its own basic block. This makes it a little easier
3565 // for diagnostic clients.
3566 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003567 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003568 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003569
Craig Topper25542942014-05-20 04:30:07 +00003570 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003571 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003572 }
Mike Stump31feda52009-07-17 01:31:16 +00003573
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003574 // Add the @synchronized to the CFG.
3575 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003576 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003577
Ted Kremenek49805452009-05-02 01:49:13 +00003578 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003579 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003580}
Mike Stump31feda52009-07-17 01:31:16 +00003581
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003582CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003583 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003584 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003585}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003586
John McCallfe96e0b2011-11-06 09:01:30 +00003587CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3588 autoCreateBlock();
3589
3590 // Add the PseudoObject as the last thing.
3591 appendStmt(Block, E);
3592
Fangrui Song6907ce22018-07-30 19:24:48 +00003593 CFGBlock *lastBlock = Block;
John McCallfe96e0b2011-11-06 09:01:30 +00003594
3595 // Before that, evaluate all of the semantics in order. In
3596 // CFG-land, that means appending them in reverse order.
3597 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3598 Expr *Semantic = E->getSemanticExpr(--i);
3599
3600 // If the semantic is an opaque value, we're being asked to bind
3601 // it to its source expression.
3602 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3603 Semantic = OVE->getSourceExpr();
3604
3605 if (CFGBlock *B = Visit(Semantic))
3606 lastBlock = B;
3607 }
3608
3609 return lastBlock;
3610}
3611
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003612CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003613 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003614
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003615 // Save local scope position because in case of condition variable ScopePos
3616 // won't be restored when traversing AST.
3617 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3618
3619 // Create local scope for possible condition variable.
3620 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003621 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003622 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003623 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003624 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003625 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003626 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003627
Mike Stump014b3ea2009-07-21 01:12:51 +00003628 // "while" is a control-flow statement. Thus we stop processing the current
3629 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003630 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003631 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003632 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003633 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003634 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003635 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003636 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003637 }
Mike Stump31feda52009-07-17 01:31:16 +00003638
Craig Topper25542942014-05-20 04:30:07 +00003639 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003640
Ted Kremenek9aae5132007-08-23 21:42:29 +00003641 // Process the loop body.
3642 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003643 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003644
Ted Kremenekb50e7162012-07-14 05:04:10 +00003645 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003646 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3647 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003648 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003649
Mike Stump31feda52009-07-17 01:31:16 +00003650 // Create an empty block to represent the transition block for looping back
3651 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003652 Succ = TransitionBlock = createBlock(false);
3653 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003654 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003655
Ted Kremenek9aae5132007-08-23 21:42:29 +00003656 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003657 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003658
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003659 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003660 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003661
3662 // If body is not a compound statement create implicit scope
3663 // and add destructors.
3664 if (!isa<CompoundStmt>(W->getBody()))
3665 addLocalScopeAndDtors(W->getBody());
3666
Ted Kremenek9aae5132007-08-23 21:42:29 +00003667 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003668 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003669
Ted Kremeneke9610502007-08-30 18:39:40 +00003670 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003671 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003672 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003673 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003674 }
3675
3676 // Because of short-circuit evaluation, the condition of the loop can span
3677 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3678 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003679 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003680
3681 do {
3682 Expr *C = W->getCond();
3683
3684 // Specially handle logical operators, which have a slightly
3685 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003686 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003687 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003688 std::tie(EntryConditionBlock, ExitConditionBlock) =
3689 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003690 break;
3691 }
3692
3693 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003694 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003695 ExitConditionBlock->setTerminator(W);
3696
3697 // Now add the actual condition to the condition block.
3698 // Because the condition itself may contain control-flow, new blocks may
3699 // be created. Thus we update "Succ" after adding the condition.
3700 Block = ExitConditionBlock;
3701 Block = EntryConditionBlock = addStmt(C);
3702
3703 // If this block contains a condition variable, add both the condition
3704 // variable and initializer to the CFG.
3705 if (VarDecl *VD = W->getConditionVariable()) {
3706 if (Expr *Init = VD->getInit()) {
3707 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003708 const DeclStmt *DS = W->getConditionVariableDeclStmt();
3709 assert(DS->isSingleDecl());
3710 findConstructionContexts(
3711 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3712 const_cast<DeclStmt *>(DS)),
3713 Init);
3714 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003715 EntryConditionBlock = addStmt(Init);
3716 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003717 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003718 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003719 }
Mike Stump31feda52009-07-17 01:31:16 +00003720
Ted Kremenekb50e7162012-07-14 05:04:10 +00003721 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003722 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003723
3724 // See if this is a known constant.
3725 const TryResult& KnownVal = tryEvaluateBool(C);
3726
Ted Kremenek30754282009-07-24 04:47:11 +00003727 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003728 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003729 // Link up the condition block with the code that follows the loop. (the
3730 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003731 addSuccessor(ExitConditionBlock,
3732 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003733 } while(false);
3734
3735 // Link up the loop-back block to the entry condition block.
3736 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003737
3738 // There can be no more statements in the condition block since we loop back
3739 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003740 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003741
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003742 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003743 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003744 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003745}
Mike Stump11289f42009-09-09 15:08:12 +00003746
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003747CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003748 // FIXME: For now we pretend that @catch and the code it contains does not
3749 // exit.
3750 return Block;
3751}
Mike Stump31feda52009-07-17 01:31:16 +00003752
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003753CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003754 // FIXME: This isn't complete. We basically treat @throw like a return
3755 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003756
Ted Kremenek0868eea2009-09-24 18:45:41 +00003757 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003758 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003759 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003760
Ted Kremenek93041ba2008-12-09 20:20:09 +00003761 // Create the new block.
3762 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003763
Ted Kremenek93041ba2008-12-09 20:20:09 +00003764 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003765 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003766
3767 // Add the statement to the block. This may create new blocks if S contains
3768 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003769 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003770}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003771
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003772CFGBlock *CFGBuilder::VisitObjCMessageExpr(ObjCMessageExpr *ME,
3773 AddStmtChoice asc) {
3774 findConstructionContextsForArguments(ME);
3775
3776 autoCreateBlock();
Artem Dergacheve1f30622018-07-31 19:46:14 +00003777 appendObjCMessage(Block, ME);
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003778
3779 return VisitChildren(ME);
3780}
3781
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003782CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003783 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003784 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003785 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003786
3787 // Create the new block.
3788 Block = createBlock(false);
3789
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003790 if (TryTerminatedBlock)
3791 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003792 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003793 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003794 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003795 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003796
3797 // Add the statement to the block. This may create new blocks if S contains
3798 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003799 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003800}
3801
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003802CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003803 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003804
Peter Szecsi999a25f2017-08-19 11:19:16 +00003805 addLoopExit(D);
3806
Mike Stump8d50b6a2009-07-21 01:27:50 +00003807 // "do...while" is a control-flow statement. Thus we stop processing the
3808 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003809 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003810 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003811 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003812 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003813 } else
3814 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003815
3816 // Because of short-circuit evaluation, the condition of the loop can span
3817 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3818 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003819 CFGBlock *ExitConditionBlock = createBlock(false);
3820 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003821
Ted Kremenek81e14852007-08-27 19:46:09 +00003822 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003823 ExitConditionBlock->setTerminator(D);
3824
3825 // Now add the actual condition to the condition block. Because the condition
3826 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003827 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003828 Block = ExitConditionBlock;
3829 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003830 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003831 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003832 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003833 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003834 }
Mike Stump31feda52009-07-17 01:31:16 +00003835
Ted Kremeneka1523a32008-02-27 07:20:00 +00003836 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003837 Succ = EntryConditionBlock;
3838
Mike Stump773582d2009-07-23 23:25:26 +00003839 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003840 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003841
Ted Kremenek9aae5132007-08-23 21:42:29 +00003842 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003843 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003844 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003845 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003846
Ted Kremenek9aae5132007-08-23 21:42:29 +00003847 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003848 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3849 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3850 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003851
Ted Kremenek9aae5132007-08-23 21:42:29 +00003852 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003853 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003854
Ted Kremenek9aae5132007-08-23 21:42:29 +00003855 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003856 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003857
Ted Kremenek9aae5132007-08-23 21:42:29 +00003858 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003859 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003860
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003861 // If body is not a compound statement create implicit scope
3862 // and add destructors.
3863 if (!isa<CompoundStmt>(D->getBody()))
3864 addLocalScopeAndDtors(D->getBody());
3865
Ted Kremenek9aae5132007-08-23 21:42:29 +00003866 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003867 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003868
Ted Kremeneke9610502007-08-30 18:39:40 +00003869 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003870 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003871 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003872 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003873 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003874 }
Mike Stump31feda52009-07-17 01:31:16 +00003875
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003876 // Add an intermediate block between the BodyBlock and the
3877 // ExitConditionBlock to represent the "loop back" transition. Create an
3878 // empty block to represent the transition block for looping back to the
3879 // head of the loop.
3880 // FIXME: Can we do this more efficiently without adding another block?
3881 Block = nullptr;
3882 Succ = BodyBlock;
3883 CFGBlock *LoopBackBlock = createBlock();
3884 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003885
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003886 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003887 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003888 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003889 else
Craig Topper25542942014-05-20 04:30:07 +00003890 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003891 }
Mike Stump31feda52009-07-17 01:31:16 +00003892
Ted Kremenek30754282009-07-24 04:47:11 +00003893 // Link up the condition block with the code that follows the loop.
3894 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003895 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003896
3897 // There can be no more statements in the body block(s) since we loop back to
3898 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003899 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003900
Ted Kremenek9aae5132007-08-23 21:42:29 +00003901 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003902 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003903 return BodyBlock;
3904}
3905
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003906CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003907 // "continue" is a control-flow statement. Thus we stop processing the
3908 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003909 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003910 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003911
Ted Kremenek9aae5132007-08-23 21:42:29 +00003912 // Now create a new block that ends with the continue statement.
3913 Block = createBlock(false);
3914 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003915
Ted Kremenek9aae5132007-08-23 21:42:29 +00003916 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003917 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003918 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003919 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003920 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003921 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003922 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003923
Ted Kremenek9aae5132007-08-23 21:42:29 +00003924 return Block;
3925}
Mike Stump11289f42009-09-09 15:08:12 +00003926
Peter Collingbournee190dee2011-03-11 19:24:49 +00003927CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3928 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003929 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003930 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003931 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003932 }
Mike Stump11289f42009-09-09 15:08:12 +00003933
Ted Kremenek93668002009-07-17 22:18:43 +00003934 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003935 CFGBlock *lastBlock = Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00003936
Ted Kremenek93668002009-07-17 22:18:43 +00003937 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003938 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003939 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003940 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003941 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003942 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003943}
Mike Stump11289f42009-09-09 15:08:12 +00003944
Ted Kremenek93668002009-07-17 22:18:43 +00003945/// VisitStmtExpr - Utility method to handle (nested) statement
3946/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003947CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003948 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003949 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003950 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003951 }
Artem Dergachevead98ea2019-08-28 18:44:42 +00003952 return VisitCompoundStmt(SE->getSubStmt(), /*ExternallyDestructed=*/true);
Ted Kremenek93668002009-07-17 22:18:43 +00003953}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003954
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003955CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003956 // "switch" is a control-flow statement. Thus we stop processing the current
3957 // block.
Craig Topper25542942014-05-20 04:30:07 +00003958 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003959
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003960 // Save local scope position because in case of condition variable ScopePos
3961 // won't be restored when traversing AST.
3962 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3963
Richard Smitha547eb22016-07-14 00:11:03 +00003964 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003965 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003966 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003967
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003968 // Create local scope for possible condition variable.
3969 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003970 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003971 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003972
Matthias Gehre351c2182017-07-12 07:04:19 +00003973 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003974
Ted Kremenek9aae5132007-08-23 21:42:29 +00003975 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003976 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003977 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003978 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003979 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003980
3981 // Save the current "switch" context.
3982 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003983 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003984 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003985
Mike Stump31feda52009-07-17 01:31:16 +00003986 // Set the "default" case to be the block after the switch statement. If the
3987 // switch statement contains a "default:", this value will be overwritten with
3988 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003989 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003990
Ted Kremenek9aae5132007-08-23 21:42:29 +00003991 // Create a new block that will contain the switch statement.
3992 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003993
Ted Kremenek9aae5132007-08-23 21:42:29 +00003994 // Now process the switch body. The code after the switch is the implicit
3995 // successor.
3996 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003997 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003998
3999 // When visiting the body, the case statements should automatically get linked
4000 // up to the switch. We also don't keep a pointer to the body, since all
4001 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004002 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004003 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00004004
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004005 // For pruning unreachable case statements, save the current state
4006 // for tracking the condition value.
4007 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
4008 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00004009
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004010 // Determine if the switch condition can be explicitly evaluated.
4011 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00004012 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00004013 bool b = tryEvaluate(Terminator->getCond(), result);
4014 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00004015 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00004016
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00004017 // If body is not a compound statement create implicit scope
4018 // and add destructors.
4019 if (!isa<CompoundStmt>(Terminator->getBody()))
4020 addLocalScopeAndDtors(Terminator->getBody());
4021
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004022 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00004023 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004024 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004025 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00004026 }
Ted Kremenek81e14852007-08-27 19:46:09 +00004027
Mike Stump31feda52009-07-17 01:31:16 +00004028 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00004029 // following the switch body. Moreover, take into account if all the
4030 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00004031 //
4032 // Note: We add a successor to a switch that is considered covered yet has no
4033 // case statements if the enumeration has no enumerators.
4034 bool SwitchAlwaysHasSuccessor = false;
4035 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
4036 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
4037 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004038 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
4039 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00004040
Ted Kremenek81e14852007-08-27 19:46:09 +00004041 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004042 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004043 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004044 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00004045
Richard Smitha547eb22016-07-14 00:11:03 +00004046 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00004047 // SwitchStmt and the condition variable initialization to the CFG.
4048 if (VarDecl *VD = Terminator->getConditionVariable()) {
4049 if (Expr *Init = VD->getInit()) {
4050 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00004051 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004052 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004053 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00004054 }
4055 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00004056
Richard Smitha547eb22016-07-14 00:11:03 +00004057 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
4058 if (Stmt *Init = Terminator->getInit()) {
4059 autoCreateBlock();
4060 LastBlock = addStmt(Init);
4061 }
4062
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004063 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00004064}
Fangrui Song6907ce22018-07-30 19:24:48 +00004065
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004066static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00004067 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004068 const CaseStmt *CS,
4069 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00004070 if (!switchCond)
4071 return true;
4072
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004073 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00004074
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004075 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00004076 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004077 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00004078 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00004079 const llvm::APSInt &condInt = switchCond->Val.getInt();
Fangrui Song6907ce22018-07-30 19:24:48 +00004080
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004081 if (condInt == lhsInt) {
4082 addCase = true;
4083 switchExclusivelyCovered = true;
4084 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00004085 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004086 if (const Expr *RHS = CS->getRHS()) {
4087 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00004088 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00004089 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004090 addCase = true;
4091 switchExclusivelyCovered = true;
4092 }
4093 }
4094 }
4095 }
4096 else
4097 addCase = true;
4098 }
Fangrui Song6907ce22018-07-30 19:24:48 +00004099 return addCase;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004100}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004101
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004102CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00004103 // CaseStmts are essentially labels, so they are the first statement in a
4104 // block.
Craig Topper25542942014-05-20 04:30:07 +00004105 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00004106
Ted Kremenek60fa6572010-08-04 23:54:30 +00004107 if (Stmt *Sub = CS->getSubStmt()) {
4108 // For deeply nested chains of CaseStmts, instead of doing a recursion
4109 // (which can blow out the stack), manually unroll and create blocks
4110 // along the way.
4111 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004112 CFGBlock *currentBlock = createBlock(false);
4113 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00004114
Ted Kremenek60fa6572010-08-04 23:54:30 +00004115 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004116 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004117 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004118 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00004119
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004120 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00004121 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004122 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00004123 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004124
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004125 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00004126 CS = cast<CaseStmt>(Sub);
4127 Sub = CS->getSubStmt();
4128 }
4129
4130 addStmt(Sub);
4131 }
Mike Stump11289f42009-09-09 15:08:12 +00004132
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004133 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004134 if (!CaseBlock)
4135 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004136
4137 // Cases statements partition blocks, so this is the top of the basic block we
4138 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00004139 CaseBlock->setLabel(CS);
4140
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004141 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004142 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004143
4144 // Add this block to the list of successors for the block with the switch
4145 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00004146 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004147 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00004148 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004149 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00004150
Ted Kremenek9aae5132007-08-23 21:42:29 +00004151 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004152 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004153
Ted Kremenek60fa6572010-08-04 23:54:30 +00004154 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004155 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004156 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004157 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00004158 // This block is now the implicit successor of other blocks.
4159 Succ = CaseBlock;
4160 }
Mike Stump31feda52009-07-17 01:31:16 +00004161
Ted Kremenek60fa6572010-08-04 23:54:30 +00004162 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00004163}
Mike Stump31feda52009-07-17 01:31:16 +00004164
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004165CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00004166 if (Terminator->getSubStmt())
4167 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00004168
Ted Kremenek654c78f2008-02-13 22:05:39 +00004169 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004170
4171 if (!DefaultCaseBlock)
4172 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004173
4174 // Default statements partition blocks, so this is the top of the basic block
4175 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004176 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00004177
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004178 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004179 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00004180
Mike Stump31feda52009-07-17 01:31:16 +00004181 // Unlike case statements, we don't add the default block to the successors
4182 // for the switch statement immediately. This is done when we finish
4183 // processing the switch statement. This allows for the default case
4184 // (including a fall-through to the code after the switch statement) to always
4185 // be the last successor of a switch-terminated block.
4186
Ted Kremenek654c78f2008-02-13 22:05:39 +00004187 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004188 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004189
Ted Kremenek654c78f2008-02-13 22:05:39 +00004190 // This block is now the implicit successor of other blocks.
4191 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00004192
4193 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00004194}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004195
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004196CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
4197 // "try"/"catch" is a control-flow statement. Thus we stop processing the
4198 // current block.
Craig Topper25542942014-05-20 04:30:07 +00004199 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004200
4201 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004202 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004203 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004204 TrySuccessor = Block;
4205 } else TrySuccessor = Succ;
4206
Mike Stump0bdba6c2010-01-20 01:15:34 +00004207 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004208
4209 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00004210 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004211 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00004212 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004213
Mike Stump0bdba6c2010-01-20 01:15:34 +00004214 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004215 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
4216 // The code after the try is the implicit successor.
4217 Succ = TrySuccessor;
4218 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00004219 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00004220 HasCatchAll = true;
4221 }
Craig Topper25542942014-05-20 04:30:07 +00004222 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004223 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00004224 if (!CatchBlock)
4225 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004226 // Add this block to the list of successors for the block with the try
4227 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004228 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004229 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00004230 if (!HasCatchAll) {
4231 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004232 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00004233 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004234 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00004235 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004236
4237 // The code after the try is the implicit successor.
4238 Succ = TrySuccessor;
4239
Mike Stump845384a2010-01-20 01:30:58 +00004240 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00004241 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
4242 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00004243
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004244 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004245 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004246 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004247}
4248
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004249CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004250 // CXXCatchStmt are treated like labels, so they are the first statement in a
4251 // block.
4252
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004253 // Save local scope position because in case of exception variable ScopePos
4254 // won't be restored when traversing AST.
4255 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4256
4257 // Create local scope for possible exception variable.
4258 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004259 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004260 LocalScope::const_iterator BeginScopePos = ScopePos;
4261 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004262 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004263 }
4264
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004265 if (CS->getHandlerBlock())
4266 addStmt(CS->getHandlerBlock());
4267
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004268 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004269 if (!CatchBlock)
4270 CatchBlock = createBlock();
Fangrui Song6907ce22018-07-30 19:24:48 +00004271
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004272 // CXXCatchStmt is more than just a label. They have semantic meaning
4273 // as well, as they implicitly "initialize" the catch variable. Add
4274 // it to the CFG as a CFGElement so that the control-flow of these
4275 // semantics gets captured.
4276 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004277
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004278 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4279 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004280 CatchBlock->setLabel(CS);
4281
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004282 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004283 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004284 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004285
4286 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004287 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004288
4289 return CatchBlock;
4290}
4291
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004292CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004293 // C++0x for-range statements are specified as [stmt.ranged]:
4294 //
4295 // {
4296 // auto && __range = range-init;
4297 // for ( auto __begin = begin-expr,
4298 // __end = end-expr;
4299 // __begin != __end;
4300 // ++__begin ) {
4301 // for-range-declaration = *__begin;
4302 // statement
4303 // }
4304 // }
4305
4306 // Save local scope position before the addition of the implicit variables.
4307 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4308
4309 // Create local scopes and destructors for range, begin and end variables.
4310 if (Stmt *Range = S->getRangeStmt())
4311 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004312 if (Stmt *Begin = S->getBeginStmt())
4313 addLocalScopeForStmt(Begin);
4314 if (Stmt *End = S->getEndStmt())
4315 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004316 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004317
4318 LocalScope::const_iterator ContinueScopePos = ScopePos;
4319
4320 // "for" is a control-flow statement. Thus we stop processing the current
4321 // block.
Craig Topper25542942014-05-20 04:30:07 +00004322 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004323 if (Block) {
4324 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004325 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004326 LoopSuccessor = Block;
4327 } else
4328 LoopSuccessor = Succ;
4329
4330 // Save the current value for the break targets.
4331 // All breaks should go to the code following the loop.
4332 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4333 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4334
4335 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004336 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004337 ConditionBlock->setTerminator(S);
4338
4339 // Now add the actual condition to the condition block.
4340 if (Expr *C = S->getCond()) {
4341 Block = ConditionBlock;
4342 CFGBlock *BeginConditionBlock = addStmt(C);
4343 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004344 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004345 assert(BeginConditionBlock == ConditionBlock &&
4346 "condition block in for-range was unexpectedly complex");
4347 (void)BeginConditionBlock;
4348 }
4349
4350 // The condition block is the implicit successor for the loop body as well as
4351 // any code above the loop.
4352 Succ = ConditionBlock;
4353
4354 // See if this is a known constant.
4355 TryResult KnownVal(true);
4356
4357 if (S->getCond())
4358 KnownVal = tryEvaluateBool(S->getCond());
4359
4360 // Now create the loop body.
4361 {
4362 assert(S->getBody());
4363
4364 // Save the current values for Block, Succ, and continue targets.
4365 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4366 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4367
4368 // Generate increment code in its own basic block. This is the target of
4369 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004370 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004371 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004372 if (badCFG)
4373 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004374 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4375
4376 // The starting block for the loop increment is the block that should
4377 // represent the 'loop target' for looping back to the start of the loop.
4378 ContinueJumpTarget.block->setLoopTarget(S);
4379
4380 // Finish up the increment block and prepare to start the loop body.
4381 assert(Block);
4382 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004383 return nullptr;
4384 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004385
4386 // Add implicit scope and dtors for loop variable.
4387 addLocalScopeAndDtors(S->getLoopVarStmt());
4388
4389 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004390 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004391 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004392 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004393 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004394 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004395 return nullptr;
4396
Richard Smith02e85f32011-04-14 22:09:26 +00004397 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004398 addSuccessor(ConditionBlock,
4399 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004400 }
4401
4402 // Link up the condition block with the code that follows the loop (the
4403 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004404 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004405
4406 // Add the initialization statements.
4407 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004408 addStmt(S->getBeginStmt());
4409 addStmt(S->getEndStmt());
Richard Smith8baa5002018-09-28 18:44:09 +00004410 CFGBlock *Head = addStmt(S->getRangeStmt());
4411 if (S->getInit())
4412 Head = addStmt(S->getInit());
4413 return Head;
Richard Smith02e85f32011-04-14 22:09:26 +00004414}
4415
John McCall5d413782010-12-06 08:20:24 +00004416CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Artem Dergachevead98ea2019-08-28 18:44:42 +00004417 AddStmtChoice asc, bool ExternallyDestructed) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004418 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004419 // If adding implicit destructors visit the full expression for adding
4420 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004421 TempDtorContext Context;
Artem Dergachevead98ea2019-08-28 18:44:42 +00004422 VisitForTemporaryDtors(E->getSubExpr(), ExternallyDestructed, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004423
4424 // Full expression has to be added as CFGStmt so it will be sequenced
4425 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004426 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004427 }
4428 return Visit(E->getSubExpr(), asc);
4429}
4430
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004431CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4432 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004433 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004434 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004435 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004436
Artem Dergachev783a4572018-02-23 22:20:39 +00004437 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004438 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004439 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004440
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004441 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004442 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004443 }
4444 return Visit(E->getSubExpr(), asc);
4445}
4446
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004447CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4448 AddStmtChoice asc) {
Artem Dergachevbd880fe2018-07-31 19:39:37 +00004449 // If the constructor takes objects as arguments by value, we need to properly
4450 // construct these objects. Construction contexts we find here aren't for the
4451 // constructor C, they're for its arguments only.
4452 findConstructionContextsForArguments(C);
4453
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004454 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004455 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004456
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004457 return VisitChildren(C);
4458}
4459
Jordan Rosec9176072014-01-13 17:59:19 +00004460CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4461 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004462 autoCreateBlock();
4463 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004464
Artem Dergachev783a4572018-02-23 22:20:39 +00004465 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004466 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004467 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004468
Jordan Rosec9176072014-01-13 17:59:19 +00004469 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004470 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004471
Jordan Rosec9176072014-01-13 17:59:19 +00004472 if (BuildOpts.AddCXXNewAllocator)
4473 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004474
Richard Smithb9fb1212019-05-06 03:47:15 +00004475 if (NE->isArray() && *NE->getArraySize())
4476 Block = Visit(*NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004477
Jordan Rosec9176072014-01-13 17:59:19 +00004478 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4479 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004480 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004481
Jordan Rosec9176072014-01-13 17:59:19 +00004482 return Block;
4483}
Jordan Rosed2f40792013-09-03 17:00:57 +00004484
4485CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4486 AddStmtChoice asc) {
4487 autoCreateBlock();
4488 appendStmt(Block, DE);
4489 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004490 if (!DTy.isNull()) {
4491 DTy = DTy.getNonReferenceType();
4492 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4493 if (RD) {
4494 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4495 appendDeleteDtor(Block, RD, DE);
4496 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004497 }
4498
4499 return VisitChildren(DE);
4500}
4501
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004502CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4503 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004504 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004505 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004506 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004507 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004508 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004509 }
4510 return Visit(E->getSubExpr(), asc);
4511}
4512
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004513CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4514 AddStmtChoice asc) {
Artem Dergachevc531d542018-08-14 21:10:46 +00004515 // If the constructor takes objects as arguments by value, we need to properly
4516 // construct these objects. Construction contexts we find here aren't for the
4517 // constructor C, they're for its arguments only.
4518 findConstructionContextsForArguments(C);
4519
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004520 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004521 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004522 return VisitChildren(C);
4523}
4524
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004525CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4526 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004527 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004528 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004529 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004530 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004531 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004532}
4533
Bill Wendling8003edc2018-11-09 00:41:36 +00004534CFGBlock *CFGBuilder::VisitConstantExpr(ConstantExpr *E, AddStmtChoice asc) {
4535 return Visit(E->getSubExpr(), AddStmtChoice());
4536}
4537
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004538CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004539 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004540 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004541
Ted Kremenekeda180e22007-08-28 19:26:49 +00004542 if (!IBlock) {
4543 IBlock = createBlock(false);
4544 cfg->setIndirectGotoBlock(IBlock);
4545 }
Mike Stump31feda52009-07-17 01:31:16 +00004546
Ted Kremenekeda180e22007-08-28 19:26:49 +00004547 // IndirectGoto is a control-flow statement. Thus we stop processing the
4548 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004549 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004550 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004551
Ted Kremenekeda180e22007-08-28 19:26:49 +00004552 Block = createBlock(false);
4553 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004554 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004555 return addStmt(I->getTarget());
4556}
4557
Artem Dergachevead98ea2019-08-28 18:44:42 +00004558CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +00004559 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004560 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4561
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004562tryAgain:
4563 if (!E) {
4564 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004565 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004566 }
4567 switch (E->getStmtClass()) {
4568 default:
Artem Dergachevead98ea2019-08-28 18:44:42 +00004569 return VisitChildrenForTemporaryDtors(E, false, Context);
4570
4571 case Stmt::InitListExprClass:
4572 return VisitChildrenForTemporaryDtors(E, ExternallyDestructed, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004573
4574 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004575 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
Artem Dergachevead98ea2019-08-28 18:44:42 +00004576 ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +00004577 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004578
4579 case Stmt::CXXBindTemporaryExprClass:
4580 return VisitCXXBindTemporaryExprForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004581 cast<CXXBindTemporaryExpr>(E), ExternallyDestructed, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004582
John McCallc07a0c72011-02-17 10:25:35 +00004583 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004584 case Stmt::ConditionalOperatorClass:
4585 return VisitConditionalOperatorForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004586 cast<AbstractConditionalOperator>(E), ExternallyDestructed, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004587
4588 case Stmt::ImplicitCastExprClass:
Artem Dergachevead98ea2019-08-28 18:44:42 +00004589 // For implicit cast we want ExternallyDestructed to be passed further.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004590 E = cast<CastExpr>(E)->getSubExpr();
4591 goto tryAgain;
4592
Manuel Klimekb0042c42014-07-30 08:34:42 +00004593 case Stmt::CXXFunctionalCastExprClass:
Artem Dergachevead98ea2019-08-28 18:44:42 +00004594 // For functional cast we want ExternallyDestructed to be passed further.
Manuel Klimekb0042c42014-07-30 08:34:42 +00004595 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4596 goto tryAgain;
4597
Bill Wendling8003edc2018-11-09 00:41:36 +00004598 case Stmt::ConstantExprClass:
4599 E = cast<ConstantExpr>(E)->getSubExpr();
4600 goto tryAgain;
4601
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004602 case Stmt::ParenExprClass:
4603 E = cast<ParenExpr>(E)->getSubExpr();
4604 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004605
Manuel Klimekb0042c42014-07-30 08:34:42 +00004606 case Stmt::MaterializeTemporaryExprClass: {
4607 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
Artem Dergachevead98ea2019-08-28 18:44:42 +00004608 ExternallyDestructed = (MTE->getStorageDuration() != SD_FullExpression);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004609 SmallVector<const Expr *, 2> CommaLHSs;
4610 SmallVector<SubobjectAdjustment, 2> Adjustments;
4611 // Find the expression whose lifetime needs to be extended.
4612 E = const_cast<Expr *>(
4613 cast<MaterializeTemporaryExpr>(E)
4614 ->GetTemporaryExpr()
4615 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4616 // Visit the skipped comma operator left-hand sides for other temporaries.
4617 for (const Expr *CommaLHS : CommaLHSs) {
4618 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Artem Dergachevead98ea2019-08-28 18:44:42 +00004619 /*ExternallyDestructed=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004620 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004621 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004622 }
Richard Smith4137af22014-07-27 05:12:49 +00004623
4624 case Stmt::BlockExprClass:
4625 // Don't recurse into blocks; their subexpressions don't get evaluated
4626 // here.
4627 return Block;
4628
4629 case Stmt::LambdaExprClass: {
4630 // For lambda expressions, only recurse into the capture initializers,
4631 // and not the body.
4632 auto *LE = cast<LambdaExpr>(E);
4633 CFGBlock *B = Block;
4634 for (Expr *Init : LE->capture_inits()) {
Richard Smith7ed5fb22018-07-27 17:13:18 +00004635 if (Init) {
4636 if (CFGBlock *R = VisitForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004637 Init, /*ExternallyDestructed=*/true, Context))
Richard Smith7ed5fb22018-07-27 17:13:18 +00004638 B = R;
4639 }
Richard Smith4137af22014-07-27 05:12:49 +00004640 }
4641 return B;
4642 }
4643
Artem Dergachevead98ea2019-08-28 18:44:42 +00004644 case Stmt::StmtExprClass:
4645 // Don't recurse into statement expressions; any cleanups inside them
4646 // will be wrapped in their own ExprWithCleanups.
4647 return Block;
4648
Richard Smith4137af22014-07-27 05:12:49 +00004649 case Stmt::CXXDefaultArgExprClass:
4650 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4651 goto tryAgain;
4652
4653 case Stmt::CXXDefaultInitExprClass:
4654 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4655 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004656 }
4657}
4658
Manuel Klimekb5616c92014-08-07 10:42:17 +00004659CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
Artem Dergachevead98ea2019-08-28 18:44:42 +00004660 bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +00004661 TempDtorContext &Context) {
4662 if (isa<LambdaExpr>(E)) {
4663 // Do not visit the children of lambdas; they have their own CFGs.
4664 return Block;
4665 }
4666
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004667 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004668 // order that they will appear in the CFG. Because the CFG is built
4669 // bottom-up, this means we visit them in their natural order, which
4670 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004671 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004672 for (Stmt *Child : E->children())
4673 if (Child)
Artem Dergachevead98ea2019-08-28 18:44:42 +00004674 if (CFGBlock *R = VisitForTemporaryDtors(Child, ExternallyDestructed, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004675 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004676
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004677 return B;
4678}
4679
Manuel Klimekb5616c92014-08-07 10:42:17 +00004680CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004681 BinaryOperator *E, bool ExternallyDestructed, TempDtorContext &Context) {
4682 if (E->isCommaOp()) {
4683 // For comma operator LHS expression is visited
4684 // before RHS expression. For destructors visit them in reverse order.
4685 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), ExternallyDestructed, Context);
4686 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4687 return LHSBlock ? LHSBlock : RHSBlock;
4688 }
4689
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004690 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004691 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004692 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4693 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4694 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004695
Manuel Klimekedf925b92014-08-07 18:44:19 +00004696 // We do not know at CFG-construction time whether the right-hand-side was
4697 // executed, thus we add a branch node that depends on the temporary
4698 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004699 TempDtorContext RHSContext(
4700 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004701 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004702 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004703
Manuel Klimekb5616c92014-08-07 10:42:17 +00004704 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004705 }
4706
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004707 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004708 // For assignment operator (=) LHS expression is visited
4709 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004710 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4711 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004712 return LHSBlock ? LHSBlock : RHSBlock;
4713 }
4714
4715 // For any other binary operator RHS expression is visited before
4716 // LHS expression (order of children). For destructors visit them in reverse
4717 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004718 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4719 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004720 return RHSBlock ? RHSBlock : LHSBlock;
4721}
4722
4723CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004724 CXXBindTemporaryExpr *E, bool ExternallyDestructed, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004725 // First add destructors for temporaries in subexpression.
Artem Dergachevead98ea2019-08-28 18:44:42 +00004726 // Because VisitCXXBindTemporaryExpr calls setDestructed:
4727 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), true, Context);
4728 if (!ExternallyDestructed) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004729 // If lifetime of temporary is not prolonged (by assigning to constant
4730 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004731
Chandler Carruthad747252011-09-13 06:09:01 +00004732 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004733
Richard Trieu95a192a2015-05-28 00:14:02 +00004734 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004735 // If the destructor is marked as a no-return destructor, we need to
4736 // create a new block for the destructor which does not have as a
4737 // successor anything built thus far. Control won't flow out of this
4738 // block.
4739 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004740 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004741 } else if (Context.needsTempDtorBranch()) {
4742 // If we need to introduce a branch, we add a new block that we will hook
4743 // up to a decision block later.
4744 if (B) Succ = B;
4745 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004746 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004747 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004748 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004749 if (Context.needsTempDtorBranch()) {
4750 Context.setDecisionPoint(Succ, E);
4751 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004752 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004753
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004754 B = Block;
4755 }
4756 return B;
4757}
4758
Manuel Klimekb5616c92014-08-07 10:42:17 +00004759void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4760 CFGBlock *FalseSucc) {
4761 if (!Context.TerminatorExpr) {
4762 // If no temporary was found, we do not need to insert a decision point.
4763 return;
4764 }
4765 assert(Context.TerminatorExpr);
4766 CFGBlock *Decision = createBlock(false);
Artem Dergachev4e530322019-05-24 01:34:22 +00004767 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr,
4768 CFGTerminator::TemporaryDtorsBranch));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004769 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004770 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004771 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004772 Block = Decision;
4773}
4774
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004775CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004776 AbstractConditionalOperator *E, bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +00004777 TempDtorContext &Context) {
4778 VisitForTemporaryDtors(E->getCond(), false, Context);
4779 CFGBlock *ConditionBlock = Block;
4780 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004781 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004782 TryResult NegatedVal = ConditionVal;
4783 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004784
Manuel Klimekdeb02622014-08-08 07:37:13 +00004785 TempDtorContext TrueContext(
4786 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Artem Dergachevead98ea2019-08-28 18:44:42 +00004787 VisitForTemporaryDtors(E->getTrueExpr(), ExternallyDestructed, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004788 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004789
Manuel Klimekb5616c92014-08-07 10:42:17 +00004790 Block = ConditionBlock;
4791 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004792 TempDtorContext FalseContext(
4793 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Artem Dergachevead98ea2019-08-28 18:44:42 +00004794 VisitForTemporaryDtors(E->getFalseExpr(), ExternallyDestructed, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004795
Manuel Klimekb5616c92014-08-07 10:42:17 +00004796 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004797 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004798 } else if (TrueContext.TerminatorExpr) {
4799 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004800 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004801 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004802 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004803 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004804 return Block;
4805}
4806
Alexey Bataevc2c21ef2019-07-11 14:54:17 +00004807CFGBlock *CFGBuilder::VisitOMPExecutableDirective(OMPExecutableDirective *D,
4808 AddStmtChoice asc) {
4809 if (asc.alwaysAdd(*this, D)) {
4810 autoCreateBlock();
4811 appendStmt(Block, D);
4812 }
4813
4814 // Iterate over all used expression in clauses.
4815 CFGBlock *B = Block;
4816
4817 // Reverse the elements to process them in natural order. Iterators are not
4818 // bidirectional, so we need to create temp vector.
Alexey Bataev655cb4a2019-07-16 14:51:46 +00004819 SmallVector<Stmt *, 8> Used(
4820 OMPExecutableDirective::used_clauses_children(D->clauses()));
4821 for (Stmt *S : llvm::reverse(Used)) {
Alexey Bataevc2c21ef2019-07-11 14:54:17 +00004822 assert(S && "Expected non-null used-in-clause child.");
4823 if (CFGBlock *R = Visit(S))
4824 B = R;
4825 }
4826 // Visit associated structured block if any.
4827 if (!D->isStandaloneDirective())
4828 if (Stmt *S = D->getStructuredBlock()) {
4829 if (!isa<CompoundStmt>(S))
4830 addLocalScopeAndDtors(S);
4831 if (CFGBlock *R = addStmt(S))
4832 B = R;
4833 }
4834
4835 return B;
4836}
4837
Mike Stump31feda52009-07-17 01:31:16 +00004838/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4839/// no successors or predecessors. If this is the first block created in the
4840/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004841CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004842 bool first_block = begin() == end();
4843
4844 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004845 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004846 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004847 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004848
4849 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004850 if (first_block)
4851 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004852
4853 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004854 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004855}
4856
David Blaikiee90195c2014-08-29 18:53:26 +00004857/// buildCFG - Constructs a CFG from an AST.
4858std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4859 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004860 CFGBuilder Builder(C, BO);
4861 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004862}
4863
Artem Dergachevab7747b2019-04-30 03:01:02 +00004864bool CFG::isLinear() const {
4865 // Quick path: if we only have the ENTRY block, the EXIT block, and some code
4866 // in between, then we have no room for control flow.
4867 if (size() <= 3)
4868 return true;
4869
4870 // Traverse the CFG until we find a branch.
4871 // TODO: While this should still be very fast,
4872 // maybe we should cache the answer.
4873 llvm::SmallPtrSet<const CFGBlock *, 4> Visited;
4874 const CFGBlock *B = Entry;
4875 while (B != Exit) {
4876 auto IteratorAndFlag = Visited.insert(B);
4877 if (!IteratorAndFlag.second) {
4878 // We looped back to a block that we've already visited. Not linear.
4879 return false;
4880 }
4881
4882 // Iterate over reachable successors.
4883 const CFGBlock *FirstReachableB = nullptr;
4884 for (const CFGBlock::AdjacentBlock &AB : B->succs()) {
4885 if (!AB.isReachable())
4886 continue;
4887
4888 if (FirstReachableB == nullptr) {
4889 FirstReachableB = &*AB;
4890 } else {
4891 // We've encountered a branch. It's not a linear CFG.
4892 return false;
4893 }
4894 }
4895
4896 if (!FirstReachableB) {
4897 // We reached a dead end. EXIT is unreachable. This is linear enough.
4898 return true;
4899 }
4900
4901 // There's only one way to move forward. Proceed.
4902 B = FirstReachableB;
4903 }
4904
4905 // We reached EXIT and found no branches.
4906 return true;
4907}
4908
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004909const CXXDestructorDecl *
4910CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004911 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004912 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004913 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004914 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004915 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004916 case CFGElement::Statement:
4917 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004918 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004919 case CFGElement::ScopeBegin:
4920 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004921 llvm_unreachable("getDestructorDecl should only be used with "
4922 "ImplicitDtors");
4923 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004924 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004925 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004926
4927 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4928 //
4929 // Lifetime-extending constructs are handled here. This works for a single
4930 // temporary in an initializer expression.
4931 if (ty->isReferenceType()) {
4932 if (const Expr *Init = var->getInit()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00004933 ty = getReferenceInitTemporaryType(Init);
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004934 }
4935 }
4936
Ted Kremeneke7d78882012-03-19 23:48:41 +00004937 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004938 ty = arrayType->getElementType();
4939 }
Artem Dergachev3517d102019-08-28 21:19:58 +00004940
4941 // The situation when the type of the lifetime-extending reference
4942 // does not correspond to the type of the object is supposed
4943 // to be handled by now. In particular, 'ty' is now the unwrapped
4944 // record type.
4945 const CXXRecordDecl *classDecl = ty->getAsCXXRecordDecl();
4946 assert(classDecl);
Fangrui Song6907ce22018-07-30 19:24:48 +00004947 return classDecl->getDestructor();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004948 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004949 case CFGElement::DeleteDtor: {
4950 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4951 QualType DTy = DE->getDestroyedType();
4952 DTy = DTy.getNonReferenceType();
4953 const CXXRecordDecl *classDecl =
4954 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4955 return classDecl->getDestructor();
4956 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004957 case CFGElement::TemporaryDtor: {
4958 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004959 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004960 const CXXTemporary *temp = bindExpr->getTemporary();
4961 return temp->getDestructor();
4962 }
4963 case CFGElement::BaseDtor:
4964 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004965 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004966 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004967 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004968 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004969}
4970
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004971//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004972// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004973//===----------------------------------------------------------------------===//
4974
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004975CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004976 : ReachableBlock(IsReachable ? B : nullptr),
4977 UnreachableBlock(!IsReachable ? B : nullptr,
4978 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004979
4980CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004981 : ReachableBlock(B),
4982 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4983 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004984
4985void CFGBlock::addSuccessor(AdjacentBlock Succ,
4986 BumpVectorContext &C) {
4987 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004988 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004989
4990 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004991 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004992
4993 Succs.push_back(Succ, C);
4994}
4995
Ted Kremenekb0371852010-09-09 00:06:04 +00004996bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004997 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004998 if (F.IgnoreNullPredecessors && !From)
4999 return true;
5000
5001 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00005002 // If the 'To' has no label or is labeled but the label isn't a
5003 // CaseStmt then filter this edge.
5004 if (const SwitchStmt *S =
Artem Dergachev4e530322019-05-24 01:34:22 +00005005 dyn_cast_or_null<SwitchStmt>(From->getTerminatorStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00005006 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00005007 const Stmt *L = To->getLabel();
5008 if (!L || !isa<CaseStmt>(L))
5009 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00005010 }
5011 }
5012 }
5013
5014 return false;
5015}
5016
5017//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005018// CFG pretty printing
5019//===----------------------------------------------------------------------===//
5020
Ted Kremenek7e776b12007-08-22 18:22:34 +00005021namespace {
5022
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00005023class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005024 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
5025 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
5026
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005027 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005028 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00005029 signed currentBlock = 0;
5030 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00005031 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005032
Eugene Zelenko38c70522017-12-07 21:55:09 +00005033public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00005034 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00005035 : LangOpts(LO) {
Kristof Umannf1746702019-09-12 19:52:34 +00005036 if (!cfg)
5037 return;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005038 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
5039 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005040 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Fangrui Song6907ce22018-07-30 19:24:48 +00005041 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00005042 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
5043 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005044 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00005045 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005046
Ted Kremenek96a7a592011-03-01 03:15:10 +00005047 switch (stmt->getStmtClass()) {
5048 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00005049 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
5050 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00005051 case Stmt::IfStmtClass: {
5052 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
5053 if (var)
5054 DeclMap[var] = P;
5055 break;
5056 }
5057 case Stmt::ForStmtClass: {
5058 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
5059 if (var)
5060 DeclMap[var] = P;
5061 break;
5062 }
5063 case Stmt::WhileStmtClass: {
5064 const VarDecl *var =
5065 cast<WhileStmt>(stmt)->getConditionVariable();
5066 if (var)
5067 DeclMap[var] = P;
5068 break;
5069 }
5070 case Stmt::SwitchStmtClass: {
5071 const VarDecl *var =
5072 cast<SwitchStmt>(stmt)->getConditionVariable();
5073 if (var)
5074 DeclMap[var] = P;
5075 break;
5076 }
5077 case Stmt::CXXCatchStmtClass: {
5078 const VarDecl *var =
5079 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
5080 if (var)
5081 DeclMap[var] = P;
5082 break;
5083 }
5084 default:
5085 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005086 }
5087 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005088 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00005089 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005090 }
Mike Stump31feda52009-07-17 01:31:16 +00005091
Eugene Zelenko38c70522017-12-07 21:55:09 +00005092 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00005093
Chris Lattnerc61089a2009-06-30 01:26:17 +00005094 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00005095 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00005096 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00005097
Craig Topperb45acb82014-03-14 06:02:07 +00005098 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005099 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005100
5101 if (I == StmtMap.end())
5102 return false;
Mike Stump31feda52009-07-17 01:31:16 +00005103
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00005104 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00005105 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005106 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00005107 }
Mike Stump31feda52009-07-17 01:31:16 +00005108
Ted Kremenek60983dc2010-01-19 20:52:05 +00005109 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005110 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005111 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005112
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005113 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005114 DeclMapTy::iterator I = DeclMap.find(D);
5115
5116 if (I == DeclMap.end())
5117 return false;
5118
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00005119 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00005120 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005121 return false;
5122 }
5123
5124 OS << "[B" << I->second.first << "." << I->second.second << "]";
5125 return true;
5126 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005127};
5128
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00005129class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00005130 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005131 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005132 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00005133 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00005134
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005135public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005136 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00005137 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00005138 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00005139 this->Policy.IncludeNewlines = false;
5140 }
Mike Stump31feda52009-07-17 01:31:16 +00005141
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005142 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005143 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005144 if (Stmt *C = I->getCond())
5145 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00005146 }
Mike Stump31feda52009-07-17 01:31:16 +00005147
Ted Kremenek9aae5132007-08-23 21:42:29 +00005148 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005149 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00005150 Terminator->printPretty(OS, Helper, Policy);
5151 }
5152
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00005153 void VisitDeclStmt(DeclStmt *DS) {
5154 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
5155 OS << "static init " << VD->getName();
5156 }
5157
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005158 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005159 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00005160 if (F->getInit())
5161 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00005162 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005163 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005164 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00005165 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00005166 if (F->getInc())
5167 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00005168 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00005169 }
Mike Stump31feda52009-07-17 01:31:16 +00005170
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005171 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005172 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005173 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005174 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00005175 }
Mike Stump31feda52009-07-17 01:31:16 +00005176
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005177 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005178 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005179 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005180 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00005181 }
Mike Stump31feda52009-07-17 01:31:16 +00005182
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005183 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00005184 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00005185 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00005186 }
Mike Stump31feda52009-07-17 01:31:16 +00005187
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005188 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005189 OS << "try ...";
5190 }
5191
Nico Weber699670e2017-08-23 15:33:16 +00005192 void VisitSEHTryStmt(SEHTryStmt *CS) {
5193 OS << "__try ...";
5194 }
5195
John McCallc07a0c72011-02-17 10:25:35 +00005196 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00005197 if (Stmt *Cond = C->getCond())
5198 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005199 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005200 }
Mike Stump31feda52009-07-17 01:31:16 +00005201
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005202 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00005203 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005204 if (Stmt *Cond = C->getCond())
5205 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00005206 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00005207 }
Mike Stump31feda52009-07-17 01:31:16 +00005208
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005209 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005210 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005211 if (Stmt *T = I->getTarget())
5212 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005213 }
Mike Stump31feda52009-07-17 01:31:16 +00005214
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005215 void VisitBinaryOperator(BinaryOperator* B) {
5216 if (!B->isLogicalOp()) {
5217 VisitExpr(B);
5218 return;
5219 }
Mike Stump31feda52009-07-17 01:31:16 +00005220
Richard Trieuddd01ce2014-06-09 22:53:25 +00005221 if (B->getLHS())
5222 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005223
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005224 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00005225 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00005226 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005227 return;
John McCalle3027922010-08-25 11:45:40 +00005228 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00005229 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005230 return;
5231 default:
David Blaikie83d382b2011-09-23 05:06:16 +00005232 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00005233 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005234 }
Mike Stump31feda52009-07-17 01:31:16 +00005235
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005236 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00005237 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005238 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00005239
5240public:
5241 void print(CFGTerminator T) {
Artem Dergachev4e530322019-05-24 01:34:22 +00005242 switch (T.getKind()) {
5243 case CFGTerminator::StmtBranch:
5244 Visit(T.getStmt());
5245 break;
5246 case CFGTerminator::TemporaryDtorsBranch:
Ted Kremenekfcc14172014-03-08 02:22:29 +00005247 OS << "(Temp Dtor) ";
Artem Dergachev4e530322019-05-24 01:34:22 +00005248 Visit(T.getStmt());
5249 break;
Artem Dergachev192a7472019-05-24 23:37:08 +00005250 case CFGTerminator::VirtualBaseBranch:
5251 OS << "(See if most derived ctor has already initialized vbases)";
5252 break;
Artem Dergachev4e530322019-05-24 01:34:22 +00005253 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00005254 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00005255};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005256
5257} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00005258
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005259static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
5260 const CXXCtorInitializer *I) {
5261 if (I->isBaseInitializer())
5262 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
5263 else if (I->isDelegatingInitializer())
5264 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
5265 else
5266 OS << I->getAnyMember()->getName();
5267 OS << "(";
5268 if (Expr *IE = I->getInit())
5269 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
5270 OS << ")";
5271
5272 if (I->isBaseInitializer())
5273 OS << " (Base initializer)";
5274 else if (I->isDelegatingInitializer())
5275 OS << " (Delegating initializer)";
5276 else
5277 OS << " (Member initializer)";
5278}
5279
Artem Dergachev1527dec2018-03-12 23:12:40 +00005280static void print_construction_context(raw_ostream &OS,
5281 StmtPrinterHelper &Helper,
5282 const ConstructionContext *CC) {
Artem Dergachevff267df2018-06-28 00:04:54 +00005283 SmallVector<const Stmt *, 3> Stmts;
Artem Dergachev1527dec2018-03-12 23:12:40 +00005284 switch (CC->getKind()) {
Artem Dergachev922455f2018-03-22 22:02:38 +00005285 case ConstructionContext::SimpleConstructorInitializerKind: {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005286 OS << ", ";
Artem Dergachev922455f2018-03-22 22:02:38 +00005287 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC);
5288 print_initializer(OS, Helper, SICC->getCXXCtorInitializer());
Artem Dergacheva657a322018-07-31 20:45:53 +00005289 return;
Artem Dergachev922455f2018-03-22 22:02:38 +00005290 }
5291 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: {
5292 OS << ", ";
5293 const auto *CICC =
5294 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC);
5295 print_initializer(OS, Helper, CICC->getCXXCtorInitializer());
Artem Dergachevff267df2018-06-28 00:04:54 +00005296 Stmts.push_back(CICC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005297 break;
5298 }
5299 case ConstructionContext::SimpleVariableKind: {
Artem Dergachev317291e2018-03-22 21:37:39 +00005300 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005301 Stmts.push_back(SDSCC->getDeclStmt());
Artem Dergachev317291e2018-03-22 21:37:39 +00005302 break;
5303 }
5304 case ConstructionContext::CXX17ElidedCopyVariableKind: {
5305 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005306 Stmts.push_back(CDSCC->getDeclStmt());
5307 Stmts.push_back(CDSCC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005308 break;
5309 }
5310 case ConstructionContext::NewAllocatedObjectKind: {
5311 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005312 Stmts.push_back(NECC->getCXXNewExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005313 break;
5314 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005315 case ConstructionContext::SimpleReturnedValueKind: {
5316 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005317 Stmts.push_back(RSCC->getReturnStmt());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005318 break;
5319 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005320 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: {
5321 const auto *RSCC =
5322 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005323 Stmts.push_back(RSCC->getReturnStmt());
5324 Stmts.push_back(RSCC->getCXXBindTemporaryExpr());
Artem Dergachev317291e2018-03-22 21:37:39 +00005325 break;
5326 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005327 case ConstructionContext::SimpleTemporaryObjectKind: {
5328 const auto *TOCC = cast<SimpleTemporaryObjectConstructionContext>(CC);
5329 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5330 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5331 break;
5332 }
5333 case ConstructionContext::ElidedTemporaryObjectKind: {
5334 const auto *TOCC = cast<ElidedTemporaryObjectConstructionContext>(CC);
5335 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5336 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5337 Stmts.push_back(TOCC->getConstructorAfterElision());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005338 break;
5339 }
Artem Dergacheva657a322018-07-31 20:45:53 +00005340 case ConstructionContext::ArgumentKind: {
5341 const auto *ACC = cast<ArgumentConstructionContext>(CC);
5342 if (const Stmt *BTE = ACC->getCXXBindTemporaryExpr()) {
5343 OS << ", ";
5344 Helper.handledStmt(const_cast<Stmt *>(BTE), OS);
5345 }
5346 OS << ", ";
5347 Helper.handledStmt(const_cast<Expr *>(ACC->getCallLikeExpr()), OS);
5348 OS << "+" << ACC->getIndex();
5349 return;
5350 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005351 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005352 for (auto I: Stmts)
5353 if (I) {
5354 OS << ", ";
5355 Helper.handledStmt(const_cast<Stmt *>(I), OS);
5356 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005357}
5358
Aaron Ballmanff924b02013-11-18 20:11:50 +00005359static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Kristof Umannf1746702019-09-12 19:52:34 +00005360 const CFGElement &E);
5361
5362void CFGElement::dumpToStream(llvm::raw_ostream &OS) const {
5363 StmtPrinterHelper Helper(nullptr, {});
5364 print_elem(OS, Helper, *this);
5365}
5366
5367static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00005368 const CFGElement &E) {
Kristof Umannf1746702019-09-12 19:52:34 +00005369 switch (E.getKind()) {
5370 case CFGElement::Kind::Statement:
5371 case CFGElement::Kind::CXXRecordTypedCall:
5372 case CFGElement::Kind::Constructor: {
5373 CFGStmt CS = E.castAs<CFGStmt>();
5374 const Stmt *S = CS.getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00005375 assert(S != nullptr && "Expecting non-null Stmt");
5376
Aaron Ballmanff924b02013-11-18 20:11:50 +00005377 // special printing for statement-expressions.
5378 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
5379 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00005380
Benjamin Kramer5733e352015-07-18 17:09:36 +00005381 auto Children = Sub->children();
5382 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005383 OS << "({ ... ; ";
5384 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
5385 OS << " })\n";
5386 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005387 }
5388 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00005389 // special printing for comma expressions.
5390 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
5391 if (B->getOpcode() == BO_Comma) {
5392 OS << "... , ";
5393 Helper.handledStmt(B->getRHS(),OS);
5394 OS << '\n';
5395 return;
5396 }
5397 }
5398 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00005399
Artem Dergachev1527dec2018-03-12 23:12:40 +00005400 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
5401 if (isa<CXXOperatorCallExpr>(S))
5402 OS << " (OperatorCall)";
5403 OS << " (CXXRecordTypedCall";
5404 print_construction_context(OS, Helper, VTC->getConstructionContext());
5405 OS << ")";
5406 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005407 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005408 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005409 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005410 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005411 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005412 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005413 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00005414 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005415 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005416 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00005417 OS << " (" << CE->getStmtClassName() << ", "
5418 << CE->getCastKindName()
5419 << ", " << CE->getType().getAsString()
5420 << ")";
5421 }
Mike Stump31feda52009-07-17 01:31:16 +00005422
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005423 // Expressions need a newline.
5424 if (isa<Expr>(S))
5425 OS << '\n';
Kristof Umannf1746702019-09-12 19:52:34 +00005426
5427 break;
5428 }
5429
5430 case CFGElement::Kind::Initializer:
5431 print_initializer(OS, Helper, E.castAs<CFGInitializer>().getInitializer());
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005432 OS << '\n';
Kristof Umannf1746702019-09-12 19:52:34 +00005433 break;
5434
5435 case CFGElement::Kind::AutomaticObjectDtor: {
5436 CFGAutomaticObjDtor DE = E.castAs<CFGAutomaticObjDtor>();
5437 const VarDecl *VD = DE.getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005438 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005439
Artem Dergacheva25809f2018-06-04 18:56:25 +00005440 QualType T = VD->getType();
5441 if (T->isReferenceType())
5442 T = getReferenceInitTemporaryType(VD->getInit(), nullptr);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005443
Artem Dergachevead98ea2019-08-28 18:44:42 +00005444 OS << ".~";
5445 T.getUnqualifiedType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5446 OS << "() (Implicit destructor)\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005447 break;
5448 }
Matthias Gehre351c2182017-07-12 07:04:19 +00005449
Kristof Umannf1746702019-09-12 19:52:34 +00005450 case CFGElement::Kind::LifetimeEnds:
5451 Helper.handleDecl(E.castAs<CFGLifetimeEnds>().getVarDecl(), OS);
Matthias Gehre351c2182017-07-12 07:04:19 +00005452 OS << " (Lifetime ends)\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005453 break;
5454
5455 case CFGElement::Kind::LoopExit:
5456 OS << E.castAs<CFGLoopExit>().getLoopStmt()->getStmtClassName() << " (LoopExit)\n";
5457 break;
5458
5459 case CFGElement::Kind::ScopeBegin:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005460 OS << "CFGScopeBegin(";
Kristof Umannf1746702019-09-12 19:52:34 +00005461 if (const VarDecl *VD = E.castAs<CFGScopeBegin>().getVarDecl())
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005462 OS << VD->getQualifiedNameAsString();
5463 OS << ")\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005464 break;
5465
5466 case CFGElement::Kind::ScopeEnd:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005467 OS << "CFGScopeEnd(";
Kristof Umannf1746702019-09-12 19:52:34 +00005468 if (const VarDecl *VD = E.castAs<CFGScopeEnd>().getVarDecl())
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005469 OS << VD->getQualifiedNameAsString();
5470 OS << ")\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005471 break;
5472
5473 case CFGElement::Kind::NewAllocator:
Jordan Rosec9176072014-01-13 17:59:19 +00005474 OS << "CFGNewAllocator(";
Kristof Umannf1746702019-09-12 19:52:34 +00005475 if (const CXXNewExpr *AllocExpr = E.castAs<CFGNewAllocator>().getAllocatorExpr())
Jordan Rosec9176072014-01-13 17:59:19 +00005476 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5477 OS << ")\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005478 break;
5479
5480 case CFGElement::Kind::DeleteDtor: {
5481 CFGDeleteDtor DE = E.castAs<CFGDeleteDtor>();
5482 const CXXRecordDecl *RD = DE.getCXXRecordDecl();
Jordan Rosed2f40792013-09-03 17:00:57 +00005483 if (!RD)
5484 return;
5485 CXXDeleteExpr *DelExpr =
Kristof Umannf1746702019-09-12 19:52:34 +00005486 const_cast<CXXDeleteExpr*>(DE.getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005487 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005488 OS << "->~" << RD->getName().str() << "()";
5489 OS << " (Implicit destructor)\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005490 break;
5491 }
5492
5493 case CFGElement::Kind::BaseDtor: {
5494 const CXXBaseSpecifier *BS = E.castAs<CFGBaseDtor>().getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005495 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005496 OS << " (Base object destructor)\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005497 break;
5498 }
5499
5500 case CFGElement::Kind::MemberDtor: {
5501 const FieldDecl *FD = E.castAs<CFGMemberDtor>().getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005502 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005503 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005504 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005505 OS << " (Member object destructor)\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005506 break;
5507 }
5508
5509 case CFGElement::Kind::TemporaryDtor: {
5510 const CXXBindTemporaryExpr *BT = E.castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005511 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005512 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005513 OS << "() (Temporary object destructor)\n";
Kristof Umannf1746702019-09-12 19:52:34 +00005514 break;
5515 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005516 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005517}
Mike Stump31feda52009-07-17 01:31:16 +00005518
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005519static void print_block(raw_ostream &OS, const CFG* cfg,
5520 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005521 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005522 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005523 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005524
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005525 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005526 if (ShowColors)
5527 OS.changeColor(raw_ostream::YELLOW, true);
Fangrui Song6907ce22018-07-30 19:24:48 +00005528
Ted Kremenek72be32a2011-12-22 23:33:52 +00005529 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005530
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005531 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005532 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005533 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005534 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005535 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005536 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005537 else if (B.hasNoReturnElement())
5538 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005539 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005540 OS << "]\n";
Fangrui Song6907ce22018-07-30 19:24:48 +00005541
Ted Kremenek72be32a2011-12-22 23:33:52 +00005542 if (ShowColors)
5543 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005544
Ted Kremenek71eca012007-08-29 23:20:49 +00005545 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005546 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005547 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005548 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005549
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005550 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005551 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005552 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005553 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005554 if (C->getLHS())
5555 C->getLHS()->printPretty(OS, &Helper,
5556 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005557 if (C->getRHS()) {
5558 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005559 C->getRHS()->printPretty(OS, &Helper,
5560 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005561 }
Mike Stump92244b02010-01-19 22:00:14 +00005562 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005563 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005564 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005565 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005566 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005567 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005568 0);
5569 else
5570 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005571 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005572 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5573 OS << "__except (";
5574 ES->getFilterExpr()->printPretty(OS, &Helper,
5575 PrintingPolicy(Helper.getLangOpts()), 0);
5576 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005577 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005578 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005579
Ted Kremenek71eca012007-08-29 23:20:49 +00005580 OS << ":\n";
5581 }
Mike Stump31feda52009-07-17 01:31:16 +00005582
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005583 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005584 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005585
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005586 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5587 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005588 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005589 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005590 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005591
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005592 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005593
Aaron Ballmanff924b02013-11-18 20:11:50 +00005594 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005595
Ted Kremenek72be32a2011-12-22 23:33:52 +00005596 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005597 }
Mike Stump31feda52009-07-17 01:31:16 +00005598
Ted Kremenek71eca012007-08-29 23:20:49 +00005599 // Print the terminator of this block.
Artem Dergachev4e530322019-05-24 01:34:22 +00005600 if (B.getTerminator().isValid()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005601 if (ShowColors)
5602 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005603
Ted Kremenek72be32a2011-12-22 23:33:52 +00005604 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005605
Aaron Ballmanff924b02013-11-18 20:11:50 +00005606 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005607
Aaron Ballmanff924b02013-11-18 20:11:50 +00005608 PrintingPolicy PP(Helper.getLangOpts());
5609 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005610 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005611 OS << '\n';
Fangrui Song6907ce22018-07-30 19:24:48 +00005612
Ted Kremenek72be32a2011-12-22 23:33:52 +00005613 if (ShowColors)
5614 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005615 }
Mike Stump31feda52009-07-17 01:31:16 +00005616
Ted Kremenek71eca012007-08-29 23:20:49 +00005617 if (print_edges) {
5618 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005619 if (!B.pred_empty()) {
Rui Ueyama4d41c332019-08-02 07:22:34 +00005620 const raw_ostream::Colors Color = raw_ostream::BLUE;
Ted Kremenek72be32a2011-12-22 23:33:52 +00005621 if (ShowColors)
5622 OS.changeColor(Color);
5623 OS << " Preds " ;
5624 if (ShowColors)
5625 OS.resetColor();
5626 OS << '(' << B.pred_size() << "):";
5627 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005628
Ted Kremenek72be32a2011-12-22 23:33:52 +00005629 if (ShowColors)
5630 OS.changeColor(Color);
Fangrui Song6907ce22018-07-30 19:24:48 +00005631
Ted Kremenek72be32a2011-12-22 23:33:52 +00005632 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5633 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005634 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005635 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005636
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005637 CFGBlock *B = *I;
5638 bool Reachable = true;
5639 if (!B) {
5640 Reachable = false;
5641 B = I->getPossiblyUnreachableBlock();
5642 }
5643
5644 OS << " B" << B->getBlockID();
5645 if (!Reachable)
5646 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005647 }
Fangrui Song6907ce22018-07-30 19:24:48 +00005648
Ted Kremenek72be32a2011-12-22 23:33:52 +00005649 if (ShowColors)
5650 OS.resetColor();
5651
5652 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005653 }
Mike Stump31feda52009-07-17 01:31:16 +00005654
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005655 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005656 if (!B.succ_empty()) {
Rui Ueyama4d41c332019-08-02 07:22:34 +00005657 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
Ted Kremenek72be32a2011-12-22 23:33:52 +00005658 if (ShowColors)
5659 OS.changeColor(Color);
5660 OS << " Succs ";
5661 if (ShowColors)
5662 OS.resetColor();
5663 OS << '(' << B.succ_size() << "):";
5664 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005665
Ted Kremenek72be32a2011-12-22 23:33:52 +00005666 if (ShowColors)
5667 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005668
Ted Kremenek72be32a2011-12-22 23:33:52 +00005669 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5670 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005671 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005672 OS << "\n ";
5673
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005674 CFGBlock *B = *I;
5675
5676 bool Reachable = true;
5677 if (!B) {
5678 Reachable = false;
5679 B = I->getPossiblyUnreachableBlock();
5680 }
5681
5682 if (B) {
5683 OS << " B" << B->getBlockID();
5684 if (!Reachable)
5685 OS << "(Unreachable)";
5686 }
5687 else {
5688 OS << " NULL";
5689 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005690 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005691
Ted Kremenek72be32a2011-12-22 23:33:52 +00005692 if (ShowColors)
5693 OS.resetColor();
5694 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005695 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005696 }
Mike Stump31feda52009-07-17 01:31:16 +00005697}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005698
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005699/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005700void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5701 print(llvm::errs(), LO, ShowColors);
5702}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005703
5704/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005705void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005706 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005707
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005708 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005709 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005710
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005711 // Iterate through the CFGBlocks and print them one by one.
5712 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5713 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005714 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005715 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005716
Aaron Ballmanff924b02013-11-18 20:11:50 +00005717 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005718 }
Mike Stump31feda52009-07-17 01:31:16 +00005719
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005720 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005721 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005722 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005723 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005724}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005725
Kristof Umann92541e32019-08-14 17:05:55 +00005726size_t CFGBlock::getIndexInCFG() const {
5727 return llvm::find(*getParent(), this) - getParent()->begin();
5728}
5729
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005730/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005731void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5732 bool ShowColors) const {
5733 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005734}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005735
Yaron Kerencdae9412016-01-29 19:38:18 +00005736LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005737 dump(getParent(), LangOptions(), false);
5738}
5739
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005740/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5741/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005742void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005743 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005744 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005745 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005746 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005747}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005748
Ted Kremenek15647632008-01-30 23:02:42 +00005749/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005750void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005751 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005752 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005753 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005754}
5755
Csaba Dabisdea605e2019-05-29 18:29:31 +00005756/// printTerminatorJson - Pretty-prints the terminator in JSON format.
5757void CFGBlock::printTerminatorJson(raw_ostream &Out, const LangOptions &LO,
5758 bool AddQuotes) const {
5759 std::string Buf;
5760 llvm::raw_string_ostream TempOut(Buf);
5761
5762 printTerminator(TempOut, LO);
5763
5764 Out << JsonFormat(TempOut.str(), AddQuotes);
5765}
5766
Kristof Umanndd53bdb2019-08-14 12:20:08 +00005767// Returns true if by simply looking at the block, we can be sure that it
5768// results in a sink during analysis. This is useful to know when the analysis
5769// was interrupted, and we try to figure out if it would sink eventually.
5770// There may be many more reasons why a sink would appear during analysis
5771// (eg. checkers may generate sinks arbitrarily), but here we only consider
5772// sinks that would be obvious by looking at the CFG.
5773static bool isImmediateSinkBlock(const CFGBlock *Blk) {
5774 if (Blk->hasNoReturnElement())
5775 return true;
5776
5777 // FIXME: Throw-expressions are currently generating sinks during analysis:
5778 // they're not supported yet, and also often used for actually terminating
5779 // the program. So we should treat them as sinks in this analysis as well,
5780 // at least for now, but once we have better support for exceptions,
5781 // we'd need to carefully handle the case when the throw is being
5782 // immediately caught.
5783 if (std::any_of(Blk->begin(), Blk->end(), [](const CFGElement &Elm) {
5784 if (Optional<CFGStmt> StmtElm = Elm.getAs<CFGStmt>())
5785 if (isa<CXXThrowExpr>(StmtElm->getStmt()))
5786 return true;
5787 return false;
5788 }))
5789 return true;
5790
5791 return false;
5792}
5793
5794bool CFGBlock::isInevitablySinking() const {
5795 const CFG &Cfg = *getParent();
5796
5797 const CFGBlock *StartBlk = this;
5798 if (isImmediateSinkBlock(StartBlk))
5799 return true;
5800
5801 llvm::SmallVector<const CFGBlock *, 32> DFSWorkList;
5802 llvm::SmallPtrSet<const CFGBlock *, 32> Visited;
5803
5804 DFSWorkList.push_back(StartBlk);
5805 while (!DFSWorkList.empty()) {
5806 const CFGBlock *Blk = DFSWorkList.back();
5807 DFSWorkList.pop_back();
5808 Visited.insert(Blk);
5809
5810 // If at least one path reaches the CFG exit, it means that control is
5811 // returned to the caller. For now, say that we are not sure what
5812 // happens next. If necessary, this can be improved to analyze
5813 // the parent StackFrameContext's call site in a similar manner.
5814 if (Blk == &Cfg.getExit())
5815 return false;
5816
5817 for (const auto &Succ : Blk->succs()) {
5818 if (const CFGBlock *SuccBlk = Succ.getReachableBlock()) {
5819 if (!isImmediateSinkBlock(SuccBlk) && !Visited.count(SuccBlk)) {
5820 // If the block has reachable child blocks that aren't no-return,
5821 // add them to the worklist.
5822 DFSWorkList.push_back(SuccBlk);
5823 }
5824 }
5825 }
5826 }
5827
5828 // Nothing reached the exit. It can only mean one thing: there's no return.
5829 return true;
5830}
5831
Kristof Umannd5c9d9b2019-07-05 09:52:00 +00005832const Expr *CFGBlock::getLastCondition() const {
5833 // If the terminator is a temporary dtor or a virtual base, etc, we can't
5834 // retrieve a meaningful condition, bail out.
5835 if (Terminator.getKind() != CFGTerminator::StmtBranch)
5836 return nullptr;
5837
5838 // Also, if this method was called on a block that doesn't have 2 successors,
5839 // this block doesn't have retrievable condition.
5840 if (succ_size() < 2)
5841 return nullptr;
5842
5843 auto StmtElem = rbegin()->getAs<CFGStmt>();
5844 if (!StmtElem)
5845 return nullptr;
5846
5847 const Stmt *Cond = StmtElem->getStmt();
5848 if (isa<ObjCForCollectionStmt>(Cond))
5849 return nullptr;
5850
5851 // Only ObjCForCollectionStmt is known not to be a non-Expr terminator, hence
5852 // the cast<>.
5853 return cast<Expr>(Cond)->IgnoreParens();
5854}
5855
Kristof Umann9854d772019-07-03 13:03:33 +00005856Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
5857 Stmt *Terminator = getTerminatorStmt();
5858 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005859 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005860
Kristof Umann9854d772019-07-03 13:03:33 +00005861 Expr *E = nullptr;
5862
5863 switch (Terminator->getStmtClass()) {
5864 default:
5865 break;
5866
5867 case Stmt::CXXForRangeStmtClass:
5868 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5869 break;
5870
5871 case Stmt::ForStmtClass:
5872 E = cast<ForStmt>(Terminator)->getCond();
5873 break;
5874
5875 case Stmt::WhileStmtClass:
5876 E = cast<WhileStmt>(Terminator)->getCond();
5877 break;
5878
5879 case Stmt::DoStmtClass:
5880 E = cast<DoStmt>(Terminator)->getCond();
5881 break;
5882
5883 case Stmt::IfStmtClass:
5884 E = cast<IfStmt>(Terminator)->getCond();
5885 break;
5886
5887 case Stmt::ChooseExprClass:
5888 E = cast<ChooseExpr>(Terminator)->getCond();
5889 break;
5890
5891 case Stmt::IndirectGotoStmtClass:
5892 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5893 break;
5894
5895 case Stmt::SwitchStmtClass:
5896 E = cast<SwitchStmt>(Terminator)->getCond();
5897 break;
5898
5899 case Stmt::BinaryConditionalOperatorClass:
5900 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5901 break;
5902
5903 case Stmt::ConditionalOperatorClass:
5904 E = cast<ConditionalOperator>(Terminator)->getCond();
5905 break;
5906
5907 case Stmt::BinaryOperatorClass: // '&&' and '||'
5908 E = cast<BinaryOperator>(Terminator)->getLHS();
5909 break;
5910
5911 case Stmt::ObjCForCollectionStmtClass:
5912 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005913 }
Mike Stump31feda52009-07-17 01:31:16 +00005914
Kristof Umann9854d772019-07-03 13:03:33 +00005915 if (!StripParens)
5916 return E;
5917
5918 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005919}
5920
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005921//===----------------------------------------------------------------------===//
5922// CFG Graphviz Visualization
5923//===----------------------------------------------------------------------===//
5924
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005925#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005926static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005927#endif
5928
Chris Lattnerc61089a2009-06-30 01:26:17 +00005929void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005930#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005931 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005932 GraphHelper = &H;
5933 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005934 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005935#endif
5936}
5937
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005938namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005939
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005940template<>
5941struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005942 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005943
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005944 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005945#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005946 std::string OutSStr;
5947 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005948 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005949 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005950
5951 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5952
5953 // Process string output to make it nicer...
5954 for (unsigned i = 0; i != OutStr.length(); ++i)
5955 if (OutStr[i] == '\n') { // Left justify
5956 OutStr[i] = '\\';
5957 OutStr.insert(OutStr.begin()+i+1, 'l');
5958 }
Mike Stump31feda52009-07-17 01:31:16 +00005959
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005960 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005961#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005962 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005963#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005964 }
5965};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005966
5967} // namespace llvm