blob: 5d2926c0f0e591a2265998040ca7db568fb5a961 [file] [log] [blame]
Ted Kremenek6f400242012-07-14 05:04:01 +00001 //===--- CFG.cpp - Classes for representing and building CFGs----*- C++ -*-===//
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the CFG and CFGBuilder classes for representing and
11// building Control-Flow Graphs (CFGs) from ASTs.
12//
13//===----------------------------------------------------------------------===//
14
Ted Kremenek6796fbd2009-07-16 18:13:04 +000015#include "clang/Analysis/CFG.h"
Benjamin Kramer1ea8e092012-07-04 17:04:04 +000016#include "clang/AST/ASTContext.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000017#include "clang/AST/Attr.h"
Ted Kremenek1a241d12011-02-23 05:11:46 +000018#include "clang/AST/CharUnits.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000019#include "clang/AST/DeclCXX.h"
20#include "clang/AST/PrettyPrinter.h"
21#include "clang/AST/StmtVisitor.h"
Jordan Rose5374c072013-08-19 16:27:28 +000022#include "clang/Basic/Builtins.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000023#include "llvm/ADT/DenseMap.h"
Ahmed Charlesdfca6f92014-03-09 11:36:40 +000024#include <memory>
Benjamin Kramerea70eb32012-12-01 15:09:41 +000025#include "llvm/ADT/SmallPtrSet.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000026#include "llvm/Support/Allocator.h"
27#include "llvm/Support/Format.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000028#include "llvm/Support/GraphWriter.h"
29#include "llvm/Support/SaveAndRestore.h"
Ted Kremeneke5ccf9a2008-01-11 00:40:29 +000030
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +000031using namespace clang;
32
33namespace {
34
Ted Kremenek5ef32db2011-08-12 23:37:29 +000035static SourceLocation GetEndLoc(Decl *D) {
36 if (VarDecl *VD = dyn_cast<VarDecl>(D))
37 if (Expr *Ex = VD->getInit())
Ted Kremenek8889bb32008-08-06 23:20:50 +000038 return Ex->getSourceRange().getEnd();
Mike Stump31feda52009-07-17 01:31:16 +000039 return D->getLocation();
Ted Kremenek8889bb32008-08-06 23:20:50 +000040}
Ted Kremenekdc03bd02010-08-02 23:46:59 +000041
Ted Kremenek7c58d352011-03-10 01:14:11 +000042class CFGBuilder;
43
Zhanyong Wanb5d11c12010-11-24 03:28:53 +000044/// The CFG builder uses a recursive algorithm to build the CFG. When
45/// we process an expression, sometimes we know that we must add the
46/// subexpressions as block-level expressions. For example:
47///
48/// exp1 || exp2
49///
50/// When processing the '||' expression, we know that exp1 and exp2
51/// need to be added as block-level expressions, even though they
52/// might not normally need to be. AddStmtChoice records this
53/// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then
54/// the builder has an option not to add a subexpression as a
55/// block-level expression.
56///
Ted Kremenek4cad5fc2009-12-16 03:18:58 +000057class AddStmtChoice {
58public:
Ted Kremenek8219b822010-12-16 07:46:53 +000059 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 };
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +000060
Zhanyong Wanb5d11c12010-11-24 03:28:53 +000061 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +000062
Ted Kremenek7c58d352011-03-10 01:14:11 +000063 bool alwaysAdd(CFGBuilder &builder,
64 const Stmt *stmt) const;
Zhanyong Wanb5d11c12010-11-24 03:28:53 +000065
66 /// Return a copy of this object, except with the 'always-add' bit
67 /// set as specified.
68 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const {
Ted Kremenek7c58d352011-03-10 01:14:11 +000069 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +000070 }
71
Ted Kremenek4cad5fc2009-12-16 03:18:58 +000072private:
Zhanyong Wanb5d11c12010-11-24 03:28:53 +000073 Kind kind;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +000074};
Mike Stump31feda52009-07-17 01:31:16 +000075
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +000076/// LocalScope - Node in tree of local scopes created for C++ implicit
77/// destructor calls generation. It contains list of automatic variables
78/// declared in the scope and link to position in previous scope this scope
79/// began in.
80///
81/// The process of creating local scopes is as follows:
82/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
83/// - Before processing statements in scope (e.g. CompoundStmt) create
84/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
85/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +000086/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +000087/// at this VarDecl,
88/// - For every normal (without jump) end of scope add to CFGBlock destructors
89/// for objects in the current scope,
90/// - For every jump add to CFGBlock destructors for objects
91/// between CFGBuilder::ScopePos and local scope position saved for jump
92/// target. Thanks to C++ restrictions on goto jumps we can be sure that
93/// jump target position will be on the path to root from CFGBuilder::ScopePos
94/// (adding any variable that doesn't need constructor to be called to
95/// LocalScope can break this assumption),
96///
97class LocalScope {
98public:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +000099 typedef BumpVector<VarDecl*> AutomaticVarsTy;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000100
101 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000102 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000103 class const_iterator {
104 const LocalScope* Scope;
105
106 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
107 /// Invalid iterator (with null Scope) has VarIter equal to 0.
108 unsigned VarIter;
109
110 public:
111 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
112 /// Incrementing invalid iterator is allowed and will result in invalid
113 /// iterator.
114 const_iterator()
Craig Topper25542942014-05-20 04:30:07 +0000115 : Scope(nullptr), VarIter(0) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000116
117 /// Create valid iterator. In case when S.Prev is an invalid iterator and
118 /// I is equal to 0, this will create invalid iterator.
119 const_iterator(const LocalScope& S, unsigned I)
120 : Scope(&S), VarIter(I) {
121 // Iterator to "end" of scope is not allowed. Handle it by going up
122 // in scopes tree possibly up to invalid iterator in the root.
123 if (VarIter == 0 && Scope)
124 *this = Scope->Prev;
125 }
126
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000127 VarDecl *const* operator->() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000128 assert (Scope && "Dereferencing invalid iterator is not allowed");
129 assert (VarIter != 0 && "Iterator has invalid value of VarIter member");
130 return &Scope->Vars[VarIter - 1];
131 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000132 VarDecl *operator*() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000133 return *this->operator->();
134 }
135
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000136 const_iterator &operator++() {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000137 if (!Scope)
138 return *this;
139
140 assert (VarIter != 0 && "Iterator has invalid value of VarIter member");
141 --VarIter;
142 if (VarIter == 0)
143 *this = Scope->Prev;
144 return *this;
145 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000146 const_iterator operator++(int) {
147 const_iterator P = *this;
148 ++*this;
149 return P;
150 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000151
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000152 bool operator==(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000153 return Scope == rhs.Scope && VarIter == rhs.VarIter;
154 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000155 bool operator!=(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000156 return !(*this == rhs);
157 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000158
David Blaikie7d170102013-05-15 07:37:26 +0000159 LLVM_EXPLICIT operator bool() const {
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000160 return *this != const_iterator();
161 }
162
163 int distance(const_iterator L);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000164 };
165
166 friend class const_iterator;
167
168private:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000169 BumpVectorContext ctx;
170
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000171 /// Automatic variables in order of declaration.
172 AutomaticVarsTy Vars;
173 /// Iterator to variable in previous scope that was declared just before
174 /// begin of this scope.
175 const_iterator Prev;
176
177public:
178 /// Constructs empty scope linked to previous scope in specified place.
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000179 LocalScope(BumpVectorContext &ctx, const_iterator P)
180 : ctx(ctx), Vars(ctx, 4), Prev(P) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000181
182 /// Begin of scope in direction of CFG building (backwards).
183 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000184
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000185 void addVar(VarDecl *VD) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000186 Vars.push_back(VD, ctx);
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000187 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000188};
189
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000190/// distance - Calculates distance from this to L. L must be reachable from this
191/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
192/// number of scopes between this and L.
193int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
194 int D = 0;
195 const_iterator F = *this;
196 while (F.Scope != L.Scope) {
Ted Kremenek50aa2d42011-08-12 14:41:23 +0000197 assert (F != const_iterator()
198 && "L iterator is not reachable from F iterator.");
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000199 D += F.VarIter;
200 F = F.Scope->Prev;
201 }
202 D += F.VarIter - L.VarIter;
203 return D;
204}
205
206/// BlockScopePosPair - Structure for specifying position in CFG during its
207/// build process. It consists of CFGBlock that specifies position in CFG graph
208/// and LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000209struct BlockScopePosPair {
Craig Topper25542942014-05-20 04:30:07 +0000210 BlockScopePosPair() : block(nullptr) {}
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000211 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos)
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000212 : block(b), scopePosition(scopePos) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000213
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000214 CFGBlock *block;
215 LocalScope::const_iterator scopePosition;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000216};
217
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000218/// TryResult - a class representing a variant over the values
219/// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool,
220/// and is used by the CFGBuilder to decide if a branch condition
221/// can be decided up front during CFG construction.
222class TryResult {
223 int X;
224public:
225 TryResult(bool b) : X(b ? 1 : 0) {}
226 TryResult() : X(-1) {}
227
228 bool isTrue() const { return X == 1; }
229 bool isFalse() const { return X == 0; }
230 bool isKnown() const { return X >= 0; }
231 void negate() {
232 assert(isKnown());
233 X ^= 0x1;
234 }
235};
236
Ted Kremenek8ae67872013-02-05 22:00:19 +0000237class reverse_children {
238 llvm::SmallVector<Stmt *, 12> childrenBuf;
239 ArrayRef<Stmt*> children;
240public:
241 reverse_children(Stmt *S);
242
243 typedef ArrayRef<Stmt*>::reverse_iterator iterator;
244 iterator begin() const { return children.rbegin(); }
245 iterator end() const { return children.rend(); }
246};
247
248
249reverse_children::reverse_children(Stmt *S) {
250 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
251 children = CE->getRawSubExprs();
252 return;
253 }
254 switch (S->getStmtClass()) {
Ted Kremenek7d86b9c2013-02-05 22:03:14 +0000255 // Note: Fill in this switch with more cases we want to optimize.
Ted Kremenek8ae67872013-02-05 22:00:19 +0000256 case Stmt::InitListExprClass: {
257 InitListExpr *IE = cast<InitListExpr>(S);
258 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()),
259 IE->getNumInits());
260 return;
261 }
262 default:
263 break;
264 }
265
266 // Default case for all other statements.
267 for (Stmt::child_range I = S->children(); I; ++I) {
268 childrenBuf.push_back(*I);
269 }
270
271 // This needs to be done *after* childrenBuf has been populated.
272 children = childrenBuf;
273}
274
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000275/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000276/// The builder is stateful: an instance of the builder should be used to only
277/// construct a single CFG.
278///
279/// Example usage:
280///
281/// CFGBuilder builder;
282/// CFG* cfg = builder.BuildAST(stmt1);
283///
Mike Stump31feda52009-07-17 01:31:16 +0000284/// CFG construction is done via a recursive walk of an AST. We actually parse
285/// the AST in reverse order so that the successor of a basic block is
286/// constructed prior to its predecessor. This allows us to nicely capture
287/// implicit fall-throughs without extra basic blocks.
Ted Kremenek1b8ac852007-08-21 22:06:14 +0000288///
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000289class CFGBuilder {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000290 typedef BlockScopePosPair JumpTarget;
291 typedef BlockScopePosPair JumpSource;
292
Mike Stump0d76d072009-07-20 23:24:15 +0000293 ASTContext *Context;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000294 std::unique_ptr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000295
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000296 CFGBlock *Block;
297 CFGBlock *Succ;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000298 JumpTarget ContinueJumpTarget;
299 JumpTarget BreakJumpTarget;
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000300 CFGBlock *SwitchTerminatedBlock;
301 CFGBlock *DefaultCaseBlock;
302 CFGBlock *TryTerminatedBlock;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000303
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000304 // Current position in local scope.
305 LocalScope::const_iterator ScopePos;
306
307 // LabelMap records the mapping from Label expressions to their jump targets.
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000308 typedef llvm::DenseMap<LabelDecl*, JumpTarget> LabelMapTy;
Ted Kremenek8a632182007-08-21 23:26:17 +0000309 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000310
311 // A list of blocks that end with a "goto" that must be backpatched to their
312 // resolved targets upon completion of CFG construction.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000313 typedef std::vector<JumpSource> BackpatchBlocksTy;
Ted Kremenek8a632182007-08-21 23:26:17 +0000314 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000315
Ted Kremenekeda180e22007-08-28 19:26:49 +0000316 // A list of labels whose address has been taken (for indirect gotos).
Chris Lattnerc8e630e2011-02-17 07:39:24 +0000317 typedef llvm::SmallPtrSet<LabelDecl*, 5> LabelSetTy;
Ted Kremenekeda180e22007-08-28 19:26:49 +0000318 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000319
Zhongxing Xud38fb842010-09-16 03:28:18 +0000320 bool badCFG;
Ted Kremenekf9d82902011-03-10 01:14:05 +0000321 const CFG::BuildOptions &BuildOpts;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000322
323 // State to track for building switch statements.
324 bool switchExclusivelyCovered;
Ted Kremenekbe528712011-03-04 01:03:41 +0000325 Expr::EvalResult *switchCond;
Ted Kremeneka099c592011-03-10 03:50:34 +0000326
327 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000328 const Stmt *lastLookup;
Zhongxing Xud38fb842010-09-16 03:28:18 +0000329
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000330 // Caches boolean evaluations of expressions to avoid multiple re-evaluations
331 // during construction of branches for chained logical operators.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000332 typedef llvm::DenseMap<Expr *, TryResult> CachedBoolEvalsTy;
333 CachedBoolEvalsTy CachedBoolEvals;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000334
Mike Stump31feda52009-07-17 01:31:16 +0000335public:
Ted Kremenekf9d82902011-03-10 01:14:05 +0000336 explicit CFGBuilder(ASTContext *astContext,
337 const CFG::BuildOptions &buildOpts)
338 : Context(astContext), cfg(new CFG()), // crew a new CFG
Craig Topper25542942014-05-20 04:30:07 +0000339 Block(nullptr), Succ(nullptr),
340 SwitchTerminatedBlock(nullptr), DefaultCaseBlock(nullptr),
341 TryTerminatedBlock(nullptr), badCFG(false), BuildOpts(buildOpts),
342 switchExclusivelyCovered(false), switchCond(nullptr),
343 cachedEntry(nullptr), lastLookup(nullptr) {}
Mike Stump31feda52009-07-17 01:31:16 +0000344
Ted Kremenek9aae5132007-08-23 21:42:29 +0000345 // buildCFG - Used by external clients to construct the CFG.
Ted Kremenekf9d82902011-03-10 01:14:05 +0000346 CFG* buildCFG(const Decl *D, Stmt *Statement);
Mike Stump31feda52009-07-17 01:31:16 +0000347
Ted Kremeneka099c592011-03-10 03:50:34 +0000348 bool alwaysAdd(const Stmt *stmt);
349
Ted Kremenek93668002009-07-17 22:18:43 +0000350private:
351 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000352 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
353 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000354 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000355 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000356 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000357 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000358 CFGBlock *VisitCompoundStmt(CompoundStmt *C);
John McCallc07a0c72011-02-17 10:25:35 +0000359 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C,
360 AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000361 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek6f400242012-07-14 05:04:01 +0000362 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
363 AddStmtChoice asc);
364 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
365 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc);
Jordan Rosec9176072014-01-13 17:59:19 +0000366 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc);
Jordan Rosed2f40792013-09-03 17:00:57 +0000367 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000368 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S);
369 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
370 AddStmtChoice asc);
371 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
372 AddStmtChoice asc);
373 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
374 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000375 CFGBlock *VisitDeclStmt(DeclStmt *DS);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000376 CFGBlock *VisitDeclSubExpr(DeclStmt *DS);
Ted Kremenek21822592009-07-17 18:20:32 +0000377 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
378 CFGBlock *VisitDoStmt(DoStmt *D);
Ted Kremenek6f400242012-07-14 05:04:01 +0000379 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000380 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000381 CFGBlock *VisitGotoStmt(GotoStmt *G);
Ted Kremenek93668002009-07-17 22:18:43 +0000382 CFGBlock *VisitIfStmt(IfStmt *I);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +0000383 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *E, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000384 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I);
385 CFGBlock *VisitLabelStmt(LabelStmt *L);
Ted Kremenek6f400242012-07-14 05:04:01 +0000386 CFGBlock *VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc);
Ted Kremeneka16436f2012-07-14 05:04:06 +0000387 CFGBlock *VisitLogicalOperator(BinaryOperator *B);
Ted Kremenekb50e7162012-07-14 05:04:10 +0000388 std::pair<CFGBlock *, CFGBlock *> VisitLogicalOperator(BinaryOperator *B,
389 Stmt *Term,
390 CFGBlock *TrueBlock,
391 CFGBlock *FalseBlock);
Ted Kremenek5868ec62010-04-11 17:02:10 +0000392 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000393 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S);
394 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S);
395 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S);
396 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000397 CFGBlock *VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000398 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S);
John McCallfe96e0b2011-11-06 09:01:30 +0000399 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E);
Ted Kremenek6f400242012-07-14 05:04:01 +0000400 CFGBlock *VisitReturnStmt(ReturnStmt *R);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000401 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000402 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000403 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
404 AddStmtChoice asc);
Zhanyong Wan6dace612010-11-22 08:45:56 +0000405 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000406 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000407
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000408 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd);
409 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000410 CFGBlock *VisitChildren(Stmt *S);
Ted Kremeneke2499842012-04-12 20:03:44 +0000411 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc);
Mike Stump48871a22009-07-17 01:04:31 +0000412
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000413 // Visitors to walk an AST and generate destructors of temporaries in
414 // full expression.
415 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool BindToTemporary = false);
416 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E);
417 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E);
418 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(CXXBindTemporaryExpr *E,
419 bool BindToTemporary);
John McCallc07a0c72011-02-17 10:25:35 +0000420 CFGBlock *
421 VisitConditionalOperatorForTemporaryDtors(AbstractConditionalOperator *E,
422 bool BindToTemporary);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000423
Ted Kremenek6065ef62008-04-28 18:00:46 +0000424 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000425 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000426 badCFG = true;
427 return Block;
428 }
Mike Stump31feda52009-07-17 01:31:16 +0000429
Ted Kremenek93668002009-07-17 22:18:43 +0000430 void autoCreateBlock() { if (!Block) Block = createBlock(); }
431 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000432 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000433
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000434 CFGBlock *addStmt(Stmt *S) {
435 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000436 }
Alexis Hunt1d792652011-01-08 20:30:50 +0000437 CFGBlock *addInitializer(CXXCtorInitializer *I);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000438 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000439 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000440 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000441
Marcin Swiderski5e415732010-09-30 23:05:00 +0000442 // Local scopes creation.
443 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
444
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000445 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000446 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
447 LocalScope* Scope = nullptr);
448 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000449
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000450 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000451
452 // Interface to CFGBlock - adding CFGElements.
Ted Kremenek37881932011-04-04 23:29:12 +0000453 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000454 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000455 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000456
Jordy Rose17347372011-06-10 08:49:37 +0000457 // All block-level expressions should have already been IgnoreParens()ed.
458 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000459 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000460 }
Alexis Hunt1d792652011-01-08 20:30:50 +0000461 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000462 B->appendInitializer(I, cfg->getBumpVectorContext());
463 }
Jordan Rosec9176072014-01-13 17:59:19 +0000464 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
465 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
466 }
Marcin Swiderski20b88732010-10-05 05:37:00 +0000467 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
468 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
469 }
470 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
471 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
472 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000473 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
474 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
475 }
Chandler Carruthad747252011-09-13 06:09:01 +0000476 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
477 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
478 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000479
Jordan Rosed2f40792013-09-03 17:00:57 +0000480 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
481 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
482 }
483
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000484 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000485 LocalScope::const_iterator B, LocalScope::const_iterator E);
486
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000487 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
488 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
489 cfg->getBumpVectorContext());
490 }
491
492 /// Add a reachable successor to a block, with the alternate variant that is
493 /// unreachable.
494 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
495 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
496 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000497 }
Mike Stump11289f42009-09-09 15:08:12 +0000498
Richard Trieuf935b562014-04-05 05:17:01 +0000499 /// \brief Find a relational comparison with an expression evaluating to a
500 /// boolean and a constant other than 0 and 1.
501 /// e.g. if ((x < y) == 10)
502 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
503 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
504 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
505
506 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
507 const Expr *BoolExpr = RHSExpr;
508 bool IntFirst = true;
509 if (!IntLiteral) {
510 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
511 BoolExpr = LHSExpr;
512 IntFirst = false;
513 }
514
515 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
516 return TryResult();
517
518 llvm::APInt IntValue = IntLiteral->getValue();
519 if ((IntValue == 1) || (IntValue == 0))
520 return TryResult();
521
522 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
523 !IntValue.isNegative();
524
525 BinaryOperatorKind Bok = B->getOpcode();
526 if (Bok == BO_GT || Bok == BO_GE) {
527 // Always true for 10 > bool and bool > -1
528 // Always false for -1 > bool and bool > 10
529 return TryResult(IntFirst == IntLarger);
530 } else {
531 // Always true for -1 < bool and bool < 10
532 // Always false for 10 < bool and bool < -1
533 return TryResult(IntFirst != IntLarger);
534 }
535 }
536
Jordan Rose7afd71e2014-05-20 17:31:11 +0000537 /// Find an incorrect equality comparison. Either with an expression
538 /// evaluating to a boolean and a constant other than 0 and 1.
539 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
540 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000541 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
542 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
543 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
544
545 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
546 const Expr *BoolExpr = RHSExpr;
547
548 if (!IntLiteral) {
549 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
550 BoolExpr = LHSExpr;
551 }
552
Jordan Rose7afd71e2014-05-20 17:31:11 +0000553 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000554 return TryResult();
555
Jordan Rose7afd71e2014-05-20 17:31:11 +0000556 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
557 if (BitOp && (BitOp->getOpcode() == BO_And ||
558 BitOp->getOpcode() == BO_Or)) {
559 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
560 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
561
562 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
563
564 if (!IntLiteral2)
565 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
566
567 if (!IntLiteral2)
568 return TryResult();
569
570 llvm::APInt L1 = IntLiteral->getValue();
571 llvm::APInt L2 = IntLiteral2->getValue();
572 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
573 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
574 if (BuildOpts.Observer)
575 BuildOpts.Observer->compareBitwiseEquality(B,
576 B->getOpcode() != BO_EQ);
577 TryResult(B->getOpcode() != BO_EQ);
578 }
579 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
580 llvm::APInt IntValue = IntLiteral->getValue();
581 if ((IntValue == 1) || (IntValue == 0)) {
582 return TryResult();
583 }
584 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000585 }
586
Jordan Rose7afd71e2014-05-20 17:31:11 +0000587 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000588 }
589
590 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
591 const llvm::APSInt &Value1,
592 const llvm::APSInt &Value2) {
593 assert(Value1.isSigned() == Value2.isSigned());
594 switch (Relation) {
595 default:
596 return TryResult();
597 case BO_EQ:
598 return TryResult(Value1 == Value2);
599 case BO_NE:
600 return TryResult(Value1 != Value2);
601 case BO_LT:
602 return TryResult(Value1 < Value2);
603 case BO_LE:
604 return TryResult(Value1 <= Value2);
605 case BO_GT:
606 return TryResult(Value1 > Value2);
607 case BO_GE:
608 return TryResult(Value1 >= Value2);
609 }
610 }
611
612 /// \brief Find a pair of comparison expressions with or without parentheses
613 /// with a shared variable and constants and a logical operator between them
614 /// that always evaluates to either true or false.
615 /// e.g. if (x != 3 || x != 4)
616 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
617 assert(B->isLogicalOp());
618 const BinaryOperator *LHS =
619 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
620 const BinaryOperator *RHS =
621 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
622 if (!LHS || !RHS)
623 return TryResult();
624
625 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
626 return TryResult();
627
628 BinaryOperatorKind BO1 = LHS->getOpcode();
629 const DeclRefExpr *Decl1 =
630 dyn_cast<DeclRefExpr>(LHS->getLHS()->IgnoreParenImpCasts());
631 const IntegerLiteral *Literal1 =
632 dyn_cast<IntegerLiteral>(LHS->getRHS()->IgnoreParens());
633 if (!Decl1 && !Literal1) {
634 if (BO1 == BO_GT)
635 BO1 = BO_LT;
636 else if (BO1 == BO_GE)
637 BO1 = BO_LE;
638 else if (BO1 == BO_LT)
639 BO1 = BO_GT;
640 else if (BO1 == BO_LE)
641 BO1 = BO_GE;
642 Decl1 = dyn_cast<DeclRefExpr>(LHS->getRHS()->IgnoreParenImpCasts());
643 Literal1 = dyn_cast<IntegerLiteral>(LHS->getLHS()->IgnoreParens());
644 }
645
646 if (!Decl1 || !Literal1)
647 return TryResult();
648
649 BinaryOperatorKind BO2 = RHS->getOpcode();
650 const DeclRefExpr *Decl2 =
651 dyn_cast<DeclRefExpr>(RHS->getLHS()->IgnoreParenImpCasts());
652 const IntegerLiteral *Literal2 =
653 dyn_cast<IntegerLiteral>(RHS->getRHS()->IgnoreParens());
654 if (!Decl2 && !Literal2) {
655 if (BO2 == BO_GT)
656 BO2 = BO_LT;
657 else if (BO2 == BO_GE)
658 BO2 = BO_LE;
659 else if (BO2 == BO_LT)
660 BO2 = BO_GT;
661 else if (BO2 == BO_LE)
662 BO2 = BO_GE;
663 Decl2 = dyn_cast<DeclRefExpr>(RHS->getRHS()->IgnoreParenImpCasts());
664 Literal2 = dyn_cast<IntegerLiteral>(RHS->getLHS()->IgnoreParens());
665 }
666
667 if (!Decl2 || !Literal2)
668 return TryResult();
669
670 // Check that it is the same variable on both sides.
671 if (Decl1->getDecl() != Decl2->getDecl())
672 return TryResult();
673
674 llvm::APSInt L1, L2;
675
676 if (!Literal1->EvaluateAsInt(L1, *Context) ||
677 !Literal2->EvaluateAsInt(L2, *Context))
678 return TryResult();
679
680 // Can't compare signed with unsigned or with different bit width.
681 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
682 return TryResult();
683
684 // Values that will be used to determine if result of logical
685 // operator is always true/false
686 const llvm::APSInt Values[] = {
687 // Value less than both Value1 and Value2
688 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
689 // L1
690 L1,
691 // Value between Value1 and Value2
692 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
693 L1.isUnsigned()),
694 // L2
695 L2,
696 // Value greater than both Value1 and Value2
697 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
698 };
699
700 // Check whether expression is always true/false by evaluating the following
701 // * variable x is less than the smallest literal.
702 // * variable x is equal to the smallest literal.
703 // * Variable x is between smallest and largest literal.
704 // * Variable x is equal to the largest literal.
705 // * Variable x is greater than largest literal.
706 bool AlwaysTrue = true, AlwaysFalse = true;
707 for (unsigned int ValueIndex = 0;
708 ValueIndex < sizeof(Values) / sizeof(Values[0]);
709 ++ValueIndex) {
710 llvm::APSInt Value = Values[ValueIndex];
711 TryResult Res1, Res2;
712 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
713 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
714
715 if (!Res1.isKnown() || !Res2.isKnown())
716 return TryResult();
717
718 if (B->getOpcode() == BO_LAnd) {
719 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
720 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
721 } else {
722 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
723 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
724 }
725 }
726
727 if (AlwaysTrue || AlwaysFalse) {
728 if (BuildOpts.Observer)
729 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
730 return TryResult(AlwaysTrue);
731 }
732 return TryResult();
733 }
734
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000735 /// Try and evaluate an expression to an integer constant.
736 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
737 if (!BuildOpts.PruneTriviallyFalseEdges)
738 return false;
739 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +0000740 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +0000741 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000742 }
Mike Stump11289f42009-09-09 15:08:12 +0000743
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000744 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +0000745 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000746 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +0000747 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000748 S->isTypeDependent() || S->isValueDependent())
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000749 return TryResult();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000750
751 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
752 if (Bop->isLogicalOp()) {
753 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000754 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
755 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000756 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +0000757
758 // Retrieve result at first, or the map might be updated.
759 TryResult Result = evaluateAsBooleanConditionNoCache(S);
760 CachedBoolEvals[S] = Result; // update or insert
761 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000762 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +0000763 else {
764 switch (Bop->getOpcode()) {
765 default: break;
766 // For 'x & 0' and 'x * 0', we can determine that
767 // the value is always false.
768 case BO_Mul:
769 case BO_And: {
770 // If either operand is zero, we know the value
771 // must be false.
772 llvm::APSInt IntVal;
773 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
774 if (IntVal.getBoolValue() == false) {
775 return TryResult(false);
776 }
777 }
778 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
779 if (IntVal.getBoolValue() == false) {
780 return TryResult(false);
781 }
782 }
783 }
784 break;
785 }
786 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000787 }
788
789 return evaluateAsBooleanConditionNoCache(S);
790 }
791
792 /// \brief Evaluate as boolean \param E without using the cache.
793 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
794 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
795 if (Bop->isLogicalOp()) {
796 TryResult LHS = tryEvaluateBool(Bop->getLHS());
797 if (LHS.isKnown()) {
798 // We were able to evaluate the LHS, see if we can get away with not
799 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
800 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
801 return LHS.isTrue();
802
803 TryResult RHS = tryEvaluateBool(Bop->getRHS());
804 if (RHS.isKnown()) {
805 if (Bop->getOpcode() == BO_LOr)
806 return LHS.isTrue() || RHS.isTrue();
807 else
808 return LHS.isTrue() && RHS.isTrue();
809 }
810 } else {
811 TryResult RHS = tryEvaluateBool(Bop->getRHS());
812 if (RHS.isKnown()) {
813 // We can't evaluate the LHS; however, sometimes the result
814 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
815 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
816 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +0000817 } else {
818 TryResult BopRes = checkIncorrectLogicOperator(Bop);
819 if (BopRes.isKnown())
820 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000821 }
822 }
823
824 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000825 } else if (Bop->isEqualityOp()) {
826 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
827 if (BopRes.isKnown())
828 return BopRes.isTrue();
829 } else if (Bop->isRelationalOp()) {
830 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
831 if (BopRes.isKnown())
832 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000833 }
834 }
835
836 bool Result;
837 if (E->EvaluateAsBooleanCondition(Result, *Context))
838 return Result;
839
840 return TryResult();
Mike Stump773582d2009-07-23 23:25:26 +0000841 }
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000842
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000843};
Mike Stump31feda52009-07-17 01:31:16 +0000844
Ted Kremeneka099c592011-03-10 03:50:34 +0000845inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
846 const Stmt *stmt) const {
847 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
848}
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000849
Ted Kremeneka099c592011-03-10 03:50:34 +0000850bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000851 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
852
Ted Kremeneka099c592011-03-10 03:50:34 +0000853 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +0000854 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000855
856 if (lastLookup == stmt) {
857 if (cachedEntry) {
858 assert(cachedEntry->first == stmt);
859 return true;
860 }
Ted Kremenek8b46c002011-07-19 14:18:43 +0000861 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000862 }
Ted Kremeneka099c592011-03-10 03:50:34 +0000863
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000864 lastLookup = stmt;
865
866 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +0000867 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
868
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000869 if (!fb) {
870 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +0000871 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +0000872 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000873 }
Ted Kremeneka099c592011-03-10 03:50:34 +0000874
875 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000876 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +0000877 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +0000878 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000879 }
880
Ted Kremeneka099c592011-03-10 03:50:34 +0000881 cachedEntry = &*itr;
882 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +0000883}
884
Douglas Gregor4619e432008-12-05 23:32:09 +0000885// FIXME: Add support for dependent-sized array types in C++?
886// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +0000887static const VariableArrayType *FindVA(const Type *t) {
888 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
889 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000890 if (vat->getSizeExpr())
891 return vat;
Mike Stump31feda52009-07-17 01:31:16 +0000892
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000893 t = vt->getElementType().getTypePtr();
894 }
Mike Stump31feda52009-07-17 01:31:16 +0000895
Craig Topper25542942014-05-20 04:30:07 +0000896 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000897}
Mike Stump31feda52009-07-17 01:31:16 +0000898
899/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
900/// arbitrary statement. Examples include a single expression or a function
901/// body (compound statement). The ownership of the returned CFG is
902/// transferred to the caller. If CFG construction fails, this method returns
903/// NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000904CFG* CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +0000905 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +0000906 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +0000907 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +0000908
Mike Stump31feda52009-07-17 01:31:16 +0000909 // Create an empty block that will serve as the exit block for the CFG. Since
910 // this is the first block added to the CFG, it will be implicitly registered
911 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +0000912 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000913 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +0000914 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +0000915
Marcin Swiderski20b88732010-10-05 05:37:00 +0000916 if (BuildOpts.AddImplicitDtors)
917 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
918 addImplicitDtorsForDestructor(DD);
919
Ted Kremenek9aae5132007-08-23 21:42:29 +0000920 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000921 CFGBlock *B = addStmt(Statement);
922
923 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +0000924 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000925
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000926 // For C++ constructor add initializers to CFG.
927 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
928 for (CXXConstructorDecl::init_const_reverse_iterator I = CD->init_rbegin(),
929 E = CD->init_rend(); I != E; ++I) {
930 B = addInitializer(*I);
931 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +0000932 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000933 }
934 }
935
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000936 if (B)
937 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +0000938
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000939 // Backpatch the gotos whose label -> block mappings we didn't know when we
940 // encountered them.
941 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
942 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +0000943
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000944 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +0000945 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000946 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +0000947
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000948 // If there is no target for the goto, then we are looking at an
949 // incomplete AST. Handle this by not registering a successor.
950 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +0000951
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000952 JumpTarget JT = LI->second;
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000953 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
954 JT.scopePosition);
955 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000956 }
957
958 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000959 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000960 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
961 E = AddressTakenLabels.end(); I != E; ++I ) {
962
963 // Lookup the target block.
964 LabelMapTy::iterator LI = LabelMap.find(*I);
965
966 // If there is no target block that contains label, then we are looking
967 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +0000968 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000969
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000970 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +0000971 }
Mike Stump31feda52009-07-17 01:31:16 +0000972
Mike Stump31feda52009-07-17 01:31:16 +0000973 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +0000974 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +0000975
Ahmed Charles9a16beb2014-03-07 19:33:25 +0000976 return cfg.release();
Ted Kremenek9aae5132007-08-23 21:42:29 +0000977}
Mike Stump31feda52009-07-17 01:31:16 +0000978
Ted Kremenek9aae5132007-08-23 21:42:29 +0000979/// createBlock - Used to lazily create blocks that are connected
980/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000981CFGBlock *CFGBuilder::createBlock(bool add_successor) {
982 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +0000983 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000984 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +0000985 return B;
986}
Mike Stump31feda52009-07-17 01:31:16 +0000987
Chandler Carrutha70991b2011-09-13 09:13:49 +0000988/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
989/// CFG. It is *not* connected to the current (global) successor, and instead
990/// directly tied to the exit block in order to be reachable.
991CFGBlock *CFGBuilder::createNoReturnBlock() {
992 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +0000993 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +0000994 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000995 return B;
996}
997
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000998/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +0000999CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001000 if (!BuildOpts.AddInitializers)
1001 return Block;
1002
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001003 bool IsReference = false;
1004 bool HasTemporaries = false;
1005
1006 // Destructors of temporaries in initialization expression should be called
1007 // after initialization finishes.
1008 Expr *Init = I->getInit();
1009 if (Init) {
Francois Pichetd583da02010-12-04 09:14:42 +00001010 if (FieldDecl *FD = I->getAnyMember())
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001011 IsReference = FD->getType()->isReferenceType();
John McCall5d413782010-12-06 08:20:24 +00001012 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001013
Jordan Rose6d671cc2012-09-05 22:55:23 +00001014 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001015 // Generate destructors for temporaries in initialization expression.
John McCall5d413782010-12-06 08:20:24 +00001016 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001017 IsReference);
1018 }
1019 }
1020
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001021 autoCreateBlock();
1022 appendInitializer(Block, I);
1023
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001024 if (Init) {
Ted Kremenek8219b822010-12-16 07:46:53 +00001025 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001026 // For expression with temporaries go directly to subexpression to omit
1027 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001028 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1029 }
1030 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001031 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001032
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001033 return Block;
1034}
1035
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001036/// \brief Retrieve the type of the temporary object whose lifetime was
1037/// extended by a local reference with the given initializer.
1038static QualType getReferenceInitTemporaryType(ASTContext &Context,
1039 const Expr *Init) {
1040 while (true) {
1041 // Skip parentheses.
1042 Init = Init->IgnoreParens();
1043
1044 // Skip through cleanups.
1045 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1046 Init = EWC->getSubExpr();
1047 continue;
1048 }
1049
1050 // Skip through the temporary-materialization expression.
1051 if (const MaterializeTemporaryExpr *MTE
1052 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1053 Init = MTE->GetTemporaryExpr();
1054 continue;
1055 }
1056
1057 // Skip derived-to-base and no-op casts.
1058 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) {
1059 if ((CE->getCastKind() == CK_DerivedToBase ||
1060 CE->getCastKind() == CK_UncheckedDerivedToBase ||
1061 CE->getCastKind() == CK_NoOp) &&
1062 Init->getType()->isRecordType()) {
1063 Init = CE->getSubExpr();
1064 continue;
1065 }
1066 }
1067
1068 // Skip member accesses into rvalues.
1069 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) {
1070 if (!ME->isArrow() && ME->getBase()->isRValue()) {
1071 Init = ME->getBase();
1072 continue;
1073 }
1074 }
1075
1076 break;
1077 }
1078
1079 return Init->getType();
1080}
1081
Marcin Swiderski5e415732010-09-30 23:05:00 +00001082/// addAutomaticObjDtors - Add to current block automatic objects destructors
1083/// for objects in range of local scope positions. Use S as trigger statement
1084/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001085void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001086 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001087 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001088 return;
1089
Marcin Swiderski5e415732010-09-30 23:05:00 +00001090 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001091 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001092
Chandler Carruthad747252011-09-13 06:09:01 +00001093 // We need to append the destructors in reverse order, but any one of them
1094 // may be a no-return destructor which changes the CFG. As a result, buffer
1095 // this sequence up and replay them in reverse order when appending onto the
1096 // CFGBlock(s).
1097 SmallVector<VarDecl*, 10> Decls;
1098 Decls.reserve(B.distance(E));
1099 for (LocalScope::const_iterator I = B; I != E; ++I)
1100 Decls.push_back(*I);
1101
1102 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1103 E = Decls.rend();
1104 I != E; ++I) {
1105 // If this destructor is marked as a no-return destructor, we need to
1106 // create a new block for the destructor which does not have as a successor
1107 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001108 QualType Ty = (*I)->getType();
1109 if (Ty->isReferenceType()) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001110 Ty = getReferenceInitTemporaryType(*Context, (*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001111 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001112 Ty = Context->getBaseElementType(Ty);
1113
Chandler Carruthad747252011-09-13 06:09:01 +00001114 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
Richard Smith10876ef2013-01-17 01:30:42 +00001115 if (Dtor->isNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001116 Block = createNoReturnBlock();
1117 else
Chandler Carruthad747252011-09-13 06:09:01 +00001118 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001119
1120 appendAutomaticObjDtor(Block, *I, S);
1121 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001122}
1123
Marcin Swiderski20b88732010-10-05 05:37:00 +00001124/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1125/// base and member objects in destructor.
1126void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
1127 assert (BuildOpts.AddImplicitDtors
1128 && "Can be called only when dtors should be added");
1129 const CXXRecordDecl *RD = DD->getParent();
1130
1131 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001132 for (const auto &VI : RD->vbases()) {
1133 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001134 if (!CD->hasTrivialDestructor()) {
1135 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001136 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001137 }
1138 }
1139
1140 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001141 for (const auto &BI : RD->bases()) {
1142 if (!BI.isVirtual()) {
1143 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001144 if (!CD->hasTrivialDestructor()) {
1145 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001146 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001147 }
1148 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001149 }
1150
1151 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001152 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001153 // Check for constant size array. Set type to array element type.
1154 QualType QT = FI->getType();
1155 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1156 if (AT->getSize() == 0)
1157 continue;
1158 QT = AT->getElementType();
1159 }
1160
1161 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001162 if (!CD->hasTrivialDestructor()) {
1163 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001164 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001165 }
1166 }
1167}
1168
Marcin Swiderski5e415732010-09-30 23:05:00 +00001169/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1170/// way return valid LocalScope object.
1171LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
1172 if (!Scope) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +00001173 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1174 Scope = alloc.Allocate<LocalScope>();
1175 BumpVectorContext ctx(alloc);
1176 new (Scope) LocalScope(ctx, ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001177 }
1178 return Scope;
1179}
1180
1181/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +00001182/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001183void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001184 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001185 return;
1186
Craig Topper25542942014-05-20 04:30:07 +00001187 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001188
1189 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001190 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001191 for (auto *BI : CS->body()) {
1192 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001193 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001194 Scope = addLocalScopeForDeclStmt(DS, Scope);
1195 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001196 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001197 }
1198
1199 // For any other statement scope will be implicit and as such will be
1200 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001201 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001202 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001203}
1204
1205/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1206/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001207LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001208 LocalScope* Scope) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001209 if (!BuildOpts.AddImplicitDtors)
1210 return Scope;
1211
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001212 for (auto *DI : DS->decls())
1213 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001214 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001215 return Scope;
1216}
1217
1218/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1219/// create add scope for automatic objects and temporary objects bound to
1220/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001221LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001222 LocalScope* Scope) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001223 if (!BuildOpts.AddImplicitDtors)
1224 return Scope;
1225
1226 // Check if variable is local.
1227 switch (VD->getStorageClass()) {
1228 case SC_None:
1229 case SC_Auto:
1230 case SC_Register:
1231 break;
1232 default: return Scope;
1233 }
1234
1235 // Check for const references bound to temporary. Set type to pointee.
1236 QualType QT = VD->getType();
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001237 if (QT.getTypePtr()->isReferenceType()) {
Richard Smith5a0ef782013-06-27 21:43:17 +00001238 // Attempt to determine whether this declaration lifetime-extends a
1239 // temporary.
1240 //
1241 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1242 // temporaries, and a single declaration can extend multiple temporaries.
1243 // We should look at the storage duration on each nested
1244 // MaterializeTemporaryExpr instead.
1245 const Expr *Init = VD->getInit();
1246 if (!Init)
1247 return Scope;
1248 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init))
1249 Init = EWC->getSubExpr();
1250 if (!isa<MaterializeTemporaryExpr>(Init))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001251 return Scope;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001252
Richard Smith5a0ef782013-06-27 21:43:17 +00001253 // Lifetime-extending a temporary.
1254 QT = getReferenceInitTemporaryType(*Context, Init);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001255 }
1256
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001257 // Check for constant size array. Set type to array element type.
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001258 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001259 if (AT->getSize() == 0)
1260 return Scope;
1261 QT = AT->getElementType();
1262 }
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001263
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001264 // Check if type is a C++ class with non-trivial destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001265 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
David Blaikie0f2ae782012-01-24 04:51:48 +00001266 if (!CD->hasTrivialDestructor()) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001267 // Add the variable to scope
1268 Scope = createOrReuseLocalScope(Scope);
1269 Scope->addVar(VD);
1270 ScopePos = Scope->begin();
1271 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001272 return Scope;
1273}
1274
1275/// addLocalScopeAndDtors - For given statement add local scope for it and
1276/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001277void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001278 if (!BuildOpts.AddImplicitDtors)
1279 return;
1280
1281 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001282 addLocalScopeForStmt(S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001283 addAutomaticObjDtors(ScopePos, scopeBeginPos, S);
1284}
1285
Marcin Swiderski321a7072010-09-30 22:54:37 +00001286/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1287/// variables with automatic storage duration to CFGBlock's elements vector.
1288/// Elements will be prepended to physical beginning of the vector which
1289/// happens to be logical end. Use blocks terminator as statement that specifies
1290/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001291/// FIXME: This mechanism for adding automatic destructors doesn't handle
1292/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001293void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001294 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Chandler Carruthad747252011-09-13 06:09:01 +00001295 BumpVectorContext &C = cfg->getBumpVectorContext();
1296 CFGBlock::iterator InsertPos
1297 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1298 for (LocalScope::const_iterator I = B; I != E; ++I)
1299 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1300 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001301}
1302
Ted Kremenek93668002009-07-17 22:18:43 +00001303/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001304/// blocks for ternary operators, &&, and ||. We also process "," and
1305/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001306CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001307 if (!S) {
1308 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001309 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001310 }
Jordy Rose17347372011-06-10 08:49:37 +00001311
1312 if (Expr *E = dyn_cast<Expr>(S))
1313 S = E->IgnoreParens();
1314
Ted Kremenek93668002009-07-17 22:18:43 +00001315 switch (S->getStmtClass()) {
1316 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001317 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001318
1319 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001320 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001321
John McCallc07a0c72011-02-17 10:25:35 +00001322 case Stmt::BinaryConditionalOperatorClass:
1323 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1324
Ted Kremenek93668002009-07-17 22:18:43 +00001325 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001326 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001327
Ted Kremenek93668002009-07-17 22:18:43 +00001328 case Stmt::BlockExprClass:
Ted Kremeneke2499842012-04-12 20:03:44 +00001329 return VisitNoRecurse(cast<Expr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001330
Ted Kremenek93668002009-07-17 22:18:43 +00001331 case Stmt::BreakStmtClass:
1332 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001333
Ted Kremenek93668002009-07-17 22:18:43 +00001334 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001335 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001336 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001337 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001338 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001339
Ted Kremenek93668002009-07-17 22:18:43 +00001340 case Stmt::CaseStmtClass:
1341 return VisitCaseStmt(cast<CaseStmt>(S));
1342
1343 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001344 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001345
Ted Kremenek93668002009-07-17 22:18:43 +00001346 case Stmt::CompoundStmtClass:
1347 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001348
Ted Kremenek93668002009-07-17 22:18:43 +00001349 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001350 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001351
Ted Kremenek93668002009-07-17 22:18:43 +00001352 case Stmt::ContinueStmtClass:
1353 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001354
Ted Kremenekb27378c2010-01-19 20:40:33 +00001355 case Stmt::CXXCatchStmtClass:
1356 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1357
John McCall5d413782010-12-06 08:20:24 +00001358 case Stmt::ExprWithCleanupsClass:
1359 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001360
Jordan Rosee5d53932012-08-23 18:10:53 +00001361 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001362 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001363 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1364 // called function's declaration, not by the caller. If we simply add
1365 // this expression to the CFG, we could end up with the same Expr
1366 // appearing multiple times.
1367 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001368 //
1369 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1370 // expression to be used in the same function (through aggregate
1371 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00001372 return VisitStmt(S, asc);
1373
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001374 case Stmt::CXXBindTemporaryExprClass:
1375 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
1376
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001377 case Stmt::CXXConstructExprClass:
1378 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
1379
Jordan Rosec9176072014-01-13 17:59:19 +00001380 case Stmt::CXXNewExprClass:
1381 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
1382
Jordan Rosed2f40792013-09-03 17:00:57 +00001383 case Stmt::CXXDeleteExprClass:
1384 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
1385
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001386 case Stmt::CXXFunctionalCastExprClass:
1387 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
1388
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001389 case Stmt::CXXTemporaryObjectExprClass:
1390 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
1391
Ted Kremenekb27378c2010-01-19 20:40:33 +00001392 case Stmt::CXXThrowExprClass:
1393 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001394
Ted Kremenekb27378c2010-01-19 20:40:33 +00001395 case Stmt::CXXTryStmtClass:
1396 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001397
Richard Smith02e85f32011-04-14 22:09:26 +00001398 case Stmt::CXXForRangeStmtClass:
1399 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
1400
Ted Kremenek93668002009-07-17 22:18:43 +00001401 case Stmt::DeclStmtClass:
1402 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001403
Ted Kremenek93668002009-07-17 22:18:43 +00001404 case Stmt::DefaultStmtClass:
1405 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001406
Ted Kremenek93668002009-07-17 22:18:43 +00001407 case Stmt::DoStmtClass:
1408 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001409
Ted Kremenek93668002009-07-17 22:18:43 +00001410 case Stmt::ForStmtClass:
1411 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001412
Ted Kremenek93668002009-07-17 22:18:43 +00001413 case Stmt::GotoStmtClass:
1414 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001415
Ted Kremenek93668002009-07-17 22:18:43 +00001416 case Stmt::IfStmtClass:
1417 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001418
Ted Kremenek8219b822010-12-16 07:46:53 +00001419 case Stmt::ImplicitCastExprClass:
1420 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001421
Ted Kremenek93668002009-07-17 22:18:43 +00001422 case Stmt::IndirectGotoStmtClass:
1423 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001424
Ted Kremenek93668002009-07-17 22:18:43 +00001425 case Stmt::LabelStmtClass:
1426 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001427
Ted Kremenekda76a942012-04-12 20:34:52 +00001428 case Stmt::LambdaExprClass:
1429 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
1430
Ted Kremenek5868ec62010-04-11 17:02:10 +00001431 case Stmt::MemberExprClass:
1432 return VisitMemberExpr(cast<MemberExpr>(S), asc);
1433
Ted Kremenek04268232011-11-05 00:10:15 +00001434 case Stmt::NullStmtClass:
1435 return Block;
1436
Ted Kremenek93668002009-07-17 22:18:43 +00001437 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00001438 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
1439
Ted Kremenek5022f1d2012-03-06 23:40:47 +00001440 case Stmt::ObjCAutoreleasePoolStmtClass:
1441 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
1442
Ted Kremenek93668002009-07-17 22:18:43 +00001443 case Stmt::ObjCAtSynchronizedStmtClass:
1444 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001445
Ted Kremenek93668002009-07-17 22:18:43 +00001446 case Stmt::ObjCAtThrowStmtClass:
1447 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001448
Ted Kremenek93668002009-07-17 22:18:43 +00001449 case Stmt::ObjCAtTryStmtClass:
1450 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001451
Ted Kremenek93668002009-07-17 22:18:43 +00001452 case Stmt::ObjCForCollectionStmtClass:
1453 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001454
Ted Kremenek04268232011-11-05 00:10:15 +00001455 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00001456 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00001457
John McCallfe96e0b2011-11-06 09:01:30 +00001458 case Stmt::PseudoObjectExprClass:
1459 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
1460
Ted Kremenek93668002009-07-17 22:18:43 +00001461 case Stmt::ReturnStmtClass:
1462 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001463
Peter Collingbournee190dee2011-03-11 19:24:49 +00001464 case Stmt::UnaryExprOrTypeTraitExprClass:
1465 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
1466 asc);
Mike Stump11289f42009-09-09 15:08:12 +00001467
Ted Kremenek93668002009-07-17 22:18:43 +00001468 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001469 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001470
Ted Kremenek93668002009-07-17 22:18:43 +00001471 case Stmt::SwitchStmtClass:
1472 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001473
Zhanyong Wan6dace612010-11-22 08:45:56 +00001474 case Stmt::UnaryOperatorClass:
1475 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
1476
Ted Kremenek93668002009-07-17 22:18:43 +00001477 case Stmt::WhileStmtClass:
1478 return VisitWhileStmt(cast<WhileStmt>(S));
1479 }
1480}
Mike Stump11289f42009-09-09 15:08:12 +00001481
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001482CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001483 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001484 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001485 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00001486 }
Mike Stump11289f42009-09-09 15:08:12 +00001487
Ted Kremenek93668002009-07-17 22:18:43 +00001488 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00001489}
Mike Stump31feda52009-07-17 01:31:16 +00001490
Ted Kremenek93668002009-07-17 22:18:43 +00001491/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00001492CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
1493 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00001494
Ted Kremenek8ae67872013-02-05 22:00:19 +00001495 // Visit the children in their reverse order so that they appear in
1496 // left-to-right (natural) order in the CFG.
1497 reverse_children RChildren(S);
1498 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
1499 I != E; ++I) {
1500 if (Stmt *Child = *I)
1501 if (CFGBlock *R = Visit(Child))
1502 B = R;
1503 }
1504 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00001505}
Mike Stump11289f42009-09-09 15:08:12 +00001506
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001507CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
1508 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00001509 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00001510
Ted Kremenek7c58d352011-03-10 01:14:11 +00001511 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001512 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001513 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00001514 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001515
Ted Kremenek9aae5132007-08-23 21:42:29 +00001516 return Block;
1517}
Mike Stump11289f42009-09-09 15:08:12 +00001518
Zhanyong Wan6dace612010-11-22 08:45:56 +00001519CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00001520 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001521 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00001522 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001523 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00001524 }
1525
Ted Kremenek8219b822010-12-16 07:46:53 +00001526 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00001527}
1528
Ted Kremeneka16436f2012-07-14 05:04:06 +00001529CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
1530 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
1531 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00001532
Ted Kremeneka16436f2012-07-14 05:04:06 +00001533 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001534 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00001535
Craig Topper25542942014-05-20 04:30:07 +00001536 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
1537 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00001538}
1539
1540std::pair<CFGBlock*, CFGBlock*>
1541CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
1542 Stmt *Term,
1543 CFGBlock *TrueBlock,
1544 CFGBlock *FalseBlock) {
1545
1546 // Introspect the RHS. If it is a nested logical operation, we recursively
1547 // build the CFG using this function. Otherwise, resort to default
1548 // CFG construction behavior.
1549 Expr *RHS = B->getRHS()->IgnoreParens();
1550 CFGBlock *RHSBlock, *ExitBlock;
1551
1552 do {
1553 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
1554 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001555 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00001556 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
1557 break;
1558 }
1559
1560 // The RHS is not a nested logical operation. Don't push the terminator
1561 // down further, but instead visit RHS and construct the respective
1562 // pieces of the CFG, and link up the RHSBlock with the terminator
1563 // we have been provided.
1564 ExitBlock = RHSBlock = createBlock(false);
1565
1566 if (!Term) {
1567 assert(TrueBlock == FalseBlock);
1568 addSuccessor(RHSBlock, TrueBlock);
1569 }
1570 else {
1571 RHSBlock->setTerminator(Term);
1572 TryResult KnownVal = tryEvaluateBool(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001573 if (!KnownVal.isKnown())
1574 KnownVal = tryEvaluateBool(B);
Ted Kremenek782f0032014-03-07 02:25:53 +00001575 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
1576 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00001577 }
1578
1579 Block = RHSBlock;
1580 RHSBlock = addStmt(RHS);
1581 }
1582 while (false);
1583
1584 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001585 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00001586
1587 // Generate the blocks for evaluating the LHS.
1588 Expr *LHS = B->getLHS()->IgnoreParens();
1589
1590 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
1591 if (B_LHS->isLogicalOp()) {
1592 if (B->getOpcode() == BO_LOr)
1593 FalseBlock = RHSBlock;
1594 else
1595 TrueBlock = RHSBlock;
1596
1597 // For the LHS, treat 'B' as the terminator that we want to sink
1598 // into the nested branch. The RHS always gets the top-most
1599 // terminator.
1600 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
1601 }
1602
1603 // Create the block evaluating the LHS.
1604 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00001605 CFGBlock *LHSBlock = createBlock(false);
1606 LHSBlock->setTerminator(B);
1607
Ted Kremeneka16436f2012-07-14 05:04:06 +00001608 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00001609 CFGBlock *EntryLHSBlock = addStmt(LHS);
1610
1611 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001612 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001613
1614 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00001615 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001616
1617 // Now link the LHSBlock with RHSBlock.
1618 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00001619 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
1620 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00001621 } else {
1622 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00001623 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
1624 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00001625 }
1626
Ted Kremenekb50e7162012-07-14 05:04:10 +00001627 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001628}
1629
Ted Kremenekb50e7162012-07-14 05:04:10 +00001630
Ted Kremeneka16436f2012-07-14 05:04:06 +00001631CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
1632 AddStmtChoice asc) {
1633 // && or ||
1634 if (B->isLogicalOp())
1635 return VisitLogicalOperator(B);
1636
Zhanyong Wan59f09c72010-11-22 19:32:14 +00001637 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00001638 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001639 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00001640 addStmt(B->getRHS());
1641 return addStmt(B->getLHS());
1642 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00001643
1644 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001645 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001646 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001647 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001648 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001649 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00001650 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001651 }
Mike Stump11289f42009-09-09 15:08:12 +00001652
Ted Kremenek7c58d352011-03-10 01:14:11 +00001653 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00001654 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001655 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00001656 }
1657
Zhongxing Xud95ccd52010-10-27 03:23:10 +00001658 CFGBlock *RBlock = Visit(B->getRHS());
1659 CFGBlock *LBlock = Visit(B->getLHS());
1660 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
1661 // containing a DoStmt, and the LHS doesn't create a new block, then we should
1662 // return RBlock. Otherwise we'll incorrectly return NULL.
1663 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00001664}
1665
Ted Kremeneke2499842012-04-12 20:03:44 +00001666CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001667 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00001668 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001669 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00001670 }
1671 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001672}
1673
Ted Kremenek93668002009-07-17 22:18:43 +00001674CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
1675 // "break" is a control-flow statement. Thus we stop processing the current
1676 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001677 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001678 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001679
Ted Kremenek93668002009-07-17 22:18:43 +00001680 // Now create a new block that ends with the break statement.
1681 Block = createBlock(false);
1682 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00001683
Ted Kremenek93668002009-07-17 22:18:43 +00001684 // If there is no target for the break, then we are looking at an incomplete
1685 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001686 if (BreakJumpTarget.block) {
1687 addAutomaticObjDtors(ScopePos, BreakJumpTarget.scopePosition, B);
1688 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001689 } else
Ted Kremenek93668002009-07-17 22:18:43 +00001690 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00001691
1692
Ted Kremenek9aae5132007-08-23 21:42:29 +00001693 return Block;
1694}
Mike Stump11289f42009-09-09 15:08:12 +00001695
Sebastian Redl31ad7542011-03-13 17:09:40 +00001696static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00001697 QualType Ty = E->getType();
1698 if (Ty->isFunctionPointerType())
1699 Ty = Ty->getAs<PointerType>()->getPointeeType();
1700 else if (Ty->isBlockPointerType())
1701 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001702
Mike Stump04c68512010-01-21 15:20:48 +00001703 const FunctionType *FT = Ty->getAs<FunctionType>();
1704 if (FT) {
1705 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00001706 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smithf623c962012-04-17 00:58:00 +00001707 Proto->isNothrow(Ctx))
Mike Stump04c68512010-01-21 15:20:48 +00001708 return false;
1709 }
1710 return true;
1711}
1712
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001713CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00001714 // Compute the callee type.
1715 QualType calleeType = C->getCallee()->getType();
1716 if (calleeType == Context->BoundMemberTy) {
1717 QualType boundType = Expr::findBoundMemberType(C->getCallee());
1718
1719 // We should only get a null bound type if processing a dependent
1720 // CFG. Recover by assuming nothing.
1721 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00001722 }
Mike Stump8c5d7992009-07-25 21:26:53 +00001723
John McCallc67067f2011-05-11 07:19:11 +00001724 // If this is a call to a no-return function, this stops the block here.
1725 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
1726
Mike Stump04c68512010-01-21 15:20:48 +00001727 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00001728
1729 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001730 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00001731 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00001732 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00001733 }
1734
Jordan Rose5374c072013-08-19 16:27:28 +00001735 // If this is a call to a builtin function, it might not actually evaluate
1736 // its arguments. Don't add them to the CFG if this is the case.
1737 bool OmitArguments = false;
1738
Mike Stump92244b02010-01-19 22:00:14 +00001739 if (FunctionDecl *FD = C->getDirectCallee()) {
Richard Smith10876ef2013-01-17 01:30:42 +00001740 if (FD->isNoReturn())
Mike Stump8c5d7992009-07-25 21:26:53 +00001741 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00001742 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00001743 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00001744 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
1745 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00001746 }
Mike Stump8c5d7992009-07-25 21:26:53 +00001747
Sebastian Redl31ad7542011-03-13 17:09:40 +00001748 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00001749 AddEHEdge = false;
1750
Jordan Rose5374c072013-08-19 16:27:28 +00001751 if (OmitArguments) {
1752 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
1753 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
1754 autoCreateBlock();
1755 appendStmt(Block, C);
1756 return Visit(C->getCallee());
1757 }
1758
1759 if (!NoReturn && !AddEHEdge) {
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001760 return VisitStmt(C, asc.withAlwaysAdd(true));
Jordan Rose5374c072013-08-19 16:27:28 +00001761 }
Mike Stump11289f42009-09-09 15:08:12 +00001762
Mike Stump92244b02010-01-19 22:00:14 +00001763 if (Block) {
1764 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001765 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001766 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00001767 }
Mike Stump11289f42009-09-09 15:08:12 +00001768
Chandler Carrutha70991b2011-09-13 09:13:49 +00001769 if (NoReturn)
1770 Block = createNoReturnBlock();
1771 else
1772 Block = createBlock();
1773
Ted Kremenek2866bab2011-03-10 01:14:08 +00001774 appendStmt(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00001775
Mike Stump04c68512010-01-21 15:20:48 +00001776 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00001777 // Add exceptional edges.
1778 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001779 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00001780 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001781 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00001782 }
Mike Stump11289f42009-09-09 15:08:12 +00001783
Mike Stump8c5d7992009-07-25 21:26:53 +00001784 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00001785}
Ted Kremenek9aae5132007-08-23 21:42:29 +00001786
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001787CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
1788 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001789 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001790 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001791 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001792 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001793
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001794 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00001795 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001796 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001797 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001798 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001799 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001800
Ted Kremenek21822592009-07-17 18:20:32 +00001801 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001802 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001803 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001804 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001805 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001806
Ted Kremenek21822592009-07-17 18:20:32 +00001807 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00001808 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001809 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00001810 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
1811 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00001812 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00001813 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00001814}
Mike Stump11289f42009-09-09 15:08:12 +00001815
1816
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001817CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Marcin Swiderski667ffec2010-10-01 00:23:17 +00001818 addLocalScopeAndDtors(C);
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001819 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001820
1821 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
1822 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00001823 // If we hit a segment of code just containing ';' (NullStmts), we can
1824 // get a null block back. In such cases, just use the LastBlock
1825 if (CFGBlock *newBlock = addStmt(*I))
1826 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00001827
Ted Kremenekce499c22009-08-27 23:16:26 +00001828 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001829 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001830 }
Mike Stump92244b02010-01-19 22:00:14 +00001831
Ted Kremenek93668002009-07-17 22:18:43 +00001832 return LastBlock;
1833}
Mike Stump11289f42009-09-09 15:08:12 +00001834
John McCallc07a0c72011-02-17 10:25:35 +00001835CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001836 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00001837 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00001838 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00001839
Ted Kremenek51d40b02009-07-17 18:15:54 +00001840 // Create the confluence block that will "merge" the results of the ternary
1841 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001842 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001843 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001844 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001845 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001846
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001847 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00001848
Ted Kremenek51d40b02009-07-17 18:15:54 +00001849 // Create a block for the LHS expression if there is an LHS expression. A
1850 // GCC extension allows LHS to be NULL, causing the condition to be the
1851 // value that is returned instead.
1852 // e.g: x ?: y is shorthand for: x ? x : y;
1853 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001854 Block = nullptr;
1855 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00001856 const Expr *trueExpr = C->getTrueExpr();
1857 if (trueExpr != opaqueValue) {
1858 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001859 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001860 return nullptr;
1861 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00001862 }
Ted Kremenekd8138012011-02-24 03:09:15 +00001863 else
1864 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00001865
Ted Kremenek51d40b02009-07-17 18:15:54 +00001866 // Create the block for the RHS expression.
1867 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001868 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001869 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001870 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001871
Richard Smithf676e452012-07-24 21:02:14 +00001872 // If the condition is a logical '&&' or '||', build a more accurate CFG.
1873 if (BinaryOperator *Cond =
1874 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
1875 if (Cond->isLogicalOp())
1876 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
1877
Ted Kremenek51d40b02009-07-17 18:15:54 +00001878 // Create the block that will contain the condition.
1879 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00001880
Mike Stump773582d2009-07-23 23:25:26 +00001881 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001882 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00001883 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
1884 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00001885 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00001886 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00001887
Ted Kremenekd8138012011-02-24 03:09:15 +00001888 if (opaqueValue) {
1889 // Run the condition expression if it's not trivially expressed in
1890 // terms of the opaque value (or if there is no opaque value).
1891 if (condExpr != opaqueValue)
1892 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00001893
Ted Kremenekd8138012011-02-24 03:09:15 +00001894 // Before that, run the common subexpression if there was one.
1895 // At least one of this or the above will be run.
1896 return addStmt(BCO->getCommon());
1897 }
1898
1899 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00001900}
1901
Ted Kremenek93668002009-07-17 22:18:43 +00001902CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00001903 // Check if the Decl is for an __label__. If so, elide it from the
1904 // CFG entirely.
1905 if (isa<LabelDecl>(*DS->decl_begin()))
1906 return Block;
1907
Ted Kremenek3a601142011-05-24 20:41:31 +00001908 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001909 if (DS->isSingleDecl())
1910 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00001911
Craig Topper25542942014-05-20 04:30:07 +00001912 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001913
Jordan Rose8c6c8a92012-07-20 18:50:48 +00001914 // Build an individual DeclStmt for each decl.
1915 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
1916 E = DS->decl_rend();
1917 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00001918 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
1919 unsigned A = llvm::AlignOf<DeclStmt>::Alignment < 8
1920 ? 8 : llvm::AlignOf<DeclStmt>::Alignment;
Mike Stump11289f42009-09-09 15:08:12 +00001921
Ted Kremenek93668002009-07-17 22:18:43 +00001922 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
1923 // automatically freed with the CFG.
1924 DeclGroupRef DG(*I);
1925 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00001926 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00001927 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00001928 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00001929
Ted Kremenek93668002009-07-17 22:18:43 +00001930 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001931 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00001932 }
Mike Stump11289f42009-09-09 15:08:12 +00001933
1934 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00001935}
Mike Stump11289f42009-09-09 15:08:12 +00001936
Ted Kremenek93668002009-07-17 22:18:43 +00001937/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001938/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001939CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001940 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001941 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00001942
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001943 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00001944 // Of everything that can be declared in a DeclStmt, only VarDecls impact
1945 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00001946 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001947 }
Mike Stump11289f42009-09-09 15:08:12 +00001948
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001949 bool IsReference = false;
1950 bool HasTemporaries = false;
1951
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00001952 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00001953 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00001954
1955 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
1956 // For static variables, we need to create a branch to track
1957 // whether or not they are initialized.
1958 if (Block) {
1959 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00001960 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00001961 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001962 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00001963 }
1964 blockAfterStaticInit = Succ;
1965 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00001966
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001967 // Destructors of temporaries in initialization expression should be called
1968 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00001969 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001970 if (Init) {
1971 IsReference = VD->getType()->isReferenceType();
John McCall5d413782010-12-06 08:20:24 +00001972 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001973
Jordan Rose6d671cc2012-09-05 22:55:23 +00001974 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001975 // Generate destructors for temporaries in initialization expression.
John McCall5d413782010-12-06 08:20:24 +00001976 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001977 IsReference);
1978 }
1979 }
1980
1981 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00001982 appendStmt(Block, DS);
Ted Kremenek213d0532012-03-22 05:57:43 +00001983
1984 // Keep track of the last non-null block, as 'Block' can be nulled out
1985 // if the initializer expression is something like a 'while' in a
1986 // statement-expression.
1987 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00001988
Ted Kremenek93668002009-07-17 22:18:43 +00001989 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00001990 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001991 // For expression with temporaries go directly to subexpression to omit
1992 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00001993 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
1994 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
1995 LastBlock = newBlock;
1996 }
1997 else {
1998 if (CFGBlock *newBlock = Visit(Init))
1999 LastBlock = newBlock;
2000 }
Ted Kremenek93668002009-07-17 22:18:43 +00002001 }
Mike Stump11289f42009-09-09 15:08:12 +00002002
Ted Kremenek93668002009-07-17 22:18:43 +00002003 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002004 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002005 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002006 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2007 LastBlock = newBlock;
2008 }
Mike Stump11289f42009-09-09 15:08:12 +00002009
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002010 // Remove variable from local scope.
2011 if (ScopePos && VD == *ScopePos)
2012 ++ScopePos;
2013
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002014 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002015 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002016 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002017 Block = createBlock(false);
2018 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002019 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002020 addSuccessor(Block, B);
2021 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002022 }
2023
2024 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002025}
2026
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002027CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002028 // We may see an if statement in the middle of a basic block, or it may be the
2029 // first statement we are processing. In either case, we create a new basic
2030 // block. First, we create the blocks for the then...else statements, and
2031 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002032 // middle of a block, we stop processing that block. That block is then the
2033 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002034
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002035 // Save local scope position because in case of condition variable ScopePos
2036 // won't be restored when traversing AST.
2037 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2038
2039 // Create local scope for possible condition variable.
2040 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002041 if (VarDecl *VD = I->getConditionVariable()) {
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002042 LocalScope::const_iterator BeginScopePos = ScopePos;
2043 addLocalScopeForVarDecl(VD);
2044 addAutomaticObjDtors(ScopePos, BeginScopePos, I);
2045 }
2046
Chris Lattner57540c52011-04-15 05:22:18 +00002047 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002048 // block.
2049 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002050 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002051 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002052 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002053 }
Mike Stump31feda52009-07-17 01:31:16 +00002054
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002055 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002056 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002057
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002058 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002059 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002060
Ted Kremenek9aae5132007-08-23 21:42:29 +00002061 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002062 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002063 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002064
2065 // If branch is not a compound statement create implicit scope
2066 // and add destructors.
2067 if (!isa<CompoundStmt>(Else))
2068 addLocalScopeAndDtors(Else);
2069
Ted Kremenek93668002009-07-17 22:18:43 +00002070 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002071
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002072 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2073 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002074 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002075 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002076 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002077 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002078 }
Mike Stump31feda52009-07-17 01:31:16 +00002079
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002080 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002081 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002082 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002083 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002084 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002085 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002086 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002087
2088 // If branch is not a compound statement create implicit scope
2089 // and add destructors.
2090 if (!isa<CompoundStmt>(Then))
2091 addLocalScopeAndDtors(Then);
2092
Ted Kremenek93668002009-07-17 22:18:43 +00002093 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002094
Ted Kremenek1b379512009-04-01 03:52:47 +00002095 if (!ThenBlock) {
2096 // We can reach here if the "then" body has all NullStmts.
2097 // Create an empty block so we can distinguish between true and false
2098 // branches in path-sensitive analyses.
2099 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002100 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002101 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002102 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002103 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002104 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002105 }
2106
Ted Kremenekb50e7162012-07-14 05:04:10 +00002107 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2108 // having these handle the actual control-flow jump. Note that
2109 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2110 // we resort to the old control-flow behavior. This special handling
2111 // removes infeasible paths from the control-flow graph by having the
2112 // control-flow transfer of '&&' or '||' go directly into the then/else
2113 // blocks directly.
2114 if (!I->getConditionVariable())
Richard Smithf676e452012-07-24 21:02:14 +00002115 if (BinaryOperator *Cond =
2116 dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002117 if (Cond->isLogicalOp())
2118 return VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2119
Mike Stump31feda52009-07-17 01:31:16 +00002120 // Now create a new block containing the if statement.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002121 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002122
Ted Kremenek9aae5132007-08-23 21:42:29 +00002123 // Set the terminator of the new block to the If statement.
2124 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002125
Mike Stump773582d2009-07-23 23:25:26 +00002126 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002127 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00002128
Ted Kremenekf3898612014-02-27 00:24:03 +00002129 // Add the successors. If we know that specific branches are
2130 // unreachable, inform addSuccessor() of that knowledge.
2131 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2132 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump31feda52009-07-17 01:31:16 +00002133
2134 // Add the condition as the last statement in the new block. This may create
2135 // new blocks as the condition may contain control-flow. Any newly created
2136 // blocks will be pointed to be "Block".
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002137 CFGBlock *LastBlock = addStmt(I->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002138
Manuel Klimek75f34c12014-05-05 18:21:06 +00002139 // Finally, if the IfStmt contains a condition variable, add it and its
2140 // initializer to the CFG.
2141 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2142 autoCreateBlock();
2143 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002144 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002145
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002146 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002147}
Mike Stump31feda52009-07-17 01:31:16 +00002148
2149
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002150CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002151 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002152 //
Mike Stump31feda52009-07-17 01:31:16 +00002153 // NOTE: If a "return" appears in the middle of a block, this means that the
2154 // code afterwards is DEAD (unreachable). We still keep a basic block
2155 // for that code; a simple "mark-and-sweep" from the entry block will be
2156 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002157
2158 // Create the new block.
2159 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002160
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002161 addAutomaticObjDtors(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002162
2163 // If the one of the destructors does not return, we already have the Exit
2164 // block as a successor.
2165 if (!Block->hasNoReturnElement())
2166 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002167
2168 // Add the return statement to the block. This may create new blocks if R
2169 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002170 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002171}
2172
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002173CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002174 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002175 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002176 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002177
Ted Kremenek93668002009-07-17 22:18:43 +00002178 if (!LabelBlock) // This can happen when the body is empty, i.e.
2179 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002180
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002181 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2182 "label already in map");
2183 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002184
2185 // Labels partition blocks, so this is the end of the basic block we were
2186 // processing (L is the block's label). Because this is label (and we have
2187 // already processed the substatement) there is no extra control-flow to worry
2188 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002189 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002190 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002191 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002192
2193 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002194 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002195
Ted Kremenek9aae5132007-08-23 21:42:29 +00002196 // This block is now the implicit successor of other blocks.
2197 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002198
Ted Kremenek9aae5132007-08-23 21:42:29 +00002199 return LabelBlock;
2200}
2201
Ted Kremenekda76a942012-04-12 20:34:52 +00002202CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
2203 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2204 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
2205 et = E->capture_init_end(); it != et; ++it) {
2206 if (Expr *Init = *it) {
2207 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00002208 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00002209 LastBlock = Tmp;
2210 }
2211 }
2212 return LastBlock;
2213}
2214
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002215CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00002216 // Goto is a control-flow statement. Thus we stop processing the current
2217 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00002218
Ted Kremenek9aae5132007-08-23 21:42:29 +00002219 Block = createBlock(false);
2220 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00002221
2222 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002223 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00002224
Ted Kremenek9aae5132007-08-23 21:42:29 +00002225 if (I == LabelMap.end())
2226 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002227 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
2228 else {
2229 JumpTarget JT = I->second;
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002230 addAutomaticObjDtors(ScopePos, JT.scopePosition, G);
2231 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002232 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002233
Mike Stump31feda52009-07-17 01:31:16 +00002234 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002235}
2236
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002237CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00002238 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002239
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002240 // Save local scope position because in case of condition variable ScopePos
2241 // won't be restored when traversing AST.
2242 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2243
2244 // Create local scope for init statement and possible condition variable.
2245 // Add destructor for init statement and condition variable.
2246 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002247 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002248 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002249 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
2250
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002251 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002252 addLocalScopeForVarDecl(VD);
2253 LocalScope::const_iterator ContinueScopePos = ScopePos;
2254
2255 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), F);
2256
Mike Stump014b3ea2009-07-21 01:12:51 +00002257 // "for" is a control-flow statement. Thus we stop processing the current
2258 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002259 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002260 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002261 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002262 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002263 } else
2264 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002265
Ted Kremenek304a9532010-05-21 20:30:15 +00002266 // Save the current value for the break targets.
2267 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002268 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002269 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00002270
Craig Topper25542942014-05-20 04:30:07 +00002271 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00002272
Ted Kremenek9aae5132007-08-23 21:42:29 +00002273 // Now create the loop body.
2274 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002275 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002276
Ted Kremenekb50e7162012-07-14 05:04:10 +00002277 // Save the current values for Block, Succ, continue and break targets.
2278 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2279 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002280
Ted Kremenekb50e7162012-07-14 05:04:10 +00002281 // Create an empty block to represent the transition block for looping back
2282 // to the head of the loop. If we have increment code, it will
2283 // go in this block as well.
2284 Block = Succ = TransitionBlock = createBlock(false);
2285 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002286
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002287 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00002288 // Generate increment code in its own basic block. This is the target of
2289 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00002290 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00002291 }
Mike Stump31feda52009-07-17 01:31:16 +00002292
Ted Kremenek902393b2009-04-28 00:51:56 +00002293 // Finish up the increment (or empty) block if it hasn't been already.
2294 if (Block) {
2295 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002296 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002297 return nullptr;
2298 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00002299 }
Mike Stump31feda52009-07-17 01:31:16 +00002300
Ted Kremenekb50e7162012-07-14 05:04:10 +00002301 // The starting block for the loop increment is the block that should
2302 // represent the 'loop target' for looping back to the start of the loop.
2303 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
2304 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002305
Ted Kremenekb50e7162012-07-14 05:04:10 +00002306 // Loop body should end with destructor of Condition variable (if any).
2307 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00002308
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002309 // If body is not a compound statement create implicit scope
2310 // and add destructors.
2311 if (!isa<CompoundStmt>(F->getBody()))
2312 addLocalScopeAndDtors(F->getBody());
2313
Mike Stump31feda52009-07-17 01:31:16 +00002314 // Now populate the body block, and in the process create new blocks as we
2315 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002316 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00002317
Ted Kremenekb50e7162012-07-14 05:04:10 +00002318 if (!BodyBlock) {
2319 // In the case of "for (...;...;...);" we can have a null BodyBlock.
2320 // Use the continue jump target as the proxy for the body.
2321 BodyBlock = ContinueJumpTarget.block;
2322 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002323 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002324 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002325 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00002326
2327 // Because of short-circuit evaluation, the condition of the loop can span
2328 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2329 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00002330 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002331
Ted Kremenekb50e7162012-07-14 05:04:10 +00002332 do {
2333 Expr *C = F->getCond();
2334
2335 // Specially handle logical operators, which have a slightly
2336 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00002337 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00002338 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002339 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002340 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002341 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
2342 break;
2343 }
2344
2345 // The default case when not handling logical operators.
2346 EntryConditionBlock = ExitConditionBlock = createBlock(false);
2347 ExitConditionBlock->setTerminator(F);
2348
2349 // See if this is a known constant.
2350 TryResult KnownVal(true);
2351
2352 if (C) {
2353 // Now add the actual condition to the condition block.
2354 // Because the condition itself may contain control-flow, new blocks may
2355 // be created. Thus we update "Succ" after adding the condition.
2356 Block = ExitConditionBlock;
2357 EntryConditionBlock = addStmt(C);
2358
2359 // If this block contains a condition variable, add both the condition
2360 // variable and initializer to the CFG.
2361 if (VarDecl *VD = F->getConditionVariable()) {
2362 if (Expr *Init = VD->getInit()) {
2363 autoCreateBlock();
2364 appendStmt(Block, F->getConditionVariableDeclStmt());
2365 EntryConditionBlock = addStmt(Init);
2366 assert(Block == EntryConditionBlock);
2367 }
2368 }
2369
2370 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002371 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002372
2373 KnownVal = tryEvaluateBool(C);
2374 }
2375
2376 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00002377 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002378 // Link up the condition block with the code that follows the loop. (the
2379 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00002380 addSuccessor(ExitConditionBlock,
2381 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002382
2383 } while (false);
2384
2385 // Link up the loop-back block to the entry condition block.
2386 addSuccessor(TransitionBlock, EntryConditionBlock);
2387
2388 // The condition block is the implicit successor for any code above the loop.
2389 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002390
Ted Kremenek9aae5132007-08-23 21:42:29 +00002391 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00002392 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002393 if (Stmt *I = F->getInit()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002394 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00002395 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002396 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002397
2398 // There is no loop initialization. We are thus basically a while loop.
2399 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00002400 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002401 Succ = EntryConditionBlock;
2402 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002403}
2404
Ted Kremenek5868ec62010-04-11 17:02:10 +00002405CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002406 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00002407 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002408 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002409 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002410 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00002411}
2412
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002413CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00002414 // Objective-C fast enumeration 'for' statements:
2415 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
2416 //
2417 // for ( Type newVariable in collection_expression ) { statements }
2418 //
2419 // becomes:
2420 //
2421 // prologue:
2422 // 1. collection_expression
2423 // T. jump to loop_entry
2424 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002425 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00002426 // 1. ObjCForCollectionStmt [performs binding to newVariable]
2427 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
2428 // TB:
2429 // statements
2430 // T. jump to loop_entry
2431 // FB:
2432 // what comes after
2433 //
2434 // and
2435 //
2436 // Type existingItem;
2437 // for ( existingItem in expression ) { statements }
2438 //
2439 // becomes:
2440 //
Mike Stump31feda52009-07-17 01:31:16 +00002441 // the same with newVariable replaced with existingItem; the binding works
2442 // the same except that for one ObjCForCollectionStmt::getElement() returns
2443 // a DeclStmt and the other returns a DeclRefExpr.
Ted Kremenek9d56e642008-11-11 17:10:00 +00002444 //
Mike Stump31feda52009-07-17 01:31:16 +00002445
Craig Topper25542942014-05-20 04:30:07 +00002446 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002447
Ted Kremenek9d56e642008-11-11 17:10:00 +00002448 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002449 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002450 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00002451 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00002452 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00002453 } else
2454 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002455
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002456 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002457 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002458
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002459 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00002460 ExitConditionBlock->setTerminator(S);
2461
2462 // The last statement in the block should be the ObjCForCollectionStmt, which
2463 // performs the actual binding to 'element' and determines if there are any
2464 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00002465 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002466 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002467
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002468 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00002469 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00002470 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00002471 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
2472 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00002473 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002474 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002475 return nullptr;
2476 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002477 }
Mike Stump31feda52009-07-17 01:31:16 +00002478
2479 // The condition block is the implicit successor for the loop body as well as
2480 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002481 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002482
Ted Kremenek9d56e642008-11-11 17:10:00 +00002483 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00002484 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002485 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00002486 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002487 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00002488 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002489
Anna Zaks56b49752013-06-22 00:23:20 +00002490 // Add an intermediate block between the BodyBlock and the
2491 // EntryConditionBlock to represent the "loop back" transition, for looping
2492 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00002493 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00002494 Succ = LoopBackBlock = createBlock();
2495 LoopBackBlock->setLoopTarget(S);
2496
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002497 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00002498 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002499
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002500 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002501
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002502 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00002503 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00002504 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002505 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002506 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002507 }
Mike Stump31feda52009-07-17 01:31:16 +00002508
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002509 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002510 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002511 }
Mike Stump31feda52009-07-17 01:31:16 +00002512
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002513 // Link up the condition block with the code that follows the loop.
2514 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002515 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002516
Ted Kremenek9d56e642008-11-11 17:10:00 +00002517 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002518 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00002519 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00002520}
2521
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002522CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
2523 // Inline the body.
2524 return addStmt(S->getSubStmt());
2525 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
2526}
2527
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002528CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00002529 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00002530
Ted Kremenek49805452009-05-02 01:49:13 +00002531 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00002532 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00002533
Ted Kremenekb3c657b2009-05-05 23:11:51 +00002534 // The sync body starts its own basic block. This makes it a little easier
2535 // for diagnostic clients.
2536 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002537 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002538 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002539
Craig Topper25542942014-05-20 04:30:07 +00002540 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00002541 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00002542 }
Mike Stump31feda52009-07-17 01:31:16 +00002543
Ted Kremeneked12f1b2010-09-10 03:05:33 +00002544 // Add the @synchronized to the CFG.
2545 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002546 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00002547
Ted Kremenek49805452009-05-02 01:49:13 +00002548 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00002549 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00002550}
Mike Stump31feda52009-07-17 01:31:16 +00002551
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002552CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00002553 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00002554 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00002555}
Ted Kremenek9d56e642008-11-11 17:10:00 +00002556
John McCallfe96e0b2011-11-06 09:01:30 +00002557CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
2558 autoCreateBlock();
2559
2560 // Add the PseudoObject as the last thing.
2561 appendStmt(Block, E);
2562
2563 CFGBlock *lastBlock = Block;
2564
2565 // Before that, evaluate all of the semantics in order. In
2566 // CFG-land, that means appending them in reverse order.
2567 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
2568 Expr *Semantic = E->getSemanticExpr(--i);
2569
2570 // If the semantic is an opaque value, we're being asked to bind
2571 // it to its source expression.
2572 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
2573 Semantic = OVE->getSourceExpr();
2574
2575 if (CFGBlock *B = Visit(Semantic))
2576 lastBlock = B;
2577 }
2578
2579 return lastBlock;
2580}
2581
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002582CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00002583 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002584
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002585 // Save local scope position because in case of condition variable ScopePos
2586 // won't be restored when traversing AST.
2587 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2588
2589 // Create local scope for possible condition variable.
2590 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002591 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002592 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002593 addLocalScopeForVarDecl(VD);
2594 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W);
2595 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002596
Mike Stump014b3ea2009-07-21 01:12:51 +00002597 // "while" is a control-flow statement. Thus we stop processing the current
2598 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002599 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002600 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002601 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002602 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00002603 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002604 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00002605 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00002606 }
Mike Stump31feda52009-07-17 01:31:16 +00002607
Craig Topper25542942014-05-20 04:30:07 +00002608 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00002609
Ted Kremenek9aae5132007-08-23 21:42:29 +00002610 // Process the loop body.
2611 {
Ted Kremenek49936f72009-04-28 03:09:44 +00002612 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00002613
Ted Kremenekb50e7162012-07-14 05:04:10 +00002614 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002615 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2616 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00002617 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00002618
Mike Stump31feda52009-07-17 01:31:16 +00002619 // Create an empty block to represent the transition block for looping back
2620 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002621 Succ = TransitionBlock = createBlock(false);
2622 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002623 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002624
Ted Kremenek9aae5132007-08-23 21:42:29 +00002625 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002626 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002627
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002628 // Loop body should end with destructor of Condition variable (if any).
2629 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W);
2630
2631 // If body is not a compound statement create implicit scope
2632 // and add destructors.
2633 if (!isa<CompoundStmt>(W->getBody()))
2634 addLocalScopeAndDtors(W->getBody());
2635
Ted Kremenek9aae5132007-08-23 21:42:29 +00002636 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002637 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002638
Ted Kremeneke9610502007-08-30 18:39:40 +00002639 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002640 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00002641 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002642 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002643 }
2644
2645 // Because of short-circuit evaluation, the condition of the loop can span
2646 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2647 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00002648 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002649
2650 do {
2651 Expr *C = W->getCond();
2652
2653 // Specially handle logical operators, which have a slightly
2654 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00002655 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002656 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002657 std::tie(EntryConditionBlock, ExitConditionBlock) =
2658 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002659 break;
2660 }
2661
2662 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00002663 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002664 ExitConditionBlock->setTerminator(W);
2665
2666 // Now add the actual condition to the condition block.
2667 // Because the condition itself may contain control-flow, new blocks may
2668 // be created. Thus we update "Succ" after adding the condition.
2669 Block = ExitConditionBlock;
2670 Block = EntryConditionBlock = addStmt(C);
2671
2672 // If this block contains a condition variable, add both the condition
2673 // variable and initializer to the CFG.
2674 if (VarDecl *VD = W->getConditionVariable()) {
2675 if (Expr *Init = VD->getInit()) {
2676 autoCreateBlock();
2677 appendStmt(Block, W->getConditionVariableDeclStmt());
2678 EntryConditionBlock = addStmt(Init);
2679 assert(Block == EntryConditionBlock);
2680 }
Ted Kremenek55957a82009-05-02 00:13:27 +00002681 }
Mike Stump31feda52009-07-17 01:31:16 +00002682
Ted Kremenekb50e7162012-07-14 05:04:10 +00002683 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002684 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002685
2686 // See if this is a known constant.
2687 const TryResult& KnownVal = tryEvaluateBool(C);
2688
Ted Kremenek30754282009-07-24 04:47:11 +00002689 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00002690 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002691 // Link up the condition block with the code that follows the loop. (the
2692 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00002693 addSuccessor(ExitConditionBlock,
2694 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00002695
Ted Kremenekb50e7162012-07-14 05:04:10 +00002696 } while(false);
2697
2698 // Link up the loop-back block to the entry condition block.
2699 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00002700
2701 // There can be no more statements in the condition block since we loop back
2702 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00002703 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002704
Ted Kremenek1ce53c42009-12-24 01:34:10 +00002705 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00002706 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00002707 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002708}
Mike Stump11289f42009-09-09 15:08:12 +00002709
2710
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002711CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00002712 // FIXME: For now we pretend that @catch and the code it contains does not
2713 // exit.
2714 return Block;
2715}
Mike Stump31feda52009-07-17 01:31:16 +00002716
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002717CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00002718 // FIXME: This isn't complete. We basically treat @throw like a return
2719 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00002720
Ted Kremenek0868eea2009-09-24 18:45:41 +00002721 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002722 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002723 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002724
Ted Kremenek93041ba2008-12-09 20:20:09 +00002725 // Create the new block.
2726 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002727
Ted Kremenek93041ba2008-12-09 20:20:09 +00002728 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002729 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002730
2731 // Add the statement to the block. This may create new blocks if S contains
2732 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002733 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00002734}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002735
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002736CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002737 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002738 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002739 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002740
2741 // Create the new block.
2742 Block = createBlock(false);
2743
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002744 if (TryTerminatedBlock)
2745 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002746 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002747 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002748 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002749 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002750
2751 // Add the statement to the block. This may create new blocks if S contains
2752 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002753 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002754}
2755
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002756CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00002757 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002758
Mike Stump8d50b6a2009-07-21 01:27:50 +00002759 // "do...while" is a control-flow statement. Thus we stop processing the
2760 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002761 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002762 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002763 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002764 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002765 } else
2766 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002767
2768 // Because of short-circuit evaluation, the condition of the loop can span
2769 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2770 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002771 CFGBlock *ExitConditionBlock = createBlock(false);
2772 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002773
Ted Kremenek81e14852007-08-27 19:46:09 +00002774 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00002775 ExitConditionBlock->setTerminator(D);
2776
2777 // Now add the actual condition to the condition block. Because the condition
2778 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002779 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00002780 Block = ExitConditionBlock;
2781 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00002782 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002783 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002784 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002785 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002786 }
Mike Stump31feda52009-07-17 01:31:16 +00002787
Ted Kremeneka1523a32008-02-27 07:20:00 +00002788 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00002789 Succ = EntryConditionBlock;
2790
Mike Stump773582d2009-07-23 23:25:26 +00002791 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002792 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00002793
Ted Kremenek9aae5132007-08-23 21:42:29 +00002794 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00002795 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002796 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002797 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002798
Ted Kremenek9aae5132007-08-23 21:42:29 +00002799 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002800 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2801 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
2802 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002803
Ted Kremenek9aae5132007-08-23 21:42:29 +00002804 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002805 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002806
Ted Kremenek9aae5132007-08-23 21:42:29 +00002807 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002808 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002809
Ted Kremenek9aae5132007-08-23 21:42:29 +00002810 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00002811 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002812
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002813 // If body is not a compound statement create implicit scope
2814 // and add destructors.
2815 if (!isa<CompoundStmt>(D->getBody()))
2816 addLocalScopeAndDtors(D->getBody());
2817
Ted Kremenek9aae5132007-08-23 21:42:29 +00002818 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00002819 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002820
Ted Kremeneke9610502007-08-30 18:39:40 +00002821 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00002822 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00002823 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002824 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002825 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002826 }
Mike Stump31feda52009-07-17 01:31:16 +00002827
Ted Kremenek110974d2010-08-17 20:59:56 +00002828 if (!KnownVal.isFalse()) {
2829 // Add an intermediate block between the BodyBlock and the
2830 // ExitConditionBlock to represent the "loop back" transition. Create an
2831 // empty block to represent the transition block for looping back to the
2832 // head of the loop.
2833 // FIXME: Can we do this more efficiently without adding another block?
Craig Topper25542942014-05-20 04:30:07 +00002834 Block = nullptr;
Ted Kremenek110974d2010-08-17 20:59:56 +00002835 Succ = BodyBlock;
2836 CFGBlock *LoopBackBlock = createBlock();
2837 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00002838
Ted Kremenek110974d2010-08-17 20:59:56 +00002839 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002840 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00002841 }
2842 else
Craig Topper25542942014-05-20 04:30:07 +00002843 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002844 }
Mike Stump31feda52009-07-17 01:31:16 +00002845
Ted Kremenek30754282009-07-24 04:47:11 +00002846 // Link up the condition block with the code that follows the loop.
2847 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00002848 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00002849
2850 // There can be no more statements in the body block(s) since we loop back to
2851 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00002852 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002853
Ted Kremenek9aae5132007-08-23 21:42:29 +00002854 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00002855 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002856 return BodyBlock;
2857}
2858
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002859CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002860 // "continue" is a control-flow statement. Thus we stop processing the
2861 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002862 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002863 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002864
Ted Kremenek9aae5132007-08-23 21:42:29 +00002865 // Now create a new block that ends with the continue statement.
2866 Block = createBlock(false);
2867 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00002868
Ted Kremenek9aae5132007-08-23 21:42:29 +00002869 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00002870 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002871 if (ContinueJumpTarget.block) {
2872 addAutomaticObjDtors(ScopePos, ContinueJumpTarget.scopePosition, C);
2873 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002874 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00002875 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00002876
Ted Kremenek9aae5132007-08-23 21:42:29 +00002877 return Block;
2878}
Mike Stump11289f42009-09-09 15:08:12 +00002879
Peter Collingbournee190dee2011-03-11 19:24:49 +00002880CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
2881 AddStmtChoice asc) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002882
Ted Kremenek7c58d352011-03-10 01:14:11 +00002883 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002884 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002885 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00002886 }
Mike Stump11289f42009-09-09 15:08:12 +00002887
Ted Kremenek93668002009-07-17 22:18:43 +00002888 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002889 CFGBlock *lastBlock = Block;
2890
Ted Kremenek93668002009-07-17 22:18:43 +00002891 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00002892 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002893 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002894 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00002895 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002896 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002897}
Mike Stump11289f42009-09-09 15:08:12 +00002898
Ted Kremenek93668002009-07-17 22:18:43 +00002899/// VisitStmtExpr - Utility method to handle (nested) statement
2900/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002901CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002902 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002903 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002904 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00002905 }
Ted Kremenek93668002009-07-17 22:18:43 +00002906 return VisitCompoundStmt(SE->getSubStmt());
2907}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002908
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002909CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00002910 // "switch" is a control-flow statement. Thus we stop processing the current
2911 // block.
Craig Topper25542942014-05-20 04:30:07 +00002912 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002913
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002914 // Save local scope position because in case of condition variable ScopePos
2915 // won't be restored when traversing AST.
2916 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2917
2918 // Create local scope for possible condition variable.
2919 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002920 if (VarDecl *VD = Terminator->getConditionVariable()) {
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002921 LocalScope::const_iterator SwitchBeginScopePos = ScopePos;
2922 addLocalScopeForVarDecl(VD);
2923 addAutomaticObjDtors(ScopePos, SwitchBeginScopePos, Terminator);
2924 }
2925
Ted Kremenek9aae5132007-08-23 21:42:29 +00002926 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002927 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002928 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002929 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002930 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002931
2932 // Save the current "switch" context.
2933 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00002934 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002935 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00002936
Mike Stump31feda52009-07-17 01:31:16 +00002937 // Set the "default" case to be the block after the switch statement. If the
2938 // switch statement contains a "default:", this value will be overwritten with
2939 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00002940 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00002941
Ted Kremenek9aae5132007-08-23 21:42:29 +00002942 // Create a new block that will contain the switch statement.
2943 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002944
Ted Kremenek9aae5132007-08-23 21:42:29 +00002945 // Now process the switch body. The code after the switch is the implicit
2946 // successor.
2947 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002948 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002949
2950 // When visiting the body, the case statements should automatically get linked
2951 // up to the switch. We also don't keep a pointer to the body, since all
2952 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002953 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00002954 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002955
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002956 // For pruning unreachable case statements, save the current state
2957 // for tracking the condition value.
2958 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
2959 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00002960
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002961 // Determine if the switch condition can be explicitly evaluated.
2962 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00002963 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00002964 bool b = tryEvaluate(Terminator->getCond(), result);
2965 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00002966 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00002967
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002968 // If body is not a compound statement create implicit scope
2969 // and add destructors.
2970 if (!isa<CompoundStmt>(Terminator->getBody()))
2971 addLocalScopeAndDtors(Terminator->getBody());
2972
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002973 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00002974 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002975 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002976 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002977 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002978
Mike Stump31feda52009-07-17 01:31:16 +00002979 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00002980 // following the switch body. Moreover, take into account if all the
2981 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00002982 //
2983 // Note: We add a successor to a switch that is considered covered yet has no
2984 // case statements if the enumeration has no enumerators.
2985 bool SwitchAlwaysHasSuccessor = false;
2986 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
2987 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
2988 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00002989 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
2990 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00002991
Ted Kremenek81e14852007-08-27 19:46:09 +00002992 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002993 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002994 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002995 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002996
Ted Kremenek8b5dc122009-12-24 00:39:26 +00002997 // Finally, if the SwitchStmt contains a condition variable, add both the
2998 // SwitchStmt and the condition variable initialization to the CFG.
2999 if (VarDecl *VD = Terminator->getConditionVariable()) {
3000 if (Expr *Init = VD->getInit()) {
3001 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003002 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003003 LastBlock = addStmt(Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003004 }
3005 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003006
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003007 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003008}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003009
3010static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003011 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003012 const CaseStmt *CS,
3013 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003014 if (!switchCond)
3015 return true;
3016
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003017 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003018
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003019 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003020 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003021 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003022 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003023 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003024
3025 if (condInt == lhsInt) {
3026 addCase = true;
3027 switchExclusivelyCovered = true;
3028 }
3029 else if (condInt < lhsInt) {
3030 if (const Expr *RHS = CS->getRHS()) {
3031 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003032 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
3033 if (V2 <= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003034 addCase = true;
3035 switchExclusivelyCovered = true;
3036 }
3037 }
3038 }
3039 }
3040 else
3041 addCase = true;
3042 }
3043 return addCase;
3044}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003045
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003046CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003047 // CaseStmts are essentially labels, so they are the first statement in a
3048 // block.
Craig Topper25542942014-05-20 04:30:07 +00003049 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003050
Ted Kremenek60fa6572010-08-04 23:54:30 +00003051 if (Stmt *Sub = CS->getSubStmt()) {
3052 // For deeply nested chains of CaseStmts, instead of doing a recursion
3053 // (which can blow out the stack), manually unroll and create blocks
3054 // along the way.
3055 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003056 CFGBlock *currentBlock = createBlock(false);
3057 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003058
Ted Kremenek60fa6572010-08-04 23:54:30 +00003059 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003060 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003061 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003062 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003063
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003064 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003065 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003066 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003067 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003068
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003069 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003070 CS = cast<CaseStmt>(Sub);
3071 Sub = CS->getSubStmt();
3072 }
3073
3074 addStmt(Sub);
3075 }
Mike Stump11289f42009-09-09 15:08:12 +00003076
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003077 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003078 if (!CaseBlock)
3079 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003080
3081 // Cases statements partition blocks, so this is the top of the basic block we
3082 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003083 CaseBlock->setLabel(CS);
3084
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003085 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003086 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003087
3088 // Add this block to the list of successors for the block with the switch
3089 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003090 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003091 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003092 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003093 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003094
Ted Kremenek9aae5132007-08-23 21:42:29 +00003095 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003096 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003097
Ted Kremenek60fa6572010-08-04 23:54:30 +00003098 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003099 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003100 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003101 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003102 // This block is now the implicit successor of other blocks.
3103 Succ = CaseBlock;
3104 }
Mike Stump31feda52009-07-17 01:31:16 +00003105
Ted Kremenek60fa6572010-08-04 23:54:30 +00003106 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003107}
Mike Stump31feda52009-07-17 01:31:16 +00003108
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003109CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003110 if (Terminator->getSubStmt())
3111 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003112
Ted Kremenek654c78f2008-02-13 22:05:39 +00003113 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003114
3115 if (!DefaultCaseBlock)
3116 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003117
3118 // Default statements partition blocks, so this is the top of the basic block
3119 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003120 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003121
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003122 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003123 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003124
Mike Stump31feda52009-07-17 01:31:16 +00003125 // Unlike case statements, we don't add the default block to the successors
3126 // for the switch statement immediately. This is done when we finish
3127 // processing the switch statement. This allows for the default case
3128 // (including a fall-through to the code after the switch statement) to always
3129 // be the last successor of a switch-terminated block.
3130
Ted Kremenek654c78f2008-02-13 22:05:39 +00003131 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003132 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003133
Ted Kremenek654c78f2008-02-13 22:05:39 +00003134 // This block is now the implicit successor of other blocks.
3135 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003136
3137 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003138}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003139
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003140CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3141 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3142 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003143 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003144
3145 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003146 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003147 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003148 TrySuccessor = Block;
3149 } else TrySuccessor = Succ;
3150
Mike Stump0bdba6c2010-01-20 01:15:34 +00003151 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003152
3153 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003154 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003155 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003156 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003157
Mike Stump0bdba6c2010-01-20 01:15:34 +00003158 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003159 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3160 // The code after the try is the implicit successor.
3161 Succ = TrySuccessor;
3162 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003163 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003164 HasCatchAll = true;
3165 }
Craig Topper25542942014-05-20 04:30:07 +00003166 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003167 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00003168 if (!CatchBlock)
3169 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003170 // Add this block to the list of successors for the block with the try
3171 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003172 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003173 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00003174 if (!HasCatchAll) {
3175 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003176 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00003177 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003178 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00003179 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003180
3181 // The code after the try is the implicit successor.
3182 Succ = TrySuccessor;
3183
Mike Stump845384a2010-01-20 01:30:58 +00003184 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00003185 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
3186 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00003187
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003188 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003189 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003190 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003191}
3192
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003193CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003194 // CXXCatchStmt are treated like labels, so they are the first statement in a
3195 // block.
3196
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003197 // Save local scope position because in case of exception variable ScopePos
3198 // won't be restored when traversing AST.
3199 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3200
3201 // Create local scope for possible exception variable.
3202 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003203 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003204 LocalScope::const_iterator BeginScopePos = ScopePos;
3205 addLocalScopeForVarDecl(VD);
3206 addAutomaticObjDtors(ScopePos, BeginScopePos, CS);
3207 }
3208
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003209 if (CS->getHandlerBlock())
3210 addStmt(CS->getHandlerBlock());
3211
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003212 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003213 if (!CatchBlock)
3214 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003215
3216 // CXXCatchStmt is more than just a label. They have semantic meaning
3217 // as well, as they implicitly "initialize" the catch variable. Add
3218 // it to the CFG as a CFGElement so that the control-flow of these
3219 // semantics gets captured.
3220 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003221
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003222 // Also add the CXXCatchStmt as a label, to mirror handling of regular
3223 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003224 CatchBlock->setLabel(CS);
3225
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003226 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003227 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003228 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003229
3230 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003231 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003232
3233 return CatchBlock;
3234}
3235
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003236CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00003237 // C++0x for-range statements are specified as [stmt.ranged]:
3238 //
3239 // {
3240 // auto && __range = range-init;
3241 // for ( auto __begin = begin-expr,
3242 // __end = end-expr;
3243 // __begin != __end;
3244 // ++__begin ) {
3245 // for-range-declaration = *__begin;
3246 // statement
3247 // }
3248 // }
3249
3250 // Save local scope position before the addition of the implicit variables.
3251 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3252
3253 // Create local scopes and destructors for range, begin and end variables.
3254 if (Stmt *Range = S->getRangeStmt())
3255 addLocalScopeForStmt(Range);
3256 if (Stmt *BeginEnd = S->getBeginEndStmt())
3257 addLocalScopeForStmt(BeginEnd);
3258 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), S);
3259
3260 LocalScope::const_iterator ContinueScopePos = ScopePos;
3261
3262 // "for" is a control-flow statement. Thus we stop processing the current
3263 // block.
Craig Topper25542942014-05-20 04:30:07 +00003264 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003265 if (Block) {
3266 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003267 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003268 LoopSuccessor = Block;
3269 } else
3270 LoopSuccessor = Succ;
3271
3272 // Save the current value for the break targets.
3273 // All breaks should go to the code following the loop.
3274 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
3275 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
3276
3277 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003278 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00003279 ConditionBlock->setTerminator(S);
3280
3281 // Now add the actual condition to the condition block.
3282 if (Expr *C = S->getCond()) {
3283 Block = ConditionBlock;
3284 CFGBlock *BeginConditionBlock = addStmt(C);
3285 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003286 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003287 assert(BeginConditionBlock == ConditionBlock &&
3288 "condition block in for-range was unexpectedly complex");
3289 (void)BeginConditionBlock;
3290 }
3291
3292 // The condition block is the implicit successor for the loop body as well as
3293 // any code above the loop.
3294 Succ = ConditionBlock;
3295
3296 // See if this is a known constant.
3297 TryResult KnownVal(true);
3298
3299 if (S->getCond())
3300 KnownVal = tryEvaluateBool(S->getCond());
3301
3302 // Now create the loop body.
3303 {
3304 assert(S->getBody());
3305
3306 // Save the current values for Block, Succ, and continue targets.
3307 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3308 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
3309
3310 // Generate increment code in its own basic block. This is the target of
3311 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00003312 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003313 Succ = addStmt(S->getInc());
3314 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3315
3316 // The starting block for the loop increment is the block that should
3317 // represent the 'loop target' for looping back to the start of the loop.
3318 ContinueJumpTarget.block->setLoopTarget(S);
3319
3320 // Finish up the increment block and prepare to start the loop body.
3321 assert(Block);
3322 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003323 return nullptr;
3324 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003325
3326 // Add implicit scope and dtors for loop variable.
3327 addLocalScopeAndDtors(S->getLoopVarStmt());
3328
3329 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003330 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00003331 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003332 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003333 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003334 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003335 return nullptr;
3336
Richard Smith02e85f32011-04-14 22:09:26 +00003337 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00003338 addSuccessor(ConditionBlock,
3339 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00003340 }
3341
3342 // Link up the condition block with the code that follows the loop (the
3343 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003344 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00003345
3346 // Add the initialization statements.
3347 Block = createBlock();
Richard Smith0c502d22011-04-18 15:49:25 +00003348 addStmt(S->getBeginEndStmt());
3349 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003350}
3351
John McCall5d413782010-12-06 08:20:24 +00003352CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003353 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00003354 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003355 // If adding implicit destructors visit the full expression for adding
3356 // destructors of temporaries.
3357 VisitForTemporaryDtors(E->getSubExpr());
3358
3359 // Full expression has to be added as CFGStmt so it will be sequenced
3360 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003361 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003362 }
3363 return Visit(E->getSubExpr(), asc);
3364}
3365
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003366CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
3367 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003368 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003369 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003370 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003371
3372 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003373 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003374 }
3375 return Visit(E->getSubExpr(), asc);
3376}
3377
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003378CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
3379 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003380 autoCreateBlock();
Zhongxing Xuf0cb43f2012-01-11 02:39:07 +00003381 appendStmt(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003382
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003383 return VisitChildren(C);
3384}
3385
Jordan Rosec9176072014-01-13 17:59:19 +00003386CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
3387 AddStmtChoice asc) {
3388
3389 autoCreateBlock();
3390 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00003391
Jordan Rosec9176072014-01-13 17:59:19 +00003392 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00003393 Block = Visit(NE->getInitializer());
Jordan Rosec9176072014-01-13 17:59:19 +00003394 if (BuildOpts.AddCXXNewAllocator)
3395 appendNewAllocator(Block, NE);
3396 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00003397 Block = Visit(NE->getArraySize());
Jordan Rosec9176072014-01-13 17:59:19 +00003398 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
3399 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00003400 Block = Visit(*I);
Jordan Rosec9176072014-01-13 17:59:19 +00003401 return Block;
3402}
Jordan Rosed2f40792013-09-03 17:00:57 +00003403
3404CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
3405 AddStmtChoice asc) {
3406 autoCreateBlock();
3407 appendStmt(Block, DE);
3408 QualType DTy = DE->getDestroyedType();
3409 DTy = DTy.getNonReferenceType();
3410 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
3411 if (RD) {
Matt Beaumont-Gay093f2402013-09-09 21:07:58 +00003412 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
Jordan Rosed2f40792013-09-03 17:00:57 +00003413 appendDeleteDtor(Block, RD, DE);
3414 }
3415
3416 return VisitChildren(DE);
3417}
3418
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003419CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
3420 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003421 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003422 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003423 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003424 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003425 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003426 }
3427 return Visit(E->getSubExpr(), asc);
3428}
3429
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003430CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
3431 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003432 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003433 appendStmt(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003434 return VisitChildren(C);
3435}
3436
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003437CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
3438 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003439 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003440 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003441 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003442 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003443 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003444}
3445
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003446CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00003447 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003448 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003449
Ted Kremenekeda180e22007-08-28 19:26:49 +00003450 if (!IBlock) {
3451 IBlock = createBlock(false);
3452 cfg->setIndirectGotoBlock(IBlock);
3453 }
Mike Stump31feda52009-07-17 01:31:16 +00003454
Ted Kremenekeda180e22007-08-28 19:26:49 +00003455 // IndirectGoto is a control-flow statement. Thus we stop processing the
3456 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003457 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003458 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003459
Ted Kremenekeda180e22007-08-28 19:26:49 +00003460 Block = createBlock(false);
3461 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003462 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00003463 return addStmt(I->getTarget());
3464}
3465
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003466CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00003467 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
3468
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003469tryAgain:
3470 if (!E) {
3471 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00003472 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003473 }
3474 switch (E->getStmtClass()) {
3475 default:
3476 return VisitChildrenForTemporaryDtors(E);
3477
3478 case Stmt::BinaryOperatorClass:
3479 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E));
3480
3481 case Stmt::CXXBindTemporaryExprClass:
3482 return VisitCXXBindTemporaryExprForTemporaryDtors(
3483 cast<CXXBindTemporaryExpr>(E), BindToTemporary);
3484
John McCallc07a0c72011-02-17 10:25:35 +00003485 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003486 case Stmt::ConditionalOperatorClass:
3487 return VisitConditionalOperatorForTemporaryDtors(
John McCallc07a0c72011-02-17 10:25:35 +00003488 cast<AbstractConditionalOperator>(E), BindToTemporary);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003489
3490 case Stmt::ImplicitCastExprClass:
3491 // For implicit cast we want BindToTemporary to be passed further.
3492 E = cast<CastExpr>(E)->getSubExpr();
3493 goto tryAgain;
3494
3495 case Stmt::ParenExprClass:
3496 E = cast<ParenExpr>(E)->getSubExpr();
3497 goto tryAgain;
Douglas Gregorfe314812011-06-21 17:03:29 +00003498
3499 case Stmt::MaterializeTemporaryExprClass:
3500 E = cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr();
3501 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003502 }
3503}
3504
3505CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E) {
3506 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00003507 // order that they will appear in the CFG. Because the CFG is built
3508 // bottom-up, this means we visit them in their natural order, which
3509 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003510 CFGBlock *B = Block;
Ted Kremenek8ae67872013-02-05 22:00:19 +00003511 for (Stmt::child_range I = E->children(); I; ++I) {
3512 if (Stmt *Child = *I)
3513 if (CFGBlock *R = VisitForTemporaryDtors(Child))
3514 B = R;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003515 }
3516 return B;
3517}
3518
3519CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E) {
3520 if (E->isLogicalOp()) {
3521 // Destructors for temporaries in LHS expression should be called after
3522 // those for RHS expression. Even if this will unnecessarily create a block,
3523 // this block will be used at least by the full expression.
3524 autoCreateBlock();
3525 CFGBlock *ConfluenceBlock = VisitForTemporaryDtors(E->getLHS());
3526 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003527 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003528
3529 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00003530 Block = nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003531 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS());
3532
3533 if (RHSBlock) {
3534 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003535 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003536
3537 // If RHS expression did produce destructors we need to connect created
3538 // blocks to CFG in same manner as for binary operator itself.
3539 CFGBlock *LHSBlock = createBlock(false);
3540 LHSBlock->setTerminator(CFGTerminator(E, true));
3541
3542 // For binary operator LHS block is before RHS in list of predecessors
3543 // of ConfluenceBlock.
3544 std::reverse(ConfluenceBlock->pred_begin(),
3545 ConfluenceBlock->pred_end());
3546
3547 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003548 TryResult KnownVal = tryEvaluateBool(E->getLHS());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003549 if (KnownVal.isKnown() && (E->getOpcode() == BO_LOr))
3550 KnownVal.negate();
3551
3552 // Link LHSBlock with RHSBlock exactly the same way as for binary operator
3553 // itself.
3554 if (E->getOpcode() == BO_LOr) {
Craig Topper25542942014-05-20 04:30:07 +00003555 addSuccessor(LHSBlock, KnownVal.isTrue() ? nullptr : ConfluenceBlock);
3556 addSuccessor(LHSBlock, KnownVal.isFalse() ? nullptr : RHSBlock);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003557 } else {
3558 assert (E->getOpcode() == BO_LAnd);
Craig Topper25542942014-05-20 04:30:07 +00003559 addSuccessor(LHSBlock, KnownVal.isFalse() ? nullptr : RHSBlock);
3560 addSuccessor(LHSBlock, KnownVal.isTrue() ? nullptr : ConfluenceBlock);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003561 }
3562
3563 Block = LHSBlock;
3564 return LHSBlock;
3565 }
3566
3567 Block = ConfluenceBlock;
3568 return ConfluenceBlock;
3569 }
3570
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003571 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003572 // For assignment operator (=) LHS expression is visited
3573 // before RHS expression. For destructors visit them in reverse order.
3574 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS());
3575 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS());
3576 return LHSBlock ? LHSBlock : RHSBlock;
3577 }
3578
3579 // For any other binary operator RHS expression is visited before
3580 // LHS expression (order of children). For destructors visit them in reverse
3581 // order.
3582 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS());
3583 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS());
3584 return RHSBlock ? RHSBlock : LHSBlock;
3585}
3586
3587CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
3588 CXXBindTemporaryExpr *E, bool BindToTemporary) {
3589 // First add destructors for temporaries in subexpression.
3590 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr());
Zhongxing Xufee455f2010-11-14 15:23:50 +00003591 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003592 // If lifetime of temporary is not prolonged (by assigning to constant
3593 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00003594
3595 // If the destructor is marked as a no-return destructor, we need to create
3596 // a new block for the destructor which does not have as a successor
3597 // anything built thus far. Control won't flow out of this block.
3598 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Ted Kremenekff909f92014-03-08 02:22:25 +00003599 if (Dtor->isNoReturn()) {
3600 Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00003601 Block = createNoReturnBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00003602 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00003603 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00003604 }
Chandler Carruthad747252011-09-13 06:09:01 +00003605
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003606 appendTemporaryDtor(Block, E);
3607 B = Block;
3608 }
3609 return B;
3610}
3611
3612CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
John McCallc07a0c72011-02-17 10:25:35 +00003613 AbstractConditionalOperator *E, bool BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003614 // First add destructors for condition expression. Even if this will
3615 // unnecessarily create a block, this block will be used at least by the full
3616 // expression.
3617 autoCreateBlock();
3618 CFGBlock *ConfluenceBlock = VisitForTemporaryDtors(E->getCond());
3619 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003620 return nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003621 if (BinaryConditionalOperator *BCO
3622 = dyn_cast<BinaryConditionalOperator>(E)) {
3623 ConfluenceBlock = VisitForTemporaryDtors(BCO->getCommon());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003624 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003625 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003626 }
3627
John McCallc07a0c72011-02-17 10:25:35 +00003628 // Try to add block with destructors for LHS expression.
Craig Topper25542942014-05-20 04:30:07 +00003629 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003630 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00003631 Block = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003632 LHSBlock = VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary);
3633 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003634 return nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003635
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003636 // Try to add block with destructors for RHS expression;
3637 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00003638 Block = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003639 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getFalseExpr(),
3640 BindToTemporary);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003641 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003642 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003643
3644 if (!RHSBlock && !LHSBlock) {
3645 // If neither LHS nor RHS expression had temporaries to destroy don't create
3646 // more blocks.
3647 Block = ConfluenceBlock;
3648 return Block;
3649 }
3650
3651 Block = createBlock(false);
3652 Block->setTerminator(CFGTerminator(E, true));
Ted Kremenekfcc14172014-03-08 02:22:29 +00003653 assert(Block->getTerminator().isTemporaryDtorsBranch());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003654
3655 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003656 const TryResult &KnownVal = tryEvaluateBool(E->getCond());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003657
3658 if (LHSBlock) {
Ted Kremenek5a095272014-03-04 21:53:26 +00003659 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003660 } else if (KnownVal.isFalse()) {
Craig Topper25542942014-05-20 04:30:07 +00003661 addSuccessor(Block, nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003662 } else {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003663 addSuccessor(Block, ConfluenceBlock);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003664 std::reverse(ConfluenceBlock->pred_begin(), ConfluenceBlock->pred_end());
3665 }
3666
3667 if (!RHSBlock)
3668 RHSBlock = ConfluenceBlock;
Ted Kremenek5a095272014-03-04 21:53:26 +00003669
3670 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003671
3672 return Block;
3673}
3674
Ted Kremenek04cca642007-08-23 21:26:19 +00003675} // end anonymous namespace
Ted Kremenek889073f2007-08-23 16:51:22 +00003676
Mike Stump31feda52009-07-17 01:31:16 +00003677/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
3678/// no successors or predecessors. If this is the first block created in the
3679/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003680CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00003681 bool first_block = begin() == end();
3682
3683 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003684 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00003685 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003686 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00003687
3688 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003689 if (first_block)
3690 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00003691
3692 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003693 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00003694}
3695
Ted Kremenek889073f2007-08-23 16:51:22 +00003696/// buildCFG - Constructs a CFG from an AST. Ownership of the returned
3697/// CFG is returned to the caller.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003698CFG* CFG::buildCFG(const Decl *D, Stmt *Statement, ASTContext *C,
Ted Kremenekf9d82902011-03-10 01:14:05 +00003699 const BuildOptions &BO) {
3700 CFGBuilder Builder(C, BO);
3701 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00003702}
3703
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003704const CXXDestructorDecl *
3705CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003706 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003707 case CFGElement::Statement:
3708 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00003709 case CFGElement::NewAllocator:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003710 llvm_unreachable("getDestructorDecl should only be used with "
3711 "ImplicitDtors");
3712 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00003713 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003714 QualType ty = var->getType();
Ted Kremenek1676a042011-03-03 01:01:03 +00003715 ty = ty.getNonReferenceType();
Ted Kremeneke7d78882012-03-19 23:48:41 +00003716 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003717 ty = arrayType->getElementType();
3718 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003719 const RecordType *recordType = ty->getAs<RecordType>();
3720 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00003721 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003722 return classDecl->getDestructor();
3723 }
Jordan Rosed2f40792013-09-03 17:00:57 +00003724 case CFGElement::DeleteDtor: {
3725 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
3726 QualType DTy = DE->getDestroyedType();
3727 DTy = DTy.getNonReferenceType();
3728 const CXXRecordDecl *classDecl =
3729 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
3730 return classDecl->getDestructor();
3731 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003732 case CFGElement::TemporaryDtor: {
3733 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00003734 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003735 const CXXTemporary *temp = bindExpr->getTemporary();
3736 return temp->getDestructor();
3737 }
3738 case CFGElement::BaseDtor:
3739 case CFGElement::MemberDtor:
3740
3741 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00003742 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003743 }
Ted Kremenek1676a042011-03-03 01:01:03 +00003744 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003745}
3746
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003747bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00003748 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
3749 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003750 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00003751}
3752
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00003753//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003754// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00003755//===----------------------------------------------------------------------===//
3756
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003757CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Craig Topper25542942014-05-20 04:30:07 +00003758 : ReachableBlock(IsReachable ? B : nullptr),
3759 UnreachableBlock(!IsReachable ? B : nullptr,
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003760 B && IsReachable ? AB_Normal : AB_Unreachable) {}
3761
3762CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
3763 : ReachableBlock(B),
Craig Topper25542942014-05-20 04:30:07 +00003764 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003765 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
3766
3767void CFGBlock::addSuccessor(AdjacentBlock Succ,
3768 BumpVectorContext &C) {
3769 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00003770 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003771
3772 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00003773 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003774
3775 Succs.push_back(Succ, C);
3776}
3777
Ted Kremenekb0371852010-09-09 00:06:04 +00003778bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00003779 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003780
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003781 if (F.IgnoreNullPredecessors && !From)
3782 return true;
3783
3784 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003785 // If the 'To' has no label or is labeled but the label isn't a
3786 // CaseStmt then filter this edge.
3787 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00003788 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003789 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00003790 const Stmt *L = To->getLabel();
3791 if (!L || !isa<CaseStmt>(L))
3792 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00003793 }
3794 }
3795 }
3796
3797 return false;
3798}
3799
3800//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00003801// CFG pretty printing
3802//===----------------------------------------------------------------------===//
3803
Ted Kremenek7e776b12007-08-22 18:22:34 +00003804namespace {
3805
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00003806class StmtPrinterHelper : public PrinterHelper {
Ted Kremenek96a7a592011-03-01 03:15:10 +00003807 typedef llvm::DenseMap<const Stmt*,std::pair<unsigned,unsigned> > StmtMapTy;
3808 typedef llvm::DenseMap<const Decl*,std::pair<unsigned,unsigned> > DeclMapTy;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003809 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003810 DeclMapTy DeclMap;
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003811 signed currentBlock;
Ted Kremenekd94854a2012-08-22 06:26:15 +00003812 unsigned currStmt;
Chris Lattnerc61089a2009-06-30 01:26:17 +00003813 const LangOptions &LangOpts;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003814public:
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003815
Chris Lattnerc61089a2009-06-30 01:26:17 +00003816 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Ted Kremenekd94854a2012-08-22 06:26:15 +00003817 : currentBlock(0), currStmt(0), LangOpts(LO)
Ted Kremenek96a7a592011-03-01 03:15:10 +00003818 {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003819 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
3820 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003821 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003822 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00003823 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
3824 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003825 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00003826 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003827
Ted Kremenek96a7a592011-03-01 03:15:10 +00003828 switch (stmt->getStmtClass()) {
3829 case Stmt::DeclStmtClass:
3830 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
3831 break;
3832 case Stmt::IfStmtClass: {
3833 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
3834 if (var)
3835 DeclMap[var] = P;
3836 break;
3837 }
3838 case Stmt::ForStmtClass: {
3839 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
3840 if (var)
3841 DeclMap[var] = P;
3842 break;
3843 }
3844 case Stmt::WhileStmtClass: {
3845 const VarDecl *var =
3846 cast<WhileStmt>(stmt)->getConditionVariable();
3847 if (var)
3848 DeclMap[var] = P;
3849 break;
3850 }
3851 case Stmt::SwitchStmtClass: {
3852 const VarDecl *var =
3853 cast<SwitchStmt>(stmt)->getConditionVariable();
3854 if (var)
3855 DeclMap[var] = P;
3856 break;
3857 }
3858 case Stmt::CXXCatchStmtClass: {
3859 const VarDecl *var =
3860 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
3861 if (var)
3862 DeclMap[var] = P;
3863 break;
3864 }
3865 default:
3866 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003867 }
3868 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003869 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00003870 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003871 }
Ted Kremenek96a7a592011-03-01 03:15:10 +00003872
Mike Stump31feda52009-07-17 01:31:16 +00003873
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003874 virtual ~StmtPrinterHelper() {}
Mike Stump31feda52009-07-17 01:31:16 +00003875
Chris Lattnerc61089a2009-06-30 01:26:17 +00003876 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003877 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00003878 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00003879
Craig Topperb45acb82014-03-14 06:02:07 +00003880 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003881 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003882
3883 if (I == StmtMap.end())
3884 return false;
Mike Stump31feda52009-07-17 01:31:16 +00003885
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003886 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00003887 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003888 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00003889 }
Mike Stump31feda52009-07-17 01:31:16 +00003890
Ted Kremenek60983dc2010-01-19 20:52:05 +00003891 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003892 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003893 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003894
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003895 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003896 DeclMapTy::iterator I = DeclMap.find(D);
3897
3898 if (I == DeclMap.end())
3899 return false;
3900
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003901 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00003902 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003903 return false;
3904 }
3905
3906 OS << "[B" << I->second.first << "." << I->second.second << "]";
3907 return true;
3908 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003909};
Chris Lattnerc61089a2009-06-30 01:26:17 +00003910} // end anonymous namespace
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003911
Chris Lattnerc61089a2009-06-30 01:26:17 +00003912
3913namespace {
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00003914class CFGBlockTerminatorPrint
Ted Kremenek83ebcef2008-01-08 18:15:10 +00003915 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Mike Stump31feda52009-07-17 01:31:16 +00003916
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003917 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003918 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00003919 PrintingPolicy Policy;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003920public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003921 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00003922 const PrintingPolicy &Policy)
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00003923 : OS(os), Helper(helper), Policy(Policy) {
3924 this->Policy.IncludeNewlines = false;
3925 }
Mike Stump31feda52009-07-17 01:31:16 +00003926
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003927 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003928 OS << "if ";
Douglas Gregor7de59662009-05-29 20:38:28 +00003929 I->getCond()->printPretty(OS,Helper,Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003930 }
Mike Stump31feda52009-07-17 01:31:16 +00003931
Ted Kremenek9aae5132007-08-23 21:42:29 +00003932 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003933 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003934 Terminator->printPretty(OS, Helper, Policy);
3935 }
3936
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00003937 void VisitDeclStmt(DeclStmt *DS) {
3938 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
3939 OS << "static init " << VD->getName();
3940 }
3941
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003942 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003943 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00003944 if (F->getInit())
3945 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00003946 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003947 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00003948 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00003949 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00003950 if (F->getInc())
3951 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00003952 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00003953 }
Mike Stump31feda52009-07-17 01:31:16 +00003954
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003955 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003956 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003957 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00003958 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003959 }
Mike Stump31feda52009-07-17 01:31:16 +00003960
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003961 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003962 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003963 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00003964 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00003965 }
Mike Stump31feda52009-07-17 01:31:16 +00003966
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003967 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00003968 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00003969 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00003970 }
Mike Stump31feda52009-07-17 01:31:16 +00003971
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003972 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003973 OS << "try ...";
3974 }
3975
John McCallc07a0c72011-02-17 10:25:35 +00003976 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Douglas Gregor7de59662009-05-29 20:38:28 +00003977 C->getCond()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00003978 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00003979 }
Mike Stump31feda52009-07-17 01:31:16 +00003980
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003981 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00003982 OS << "__builtin_choose_expr( ";
Douglas Gregor7de59662009-05-29 20:38:28 +00003983 C->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00003984 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00003985 }
Mike Stump31feda52009-07-17 01:31:16 +00003986
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003987 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003988 OS << "goto *";
Douglas Gregor7de59662009-05-29 20:38:28 +00003989 I->getTarget()->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003990 }
Mike Stump31feda52009-07-17 01:31:16 +00003991
Ted Kremenek7f7dd762007-08-31 21:49:40 +00003992 void VisitBinaryOperator(BinaryOperator* B) {
3993 if (!B->isLogicalOp()) {
3994 VisitExpr(B);
3995 return;
3996 }
Mike Stump31feda52009-07-17 01:31:16 +00003997
Douglas Gregor7de59662009-05-29 20:38:28 +00003998 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00003999
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004000 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004001 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004002 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004003 return;
John McCalle3027922010-08-25 11:45:40 +00004004 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004005 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004006 return;
4007 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004008 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004009 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004010 }
Mike Stump31feda52009-07-17 01:31:16 +00004011
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004012 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004013 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004014 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004015
4016public:
4017 void print(CFGTerminator T) {
4018 if (T.isTemporaryDtorsBranch())
4019 OS << "(Temp Dtor) ";
4020 Visit(T.getStmt());
4021 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004022};
Chris Lattnerc61089a2009-06-30 01:26:17 +00004023} // end anonymous namespace
4024
Aaron Ballmanff924b02013-11-18 20:11:50 +00004025static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00004026 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004027 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4028 const Stmt *S = CS->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004029
Aaron Ballmanff924b02013-11-18 20:11:50 +00004030 // special printing for statement-expressions.
4031 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
4032 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00004033
Aaron Ballmanff924b02013-11-18 20:11:50 +00004034 if (Sub->children()) {
4035 OS << "({ ... ; ";
4036 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
4037 OS << " })\n";
4038 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004039 }
4040 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00004041 // special printing for comma expressions.
4042 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
4043 if (B->getOpcode() == BO_Comma) {
4044 OS << "... , ";
4045 Helper.handledStmt(B->getRHS(),OS);
4046 OS << '\n';
4047 return;
4048 }
4049 }
4050 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00004051
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004052 if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004053 OS << " (OperatorCall)";
Ted Kremenek0ffba932011-12-21 19:32:38 +00004054 }
4055 else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004056 OS << " (BindTemporary)";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004057 }
Ted Kremenek1a7648b2011-12-21 19:39:59 +00004058 else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
4059 OS << " (CXXConstructExpr, " << CCE->getType().getAsString() << ")";
4060 }
Ted Kremenek0ffba932011-12-21 19:32:38 +00004061 else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
4062 OS << " (" << CE->getStmtClassName() << ", "
4063 << CE->getCastKindName()
4064 << ", " << CE->getType().getAsString()
4065 << ")";
4066 }
Mike Stump31feda52009-07-17 01:31:16 +00004067
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004068 // Expressions need a newline.
4069 if (isa<Expr>(S))
4070 OS << '\n';
Ted Kremenek0f5d8bc2010-08-31 18:47:37 +00004071
David Blaikie00be69a2013-02-23 00:29:34 +00004072 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
4073 const CXXCtorInitializer *I = IE->getInitializer();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004074 if (I->isBaseInitializer())
4075 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
Jordan Rose69d0aed2013-10-22 23:19:47 +00004076 else if (I->isDelegatingInitializer())
4077 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
Francois Pichetd583da02010-12-04 09:14:42 +00004078 else OS << I->getAnyMember()->getName();
Mike Stump31feda52009-07-17 01:31:16 +00004079
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004080 OS << "(";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004081 if (Expr *IE = I->getInit())
Aaron Ballmanff924b02013-11-18 20:11:50 +00004082 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004083 OS << ")";
4084
4085 if (I->isBaseInitializer())
4086 OS << " (Base initializer)\n";
Jordan Rose69d0aed2013-10-22 23:19:47 +00004087 else if (I->isDelegatingInitializer())
4088 OS << " (Delegating initializer)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004089 else OS << " (Member initializer)\n";
4090
David Blaikie00be69a2013-02-23 00:29:34 +00004091 } else if (Optional<CFGAutomaticObjDtor> DE =
4092 E.getAs<CFGAutomaticObjDtor>()) {
4093 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00004094 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004095
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00004096 const Type* T = VD->getType().getTypePtr();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004097 if (const ReferenceType* RT = T->getAs<ReferenceType>())
4098 T = RT->getPointeeType().getTypePtr();
Richard Smithf676e452012-07-24 21:02:14 +00004099 T = T->getBaseElementTypeUnsafe();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004100
4101 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
4102 OS << " (Implicit destructor)\n";
Marcin Swiderski20b88732010-10-05 05:37:00 +00004103
Jordan Rosec9176072014-01-13 17:59:19 +00004104 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
4105 OS << "CFGNewAllocator(";
4106 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
4107 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
4108 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00004109 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
4110 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
4111 if (!RD)
4112 return;
4113 CXXDeleteExpr *DelExpr =
4114 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00004115 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00004116 OS << "->~" << RD->getName().str() << "()";
4117 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004118 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
4119 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004120 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004121 OS << " (Base object destructor)\n";
Marcin Swiderski20b88732010-10-05 05:37:00 +00004122
David Blaikie00be69a2013-02-23 00:29:34 +00004123 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
4124 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00004125 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004126 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00004127 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004128 OS << " (Member object destructor)\n";
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004129
David Blaikie00be69a2013-02-23 00:29:34 +00004130 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
4131 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00004132 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004133 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00004134 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004135 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004136}
Mike Stump31feda52009-07-17 01:31:16 +00004137
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004138static void print_block(raw_ostream &OS, const CFG* cfg,
4139 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00004140 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004141 bool ShowColors) {
Mike Stump31feda52009-07-17 01:31:16 +00004142
Aaron Ballmanff924b02013-11-18 20:11:50 +00004143 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00004144
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004145 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004146 if (ShowColors)
4147 OS.changeColor(raw_ostream::YELLOW, true);
4148
4149 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00004150
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004151 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004152 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004153 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004154 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004155 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004156 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00004157 else if (B.hasNoReturnElement())
4158 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004159 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00004160 OS << "]\n";
4161
4162 if (ShowColors)
4163 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00004164
Ted Kremenek71eca012007-08-29 23:20:49 +00004165 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004166 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004167
4168 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004169 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004170
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004171 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004172 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004173 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00004174 OS << "case ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004175 C->getLHS()->printPretty(OS, &Helper,
4176 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004177 if (C->getRHS()) {
4178 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004179 C->getRHS()->printPretty(OS, &Helper,
4180 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004181 }
Mike Stump92244b02010-01-19 22:00:14 +00004182 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004183 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00004184 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004185 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00004186 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00004187 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00004188 0);
4189 else
4190 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004191 OS << ")";
4192
4193 } else
David Blaikie83d382b2011-09-23 05:06:16 +00004194 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00004195
Ted Kremenek71eca012007-08-29 23:20:49 +00004196 OS << ":\n";
4197 }
Mike Stump31feda52009-07-17 01:31:16 +00004198
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004199 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004200 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00004201
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004202 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
4203 I != E ; ++I, ++j ) {
Mike Stump31feda52009-07-17 01:31:16 +00004204
Ted Kremenek71eca012007-08-29 23:20:49 +00004205 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004206 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004207 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004208
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004209 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00004210
Aaron Ballmanff924b02013-11-18 20:11:50 +00004211 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00004212
Ted Kremenek72be32a2011-12-22 23:33:52 +00004213 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004214 }
Mike Stump31feda52009-07-17 01:31:16 +00004215
Ted Kremenek71eca012007-08-29 23:20:49 +00004216 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004217 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00004218 if (ShowColors)
4219 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00004220
Ted Kremenek72be32a2011-12-22 23:33:52 +00004221 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00004222
Aaron Ballmanff924b02013-11-18 20:11:50 +00004223 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00004224
Aaron Ballmanff924b02013-11-18 20:11:50 +00004225 PrintingPolicy PP(Helper.getLangOpts());
4226 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00004227 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004228 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00004229
4230 if (ShowColors)
4231 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004232 }
Mike Stump31feda52009-07-17 01:31:16 +00004233
Ted Kremenek71eca012007-08-29 23:20:49 +00004234 if (print_edges) {
4235 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004236 if (!B.pred_empty()) {
4237 const raw_ostream::Colors Color = raw_ostream::BLUE;
4238 if (ShowColors)
4239 OS.changeColor(Color);
4240 OS << " Preds " ;
4241 if (ShowColors)
4242 OS.resetColor();
4243 OS << '(' << B.pred_size() << "):";
4244 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00004245
Ted Kremenek72be32a2011-12-22 23:33:52 +00004246 if (ShowColors)
4247 OS.changeColor(Color);
4248
4249 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
4250 I != E; ++I, ++i) {
Mike Stump31feda52009-07-17 01:31:16 +00004251
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004252 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004253 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00004254
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004255 CFGBlock *B = *I;
4256 bool Reachable = true;
4257 if (!B) {
4258 Reachable = false;
4259 B = I->getPossiblyUnreachableBlock();
4260 }
4261
4262 OS << " B" << B->getBlockID();
4263 if (!Reachable)
4264 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00004265 }
4266
4267 if (ShowColors)
4268 OS.resetColor();
4269
4270 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00004271 }
Mike Stump31feda52009-07-17 01:31:16 +00004272
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004273 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004274 if (!B.succ_empty()) {
4275 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
4276 if (ShowColors)
4277 OS.changeColor(Color);
4278 OS << " Succs ";
4279 if (ShowColors)
4280 OS.resetColor();
4281 OS << '(' << B.succ_size() << "):";
4282 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004283
Ted Kremenek72be32a2011-12-22 23:33:52 +00004284 if (ShowColors)
4285 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00004286
Ted Kremenek72be32a2011-12-22 23:33:52 +00004287 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
4288 I != E; ++I, ++i) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004289
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004290 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004291 OS << "\n ";
4292
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004293 CFGBlock *B = *I;
4294
4295 bool Reachable = true;
4296 if (!B) {
4297 Reachable = false;
4298 B = I->getPossiblyUnreachableBlock();
4299 }
4300
4301 if (B) {
4302 OS << " B" << B->getBlockID();
4303 if (!Reachable)
4304 OS << "(Unreachable)";
4305 }
4306 else {
4307 OS << " NULL";
4308 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00004309 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004310
Ted Kremenek72be32a2011-12-22 23:33:52 +00004311 if (ShowColors)
4312 OS.resetColor();
4313 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004314 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004315 }
Mike Stump31feda52009-07-17 01:31:16 +00004316}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004317
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004318
4319/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004320void CFG::dump(const LangOptions &LO, bool ShowColors) const {
4321 print(llvm::errs(), LO, ShowColors);
4322}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004323
4324/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004325void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00004326 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00004327
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004328 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00004329 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00004330
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004331 // Iterate through the CFGBlocks and print them one by one.
4332 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
4333 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004334 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004335 continue;
Mike Stump31feda52009-07-17 01:31:16 +00004336
Aaron Ballmanff924b02013-11-18 20:11:50 +00004337 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004338 }
Mike Stump31feda52009-07-17 01:31:16 +00004339
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004340 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00004341 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00004342 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00004343 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00004344}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004345
4346/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004347void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
4348 bool ShowColors) const {
4349 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00004350}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004351
4352/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
4353/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004354void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004355 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00004356 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00004357 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00004358 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00004359}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004360
Ted Kremenek15647632008-01-30 23:02:42 +00004361/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004362void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00004363 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00004364 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00004365 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004366}
4367
Ted Kremenekec3bbf42014-03-29 00:35:20 +00004368Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00004369 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004370 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00004371 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004372
Craig Topper25542942014-05-20 04:30:07 +00004373 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004374
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004375 switch (Terminator->getStmtClass()) {
4376 default:
4377 break;
Mike Stump31feda52009-07-17 01:31:16 +00004378
Jordan Rosecf10ea82013-06-06 21:53:45 +00004379 case Stmt::CXXForRangeStmtClass:
4380 E = cast<CXXForRangeStmt>(Terminator)->getCond();
4381 break;
4382
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004383 case Stmt::ForStmtClass:
4384 E = cast<ForStmt>(Terminator)->getCond();
4385 break;
Mike Stump31feda52009-07-17 01:31:16 +00004386
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004387 case Stmt::WhileStmtClass:
4388 E = cast<WhileStmt>(Terminator)->getCond();
4389 break;
Mike Stump31feda52009-07-17 01:31:16 +00004390
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004391 case Stmt::DoStmtClass:
4392 E = cast<DoStmt>(Terminator)->getCond();
4393 break;
Mike Stump31feda52009-07-17 01:31:16 +00004394
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004395 case Stmt::IfStmtClass:
4396 E = cast<IfStmt>(Terminator)->getCond();
4397 break;
Mike Stump31feda52009-07-17 01:31:16 +00004398
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004399 case Stmt::ChooseExprClass:
4400 E = cast<ChooseExpr>(Terminator)->getCond();
4401 break;
Mike Stump31feda52009-07-17 01:31:16 +00004402
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004403 case Stmt::IndirectGotoStmtClass:
4404 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
4405 break;
Mike Stump31feda52009-07-17 01:31:16 +00004406
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004407 case Stmt::SwitchStmtClass:
4408 E = cast<SwitchStmt>(Terminator)->getCond();
4409 break;
Mike Stump31feda52009-07-17 01:31:16 +00004410
John McCallc07a0c72011-02-17 10:25:35 +00004411 case Stmt::BinaryConditionalOperatorClass:
4412 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
4413 break;
4414
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004415 case Stmt::ConditionalOperatorClass:
4416 E = cast<ConditionalOperator>(Terminator)->getCond();
4417 break;
Mike Stump31feda52009-07-17 01:31:16 +00004418
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004419 case Stmt::BinaryOperatorClass: // '&&' and '||'
4420 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00004421 break;
Mike Stump31feda52009-07-17 01:31:16 +00004422
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00004423 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00004424 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004425 }
Mike Stump31feda52009-07-17 01:31:16 +00004426
Ted Kremenekec3bbf42014-03-29 00:35:20 +00004427 if (!StripParens)
4428 return E;
4429
Craig Topper25542942014-05-20 04:30:07 +00004430 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004431}
4432
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004433//===----------------------------------------------------------------------===//
4434// CFG Graphviz Visualization
4435//===----------------------------------------------------------------------===//
4436
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004437
4438#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00004439static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004440#endif
4441
Chris Lattnerc61089a2009-06-30 01:26:17 +00004442void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004443#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00004444 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004445 GraphHelper = &H;
4446 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00004447 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004448#endif
4449}
4450
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004451namespace llvm {
4452template<>
4453struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Tobias Grosser9fc223a2009-11-30 14:16:05 +00004454
4455 DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
4456
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004457 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004458
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00004459#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004460 std::string OutSStr;
4461 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00004462 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004463 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004464
4465 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
4466
4467 // Process string output to make it nicer...
4468 for (unsigned i = 0; i != OutStr.length(); ++i)
4469 if (OutStr[i] == '\n') { // Left justify
4470 OutStr[i] = '\\';
4471 OutStr.insert(OutStr.begin()+i+1, 'l');
4472 }
Mike Stump31feda52009-07-17 01:31:16 +00004473
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004474 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00004475#else
4476 return "";
4477#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004478 }
4479};
4480} // end namespace llvm