blob: 3139ae4c5d3b64ab14b87085f42d36c8915c8522 [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
537 /// Find a equality comparison with an expression evaluating to a boolean and
538 /// a constant other than 0 and 1.
539 /// e.g. if (!x == 10)
540 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
541 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
542 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
543
544 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
545 const Expr *BoolExpr = RHSExpr;
546
547 if (!IntLiteral) {
548 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
549 BoolExpr = LHSExpr;
550 }
551
552 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
553 return TryResult();
554
555 llvm::APInt IntValue = IntLiteral->getValue();
556 if ((IntValue == 1) || (IntValue == 0)) {
557 return TryResult();
558 }
559
560 return TryResult(B->getOpcode() != BO_EQ);
561 }
562
563 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
564 const llvm::APSInt &Value1,
565 const llvm::APSInt &Value2) {
566 assert(Value1.isSigned() == Value2.isSigned());
567 switch (Relation) {
568 default:
569 return TryResult();
570 case BO_EQ:
571 return TryResult(Value1 == Value2);
572 case BO_NE:
573 return TryResult(Value1 != Value2);
574 case BO_LT:
575 return TryResult(Value1 < Value2);
576 case BO_LE:
577 return TryResult(Value1 <= Value2);
578 case BO_GT:
579 return TryResult(Value1 > Value2);
580 case BO_GE:
581 return TryResult(Value1 >= Value2);
582 }
583 }
584
585 /// \brief Find a pair of comparison expressions with or without parentheses
586 /// with a shared variable and constants and a logical operator between them
587 /// that always evaluates to either true or false.
588 /// e.g. if (x != 3 || x != 4)
589 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
590 assert(B->isLogicalOp());
591 const BinaryOperator *LHS =
592 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
593 const BinaryOperator *RHS =
594 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
595 if (!LHS || !RHS)
596 return TryResult();
597
598 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
599 return TryResult();
600
601 BinaryOperatorKind BO1 = LHS->getOpcode();
602 const DeclRefExpr *Decl1 =
603 dyn_cast<DeclRefExpr>(LHS->getLHS()->IgnoreParenImpCasts());
604 const IntegerLiteral *Literal1 =
605 dyn_cast<IntegerLiteral>(LHS->getRHS()->IgnoreParens());
606 if (!Decl1 && !Literal1) {
607 if (BO1 == BO_GT)
608 BO1 = BO_LT;
609 else if (BO1 == BO_GE)
610 BO1 = BO_LE;
611 else if (BO1 == BO_LT)
612 BO1 = BO_GT;
613 else if (BO1 == BO_LE)
614 BO1 = BO_GE;
615 Decl1 = dyn_cast<DeclRefExpr>(LHS->getRHS()->IgnoreParenImpCasts());
616 Literal1 = dyn_cast<IntegerLiteral>(LHS->getLHS()->IgnoreParens());
617 }
618
619 if (!Decl1 || !Literal1)
620 return TryResult();
621
622 BinaryOperatorKind BO2 = RHS->getOpcode();
623 const DeclRefExpr *Decl2 =
624 dyn_cast<DeclRefExpr>(RHS->getLHS()->IgnoreParenImpCasts());
625 const IntegerLiteral *Literal2 =
626 dyn_cast<IntegerLiteral>(RHS->getRHS()->IgnoreParens());
627 if (!Decl2 && !Literal2) {
628 if (BO2 == BO_GT)
629 BO2 = BO_LT;
630 else if (BO2 == BO_GE)
631 BO2 = BO_LE;
632 else if (BO2 == BO_LT)
633 BO2 = BO_GT;
634 else if (BO2 == BO_LE)
635 BO2 = BO_GE;
636 Decl2 = dyn_cast<DeclRefExpr>(RHS->getRHS()->IgnoreParenImpCasts());
637 Literal2 = dyn_cast<IntegerLiteral>(RHS->getLHS()->IgnoreParens());
638 }
639
640 if (!Decl2 || !Literal2)
641 return TryResult();
642
643 // Check that it is the same variable on both sides.
644 if (Decl1->getDecl() != Decl2->getDecl())
645 return TryResult();
646
647 llvm::APSInt L1, L2;
648
649 if (!Literal1->EvaluateAsInt(L1, *Context) ||
650 !Literal2->EvaluateAsInt(L2, *Context))
651 return TryResult();
652
653 // Can't compare signed with unsigned or with different bit width.
654 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
655 return TryResult();
656
657 // Values that will be used to determine if result of logical
658 // operator is always true/false
659 const llvm::APSInt Values[] = {
660 // Value less than both Value1 and Value2
661 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
662 // L1
663 L1,
664 // Value between Value1 and Value2
665 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
666 L1.isUnsigned()),
667 // L2
668 L2,
669 // Value greater than both Value1 and Value2
670 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
671 };
672
673 // Check whether expression is always true/false by evaluating the following
674 // * variable x is less than the smallest literal.
675 // * variable x is equal to the smallest literal.
676 // * Variable x is between smallest and largest literal.
677 // * Variable x is equal to the largest literal.
678 // * Variable x is greater than largest literal.
679 bool AlwaysTrue = true, AlwaysFalse = true;
680 for (unsigned int ValueIndex = 0;
681 ValueIndex < sizeof(Values) / sizeof(Values[0]);
682 ++ValueIndex) {
683 llvm::APSInt Value = Values[ValueIndex];
684 TryResult Res1, Res2;
685 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
686 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
687
688 if (!Res1.isKnown() || !Res2.isKnown())
689 return TryResult();
690
691 if (B->getOpcode() == BO_LAnd) {
692 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
693 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
694 } else {
695 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
696 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
697 }
698 }
699
700 if (AlwaysTrue || AlwaysFalse) {
701 if (BuildOpts.Observer)
702 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
703 return TryResult(AlwaysTrue);
704 }
705 return TryResult();
706 }
707
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000708 /// Try and evaluate an expression to an integer constant.
709 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
710 if (!BuildOpts.PruneTriviallyFalseEdges)
711 return false;
712 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +0000713 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +0000714 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000715 }
Mike Stump11289f42009-09-09 15:08:12 +0000716
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000717 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +0000718 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000719 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +0000720 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000721 S->isTypeDependent() || S->isValueDependent())
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000722 return TryResult();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000723
724 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
725 if (Bop->isLogicalOp()) {
726 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000727 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
728 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000729 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +0000730
731 // Retrieve result at first, or the map might be updated.
732 TryResult Result = evaluateAsBooleanConditionNoCache(S);
733 CachedBoolEvals[S] = Result; // update or insert
734 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000735 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +0000736 else {
737 switch (Bop->getOpcode()) {
738 default: break;
739 // For 'x & 0' and 'x * 0', we can determine that
740 // the value is always false.
741 case BO_Mul:
742 case BO_And: {
743 // If either operand is zero, we know the value
744 // must be false.
745 llvm::APSInt IntVal;
746 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
747 if (IntVal.getBoolValue() == false) {
748 return TryResult(false);
749 }
750 }
751 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
752 if (IntVal.getBoolValue() == false) {
753 return TryResult(false);
754 }
755 }
756 }
757 break;
758 }
759 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000760 }
761
762 return evaluateAsBooleanConditionNoCache(S);
763 }
764
765 /// \brief Evaluate as boolean \param E without using the cache.
766 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
767 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
768 if (Bop->isLogicalOp()) {
769 TryResult LHS = tryEvaluateBool(Bop->getLHS());
770 if (LHS.isKnown()) {
771 // We were able to evaluate the LHS, see if we can get away with not
772 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
773 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
774 return LHS.isTrue();
775
776 TryResult RHS = tryEvaluateBool(Bop->getRHS());
777 if (RHS.isKnown()) {
778 if (Bop->getOpcode() == BO_LOr)
779 return LHS.isTrue() || RHS.isTrue();
780 else
781 return LHS.isTrue() && RHS.isTrue();
782 }
783 } else {
784 TryResult RHS = tryEvaluateBool(Bop->getRHS());
785 if (RHS.isKnown()) {
786 // We can't evaluate the LHS; however, sometimes the result
787 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
788 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
789 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +0000790 } else {
791 TryResult BopRes = checkIncorrectLogicOperator(Bop);
792 if (BopRes.isKnown())
793 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000794 }
795 }
796
797 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000798 } else if (Bop->isEqualityOp()) {
799 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
800 if (BopRes.isKnown())
801 return BopRes.isTrue();
802 } else if (Bop->isRelationalOp()) {
803 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
804 if (BopRes.isKnown())
805 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000806 }
807 }
808
809 bool Result;
810 if (E->EvaluateAsBooleanCondition(Result, *Context))
811 return Result;
812
813 return TryResult();
Mike Stump773582d2009-07-23 23:25:26 +0000814 }
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000815
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000816};
Mike Stump31feda52009-07-17 01:31:16 +0000817
Ted Kremeneka099c592011-03-10 03:50:34 +0000818inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
819 const Stmt *stmt) const {
820 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
821}
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000822
Ted Kremeneka099c592011-03-10 03:50:34 +0000823bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000824 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
825
Ted Kremeneka099c592011-03-10 03:50:34 +0000826 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +0000827 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000828
829 if (lastLookup == stmt) {
830 if (cachedEntry) {
831 assert(cachedEntry->first == stmt);
832 return true;
833 }
Ted Kremenek8b46c002011-07-19 14:18:43 +0000834 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000835 }
Ted Kremeneka099c592011-03-10 03:50:34 +0000836
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000837 lastLookup = stmt;
838
839 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +0000840 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
841
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000842 if (!fb) {
843 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +0000844 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +0000845 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000846 }
Ted Kremeneka099c592011-03-10 03:50:34 +0000847
848 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000849 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +0000850 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +0000851 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000852 }
853
Ted Kremeneka099c592011-03-10 03:50:34 +0000854 cachedEntry = &*itr;
855 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +0000856}
857
Douglas Gregor4619e432008-12-05 23:32:09 +0000858// FIXME: Add support for dependent-sized array types in C++?
859// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +0000860static const VariableArrayType *FindVA(const Type *t) {
861 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
862 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000863 if (vat->getSizeExpr())
864 return vat;
Mike Stump31feda52009-07-17 01:31:16 +0000865
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000866 t = vt->getElementType().getTypePtr();
867 }
Mike Stump31feda52009-07-17 01:31:16 +0000868
Craig Topper25542942014-05-20 04:30:07 +0000869 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000870}
Mike Stump31feda52009-07-17 01:31:16 +0000871
872/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
873/// arbitrary statement. Examples include a single expression or a function
874/// body (compound statement). The ownership of the returned CFG is
875/// transferred to the caller. If CFG construction fails, this method returns
876/// NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000877CFG* CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +0000878 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +0000879 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +0000880 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +0000881
Mike Stump31feda52009-07-17 01:31:16 +0000882 // Create an empty block that will serve as the exit block for the CFG. Since
883 // this is the first block added to the CFG, it will be implicitly registered
884 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +0000885 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000886 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +0000887 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +0000888
Marcin Swiderski20b88732010-10-05 05:37:00 +0000889 if (BuildOpts.AddImplicitDtors)
890 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
891 addImplicitDtorsForDestructor(DD);
892
Ted Kremenek9aae5132007-08-23 21:42:29 +0000893 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000894 CFGBlock *B = addStmt(Statement);
895
896 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +0000897 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000898
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000899 // For C++ constructor add initializers to CFG.
900 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
901 for (CXXConstructorDecl::init_const_reverse_iterator I = CD->init_rbegin(),
902 E = CD->init_rend(); I != E; ++I) {
903 B = addInitializer(*I);
904 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +0000905 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000906 }
907 }
908
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000909 if (B)
910 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +0000911
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000912 // Backpatch the gotos whose label -> block mappings we didn't know when we
913 // encountered them.
914 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
915 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +0000916
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000917 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +0000918 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000919 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +0000920
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000921 // If there is no target for the goto, then we are looking at an
922 // incomplete AST. Handle this by not registering a successor.
923 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +0000924
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000925 JumpTarget JT = LI->second;
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000926 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
927 JT.scopePosition);
928 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000929 }
930
931 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000932 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000933 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
934 E = AddressTakenLabels.end(); I != E; ++I ) {
935
936 // Lookup the target block.
937 LabelMapTy::iterator LI = LabelMap.find(*I);
938
939 // If there is no target block that contains label, then we are looking
940 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +0000941 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000942
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000943 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +0000944 }
Mike Stump31feda52009-07-17 01:31:16 +0000945
Mike Stump31feda52009-07-17 01:31:16 +0000946 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +0000947 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +0000948
Ahmed Charles9a16beb2014-03-07 19:33:25 +0000949 return cfg.release();
Ted Kremenek9aae5132007-08-23 21:42:29 +0000950}
Mike Stump31feda52009-07-17 01:31:16 +0000951
Ted Kremenek9aae5132007-08-23 21:42:29 +0000952/// createBlock - Used to lazily create blocks that are connected
953/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000954CFGBlock *CFGBuilder::createBlock(bool add_successor) {
955 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +0000956 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000957 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +0000958 return B;
959}
Mike Stump31feda52009-07-17 01:31:16 +0000960
Chandler Carrutha70991b2011-09-13 09:13:49 +0000961/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
962/// CFG. It is *not* connected to the current (global) successor, and instead
963/// directly tied to the exit block in order to be reachable.
964CFGBlock *CFGBuilder::createNoReturnBlock() {
965 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +0000966 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +0000967 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000968 return B;
969}
970
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000971/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +0000972CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000973 if (!BuildOpts.AddInitializers)
974 return Block;
975
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000976 bool IsReference = false;
977 bool HasTemporaries = false;
978
979 // Destructors of temporaries in initialization expression should be called
980 // after initialization finishes.
981 Expr *Init = I->getInit();
982 if (Init) {
Francois Pichetd583da02010-12-04 09:14:42 +0000983 if (FieldDecl *FD = I->getAnyMember())
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000984 IsReference = FD->getType()->isReferenceType();
John McCall5d413782010-12-06 08:20:24 +0000985 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000986
Jordan Rose6d671cc2012-09-05 22:55:23 +0000987 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000988 // Generate destructors for temporaries in initialization expression.
John McCall5d413782010-12-06 08:20:24 +0000989 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000990 IsReference);
991 }
992 }
993
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000994 autoCreateBlock();
995 appendInitializer(Block, I);
996
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000997 if (Init) {
Ted Kremenek8219b822010-12-16 07:46:53 +0000998 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000999 // For expression with temporaries go directly to subexpression to omit
1000 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001001 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1002 }
1003 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001004 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001005
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001006 return Block;
1007}
1008
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001009/// \brief Retrieve the type of the temporary object whose lifetime was
1010/// extended by a local reference with the given initializer.
1011static QualType getReferenceInitTemporaryType(ASTContext &Context,
1012 const Expr *Init) {
1013 while (true) {
1014 // Skip parentheses.
1015 Init = Init->IgnoreParens();
1016
1017 // Skip through cleanups.
1018 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1019 Init = EWC->getSubExpr();
1020 continue;
1021 }
1022
1023 // Skip through the temporary-materialization expression.
1024 if (const MaterializeTemporaryExpr *MTE
1025 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1026 Init = MTE->GetTemporaryExpr();
1027 continue;
1028 }
1029
1030 // Skip derived-to-base and no-op casts.
1031 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) {
1032 if ((CE->getCastKind() == CK_DerivedToBase ||
1033 CE->getCastKind() == CK_UncheckedDerivedToBase ||
1034 CE->getCastKind() == CK_NoOp) &&
1035 Init->getType()->isRecordType()) {
1036 Init = CE->getSubExpr();
1037 continue;
1038 }
1039 }
1040
1041 // Skip member accesses into rvalues.
1042 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) {
1043 if (!ME->isArrow() && ME->getBase()->isRValue()) {
1044 Init = ME->getBase();
1045 continue;
1046 }
1047 }
1048
1049 break;
1050 }
1051
1052 return Init->getType();
1053}
1054
Marcin Swiderski5e415732010-09-30 23:05:00 +00001055/// addAutomaticObjDtors - Add to current block automatic objects destructors
1056/// for objects in range of local scope positions. Use S as trigger statement
1057/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001058void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001059 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001060 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001061 return;
1062
Marcin Swiderski5e415732010-09-30 23:05:00 +00001063 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001064 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001065
Chandler Carruthad747252011-09-13 06:09:01 +00001066 // We need to append the destructors in reverse order, but any one of them
1067 // may be a no-return destructor which changes the CFG. As a result, buffer
1068 // this sequence up and replay them in reverse order when appending onto the
1069 // CFGBlock(s).
1070 SmallVector<VarDecl*, 10> Decls;
1071 Decls.reserve(B.distance(E));
1072 for (LocalScope::const_iterator I = B; I != E; ++I)
1073 Decls.push_back(*I);
1074
1075 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1076 E = Decls.rend();
1077 I != E; ++I) {
1078 // If this destructor is marked as a no-return destructor, we need to
1079 // create a new block for the destructor which does not have as a successor
1080 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001081 QualType Ty = (*I)->getType();
1082 if (Ty->isReferenceType()) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001083 Ty = getReferenceInitTemporaryType(*Context, (*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001084 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001085 Ty = Context->getBaseElementType(Ty);
1086
Chandler Carruthad747252011-09-13 06:09:01 +00001087 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
Richard Smith10876ef2013-01-17 01:30:42 +00001088 if (Dtor->isNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001089 Block = createNoReturnBlock();
1090 else
Chandler Carruthad747252011-09-13 06:09:01 +00001091 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001092
1093 appendAutomaticObjDtor(Block, *I, S);
1094 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001095}
1096
Marcin Swiderski20b88732010-10-05 05:37:00 +00001097/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1098/// base and member objects in destructor.
1099void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
1100 assert (BuildOpts.AddImplicitDtors
1101 && "Can be called only when dtors should be added");
1102 const CXXRecordDecl *RD = DD->getParent();
1103
1104 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001105 for (const auto &VI : RD->vbases()) {
1106 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001107 if (!CD->hasTrivialDestructor()) {
1108 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001109 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001110 }
1111 }
1112
1113 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001114 for (const auto &BI : RD->bases()) {
1115 if (!BI.isVirtual()) {
1116 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001117 if (!CD->hasTrivialDestructor()) {
1118 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001119 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001120 }
1121 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001122 }
1123
1124 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001125 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001126 // Check for constant size array. Set type to array element type.
1127 QualType QT = FI->getType();
1128 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1129 if (AT->getSize() == 0)
1130 continue;
1131 QT = AT->getElementType();
1132 }
1133
1134 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001135 if (!CD->hasTrivialDestructor()) {
1136 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001137 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001138 }
1139 }
1140}
1141
Marcin Swiderski5e415732010-09-30 23:05:00 +00001142/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1143/// way return valid LocalScope object.
1144LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
1145 if (!Scope) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +00001146 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1147 Scope = alloc.Allocate<LocalScope>();
1148 BumpVectorContext ctx(alloc);
1149 new (Scope) LocalScope(ctx, ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001150 }
1151 return Scope;
1152}
1153
1154/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +00001155/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001156void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001157 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001158 return;
1159
Craig Topper25542942014-05-20 04:30:07 +00001160 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001161
1162 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001163 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001164 for (auto *BI : CS->body()) {
1165 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001166 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001167 Scope = addLocalScopeForDeclStmt(DS, Scope);
1168 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001169 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001170 }
1171
1172 // For any other statement scope will be implicit and as such will be
1173 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001174 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001175 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001176}
1177
1178/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1179/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001180LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001181 LocalScope* Scope) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001182 if (!BuildOpts.AddImplicitDtors)
1183 return Scope;
1184
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001185 for (auto *DI : DS->decls())
1186 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001187 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001188 return Scope;
1189}
1190
1191/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1192/// create add scope for automatic objects and temporary objects bound to
1193/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001194LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001195 LocalScope* Scope) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001196 if (!BuildOpts.AddImplicitDtors)
1197 return Scope;
1198
1199 // Check if variable is local.
1200 switch (VD->getStorageClass()) {
1201 case SC_None:
1202 case SC_Auto:
1203 case SC_Register:
1204 break;
1205 default: return Scope;
1206 }
1207
1208 // Check for const references bound to temporary. Set type to pointee.
1209 QualType QT = VD->getType();
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001210 if (QT.getTypePtr()->isReferenceType()) {
Richard Smith5a0ef782013-06-27 21:43:17 +00001211 // Attempt to determine whether this declaration lifetime-extends a
1212 // temporary.
1213 //
1214 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1215 // temporaries, and a single declaration can extend multiple temporaries.
1216 // We should look at the storage duration on each nested
1217 // MaterializeTemporaryExpr instead.
1218 const Expr *Init = VD->getInit();
1219 if (!Init)
1220 return Scope;
1221 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init))
1222 Init = EWC->getSubExpr();
1223 if (!isa<MaterializeTemporaryExpr>(Init))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001224 return Scope;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001225
Richard Smith5a0ef782013-06-27 21:43:17 +00001226 // Lifetime-extending a temporary.
1227 QT = getReferenceInitTemporaryType(*Context, Init);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001228 }
1229
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001230 // Check for constant size array. Set type to array element type.
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001231 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001232 if (AT->getSize() == 0)
1233 return Scope;
1234 QT = AT->getElementType();
1235 }
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001236
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001237 // Check if type is a C++ class with non-trivial destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001238 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
David Blaikie0f2ae782012-01-24 04:51:48 +00001239 if (!CD->hasTrivialDestructor()) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001240 // Add the variable to scope
1241 Scope = createOrReuseLocalScope(Scope);
1242 Scope->addVar(VD);
1243 ScopePos = Scope->begin();
1244 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001245 return Scope;
1246}
1247
1248/// addLocalScopeAndDtors - For given statement add local scope for it and
1249/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001250void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001251 if (!BuildOpts.AddImplicitDtors)
1252 return;
1253
1254 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001255 addLocalScopeForStmt(S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001256 addAutomaticObjDtors(ScopePos, scopeBeginPos, S);
1257}
1258
Marcin Swiderski321a7072010-09-30 22:54:37 +00001259/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1260/// variables with automatic storage duration to CFGBlock's elements vector.
1261/// Elements will be prepended to physical beginning of the vector which
1262/// happens to be logical end. Use blocks terminator as statement that specifies
1263/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001264/// FIXME: This mechanism for adding automatic destructors doesn't handle
1265/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001266void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001267 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Chandler Carruthad747252011-09-13 06:09:01 +00001268 BumpVectorContext &C = cfg->getBumpVectorContext();
1269 CFGBlock::iterator InsertPos
1270 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1271 for (LocalScope::const_iterator I = B; I != E; ++I)
1272 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1273 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001274}
1275
Ted Kremenek93668002009-07-17 22:18:43 +00001276/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001277/// blocks for ternary operators, &&, and ||. We also process "," and
1278/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001279CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001280 if (!S) {
1281 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001282 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001283 }
Jordy Rose17347372011-06-10 08:49:37 +00001284
1285 if (Expr *E = dyn_cast<Expr>(S))
1286 S = E->IgnoreParens();
1287
Ted Kremenek93668002009-07-17 22:18:43 +00001288 switch (S->getStmtClass()) {
1289 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001290 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001291
1292 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001293 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001294
John McCallc07a0c72011-02-17 10:25:35 +00001295 case Stmt::BinaryConditionalOperatorClass:
1296 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1297
Ted Kremenek93668002009-07-17 22:18:43 +00001298 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001299 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001300
Ted Kremenek93668002009-07-17 22:18:43 +00001301 case Stmt::BlockExprClass:
Ted Kremeneke2499842012-04-12 20:03:44 +00001302 return VisitNoRecurse(cast<Expr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001303
Ted Kremenek93668002009-07-17 22:18:43 +00001304 case Stmt::BreakStmtClass:
1305 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001306
Ted Kremenek93668002009-07-17 22:18:43 +00001307 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001308 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001309 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001310 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001311 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001312
Ted Kremenek93668002009-07-17 22:18:43 +00001313 case Stmt::CaseStmtClass:
1314 return VisitCaseStmt(cast<CaseStmt>(S));
1315
1316 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001317 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001318
Ted Kremenek93668002009-07-17 22:18:43 +00001319 case Stmt::CompoundStmtClass:
1320 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001321
Ted Kremenek93668002009-07-17 22:18:43 +00001322 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001323 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001324
Ted Kremenek93668002009-07-17 22:18:43 +00001325 case Stmt::ContinueStmtClass:
1326 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001327
Ted Kremenekb27378c2010-01-19 20:40:33 +00001328 case Stmt::CXXCatchStmtClass:
1329 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1330
John McCall5d413782010-12-06 08:20:24 +00001331 case Stmt::ExprWithCleanupsClass:
1332 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001333
Jordan Rosee5d53932012-08-23 18:10:53 +00001334 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001335 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001336 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1337 // called function's declaration, not by the caller. If we simply add
1338 // this expression to the CFG, we could end up with the same Expr
1339 // appearing multiple times.
1340 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001341 //
1342 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1343 // expression to be used in the same function (through aggregate
1344 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00001345 return VisitStmt(S, asc);
1346
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001347 case Stmt::CXXBindTemporaryExprClass:
1348 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
1349
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001350 case Stmt::CXXConstructExprClass:
1351 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
1352
Jordan Rosec9176072014-01-13 17:59:19 +00001353 case Stmt::CXXNewExprClass:
1354 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
1355
Jordan Rosed2f40792013-09-03 17:00:57 +00001356 case Stmt::CXXDeleteExprClass:
1357 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
1358
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001359 case Stmt::CXXFunctionalCastExprClass:
1360 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
1361
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001362 case Stmt::CXXTemporaryObjectExprClass:
1363 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
1364
Ted Kremenekb27378c2010-01-19 20:40:33 +00001365 case Stmt::CXXThrowExprClass:
1366 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001367
Ted Kremenekb27378c2010-01-19 20:40:33 +00001368 case Stmt::CXXTryStmtClass:
1369 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001370
Richard Smith02e85f32011-04-14 22:09:26 +00001371 case Stmt::CXXForRangeStmtClass:
1372 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
1373
Ted Kremenek93668002009-07-17 22:18:43 +00001374 case Stmt::DeclStmtClass:
1375 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001376
Ted Kremenek93668002009-07-17 22:18:43 +00001377 case Stmt::DefaultStmtClass:
1378 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001379
Ted Kremenek93668002009-07-17 22:18:43 +00001380 case Stmt::DoStmtClass:
1381 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001382
Ted Kremenek93668002009-07-17 22:18:43 +00001383 case Stmt::ForStmtClass:
1384 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001385
Ted Kremenek93668002009-07-17 22:18:43 +00001386 case Stmt::GotoStmtClass:
1387 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001388
Ted Kremenek93668002009-07-17 22:18:43 +00001389 case Stmt::IfStmtClass:
1390 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001391
Ted Kremenek8219b822010-12-16 07:46:53 +00001392 case Stmt::ImplicitCastExprClass:
1393 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001394
Ted Kremenek93668002009-07-17 22:18:43 +00001395 case Stmt::IndirectGotoStmtClass:
1396 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001397
Ted Kremenek93668002009-07-17 22:18:43 +00001398 case Stmt::LabelStmtClass:
1399 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001400
Ted Kremenekda76a942012-04-12 20:34:52 +00001401 case Stmt::LambdaExprClass:
1402 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
1403
Ted Kremenek5868ec62010-04-11 17:02:10 +00001404 case Stmt::MemberExprClass:
1405 return VisitMemberExpr(cast<MemberExpr>(S), asc);
1406
Ted Kremenek04268232011-11-05 00:10:15 +00001407 case Stmt::NullStmtClass:
1408 return Block;
1409
Ted Kremenek93668002009-07-17 22:18:43 +00001410 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00001411 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
1412
Ted Kremenek5022f1d2012-03-06 23:40:47 +00001413 case Stmt::ObjCAutoreleasePoolStmtClass:
1414 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
1415
Ted Kremenek93668002009-07-17 22:18:43 +00001416 case Stmt::ObjCAtSynchronizedStmtClass:
1417 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001418
Ted Kremenek93668002009-07-17 22:18:43 +00001419 case Stmt::ObjCAtThrowStmtClass:
1420 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001421
Ted Kremenek93668002009-07-17 22:18:43 +00001422 case Stmt::ObjCAtTryStmtClass:
1423 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001424
Ted Kremenek93668002009-07-17 22:18:43 +00001425 case Stmt::ObjCForCollectionStmtClass:
1426 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001427
Ted Kremenek04268232011-11-05 00:10:15 +00001428 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00001429 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00001430
John McCallfe96e0b2011-11-06 09:01:30 +00001431 case Stmt::PseudoObjectExprClass:
1432 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
1433
Ted Kremenek93668002009-07-17 22:18:43 +00001434 case Stmt::ReturnStmtClass:
1435 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001436
Peter Collingbournee190dee2011-03-11 19:24:49 +00001437 case Stmt::UnaryExprOrTypeTraitExprClass:
1438 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
1439 asc);
Mike Stump11289f42009-09-09 15:08:12 +00001440
Ted Kremenek93668002009-07-17 22:18:43 +00001441 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001442 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001443
Ted Kremenek93668002009-07-17 22:18:43 +00001444 case Stmt::SwitchStmtClass:
1445 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001446
Zhanyong Wan6dace612010-11-22 08:45:56 +00001447 case Stmt::UnaryOperatorClass:
1448 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
1449
Ted Kremenek93668002009-07-17 22:18:43 +00001450 case Stmt::WhileStmtClass:
1451 return VisitWhileStmt(cast<WhileStmt>(S));
1452 }
1453}
Mike Stump11289f42009-09-09 15:08:12 +00001454
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001455CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001456 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001457 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001458 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00001459 }
Mike Stump11289f42009-09-09 15:08:12 +00001460
Ted Kremenek93668002009-07-17 22:18:43 +00001461 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00001462}
Mike Stump31feda52009-07-17 01:31:16 +00001463
Ted Kremenek93668002009-07-17 22:18:43 +00001464/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00001465CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
1466 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00001467
Ted Kremenek8ae67872013-02-05 22:00:19 +00001468 // Visit the children in their reverse order so that they appear in
1469 // left-to-right (natural) order in the CFG.
1470 reverse_children RChildren(S);
1471 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
1472 I != E; ++I) {
1473 if (Stmt *Child = *I)
1474 if (CFGBlock *R = Visit(Child))
1475 B = R;
1476 }
1477 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00001478}
Mike Stump11289f42009-09-09 15:08:12 +00001479
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001480CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
1481 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00001482 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00001483
Ted Kremenek7c58d352011-03-10 01:14:11 +00001484 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001485 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001486 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00001487 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001488
Ted Kremenek9aae5132007-08-23 21:42:29 +00001489 return Block;
1490}
Mike Stump11289f42009-09-09 15:08:12 +00001491
Zhanyong Wan6dace612010-11-22 08:45:56 +00001492CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00001493 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001494 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00001495 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001496 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00001497 }
1498
Ted Kremenek8219b822010-12-16 07:46:53 +00001499 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00001500}
1501
Ted Kremeneka16436f2012-07-14 05:04:06 +00001502CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
1503 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
1504 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00001505
Ted Kremeneka16436f2012-07-14 05:04:06 +00001506 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001507 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00001508
Craig Topper25542942014-05-20 04:30:07 +00001509 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
1510 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00001511}
1512
1513std::pair<CFGBlock*, CFGBlock*>
1514CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
1515 Stmt *Term,
1516 CFGBlock *TrueBlock,
1517 CFGBlock *FalseBlock) {
1518
1519 // Introspect the RHS. If it is a nested logical operation, we recursively
1520 // build the CFG using this function. Otherwise, resort to default
1521 // CFG construction behavior.
1522 Expr *RHS = B->getRHS()->IgnoreParens();
1523 CFGBlock *RHSBlock, *ExitBlock;
1524
1525 do {
1526 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
1527 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001528 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00001529 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
1530 break;
1531 }
1532
1533 // The RHS is not a nested logical operation. Don't push the terminator
1534 // down further, but instead visit RHS and construct the respective
1535 // pieces of the CFG, and link up the RHSBlock with the terminator
1536 // we have been provided.
1537 ExitBlock = RHSBlock = createBlock(false);
1538
1539 if (!Term) {
1540 assert(TrueBlock == FalseBlock);
1541 addSuccessor(RHSBlock, TrueBlock);
1542 }
1543 else {
1544 RHSBlock->setTerminator(Term);
1545 TryResult KnownVal = tryEvaluateBool(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001546 if (!KnownVal.isKnown())
1547 KnownVal = tryEvaluateBool(B);
Ted Kremenek782f0032014-03-07 02:25:53 +00001548 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
1549 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00001550 }
1551
1552 Block = RHSBlock;
1553 RHSBlock = addStmt(RHS);
1554 }
1555 while (false);
1556
1557 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001558 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00001559
1560 // Generate the blocks for evaluating the LHS.
1561 Expr *LHS = B->getLHS()->IgnoreParens();
1562
1563 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
1564 if (B_LHS->isLogicalOp()) {
1565 if (B->getOpcode() == BO_LOr)
1566 FalseBlock = RHSBlock;
1567 else
1568 TrueBlock = RHSBlock;
1569
1570 // For the LHS, treat 'B' as the terminator that we want to sink
1571 // into the nested branch. The RHS always gets the top-most
1572 // terminator.
1573 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
1574 }
1575
1576 // Create the block evaluating the LHS.
1577 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00001578 CFGBlock *LHSBlock = createBlock(false);
1579 LHSBlock->setTerminator(B);
1580
Ted Kremeneka16436f2012-07-14 05:04:06 +00001581 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00001582 CFGBlock *EntryLHSBlock = addStmt(LHS);
1583
1584 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001585 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001586
1587 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00001588 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001589
1590 // Now link the LHSBlock with RHSBlock.
1591 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00001592 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
1593 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00001594 } else {
1595 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00001596 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
1597 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00001598 }
1599
Ted Kremenekb50e7162012-07-14 05:04:10 +00001600 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001601}
1602
Ted Kremenekb50e7162012-07-14 05:04:10 +00001603
Ted Kremeneka16436f2012-07-14 05:04:06 +00001604CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
1605 AddStmtChoice asc) {
1606 // && or ||
1607 if (B->isLogicalOp())
1608 return VisitLogicalOperator(B);
1609
Zhanyong Wan59f09c72010-11-22 19:32:14 +00001610 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00001611 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001612 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00001613 addStmt(B->getRHS());
1614 return addStmt(B->getLHS());
1615 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00001616
1617 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001618 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001619 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001620 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001621 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001622 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00001623 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001624 }
Mike Stump11289f42009-09-09 15:08:12 +00001625
Ted Kremenek7c58d352011-03-10 01:14:11 +00001626 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00001627 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001628 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00001629 }
1630
Zhongxing Xud95ccd52010-10-27 03:23:10 +00001631 CFGBlock *RBlock = Visit(B->getRHS());
1632 CFGBlock *LBlock = Visit(B->getLHS());
1633 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
1634 // containing a DoStmt, and the LHS doesn't create a new block, then we should
1635 // return RBlock. Otherwise we'll incorrectly return NULL.
1636 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00001637}
1638
Ted Kremeneke2499842012-04-12 20:03:44 +00001639CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001640 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00001641 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001642 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00001643 }
1644 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001645}
1646
Ted Kremenek93668002009-07-17 22:18:43 +00001647CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
1648 // "break" is a control-flow statement. Thus we stop processing the current
1649 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001650 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001651 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001652
Ted Kremenek93668002009-07-17 22:18:43 +00001653 // Now create a new block that ends with the break statement.
1654 Block = createBlock(false);
1655 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00001656
Ted Kremenek93668002009-07-17 22:18:43 +00001657 // If there is no target for the break, then we are looking at an incomplete
1658 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001659 if (BreakJumpTarget.block) {
1660 addAutomaticObjDtors(ScopePos, BreakJumpTarget.scopePosition, B);
1661 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001662 } else
Ted Kremenek93668002009-07-17 22:18:43 +00001663 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00001664
1665
Ted Kremenek9aae5132007-08-23 21:42:29 +00001666 return Block;
1667}
Mike Stump11289f42009-09-09 15:08:12 +00001668
Sebastian Redl31ad7542011-03-13 17:09:40 +00001669static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00001670 QualType Ty = E->getType();
1671 if (Ty->isFunctionPointerType())
1672 Ty = Ty->getAs<PointerType>()->getPointeeType();
1673 else if (Ty->isBlockPointerType())
1674 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001675
Mike Stump04c68512010-01-21 15:20:48 +00001676 const FunctionType *FT = Ty->getAs<FunctionType>();
1677 if (FT) {
1678 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00001679 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smithf623c962012-04-17 00:58:00 +00001680 Proto->isNothrow(Ctx))
Mike Stump04c68512010-01-21 15:20:48 +00001681 return false;
1682 }
1683 return true;
1684}
1685
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001686CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00001687 // Compute the callee type.
1688 QualType calleeType = C->getCallee()->getType();
1689 if (calleeType == Context->BoundMemberTy) {
1690 QualType boundType = Expr::findBoundMemberType(C->getCallee());
1691
1692 // We should only get a null bound type if processing a dependent
1693 // CFG. Recover by assuming nothing.
1694 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00001695 }
Mike Stump8c5d7992009-07-25 21:26:53 +00001696
John McCallc67067f2011-05-11 07:19:11 +00001697 // If this is a call to a no-return function, this stops the block here.
1698 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
1699
Mike Stump04c68512010-01-21 15:20:48 +00001700 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00001701
1702 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001703 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00001704 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00001705 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00001706 }
1707
Jordan Rose5374c072013-08-19 16:27:28 +00001708 // If this is a call to a builtin function, it might not actually evaluate
1709 // its arguments. Don't add them to the CFG if this is the case.
1710 bool OmitArguments = false;
1711
Mike Stump92244b02010-01-19 22:00:14 +00001712 if (FunctionDecl *FD = C->getDirectCallee()) {
Richard Smith10876ef2013-01-17 01:30:42 +00001713 if (FD->isNoReturn())
Mike Stump8c5d7992009-07-25 21:26:53 +00001714 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00001715 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00001716 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00001717 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
1718 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00001719 }
Mike Stump8c5d7992009-07-25 21:26:53 +00001720
Sebastian Redl31ad7542011-03-13 17:09:40 +00001721 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00001722 AddEHEdge = false;
1723
Jordan Rose5374c072013-08-19 16:27:28 +00001724 if (OmitArguments) {
1725 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
1726 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
1727 autoCreateBlock();
1728 appendStmt(Block, C);
1729 return Visit(C->getCallee());
1730 }
1731
1732 if (!NoReturn && !AddEHEdge) {
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001733 return VisitStmt(C, asc.withAlwaysAdd(true));
Jordan Rose5374c072013-08-19 16:27:28 +00001734 }
Mike Stump11289f42009-09-09 15:08:12 +00001735
Mike Stump92244b02010-01-19 22:00:14 +00001736 if (Block) {
1737 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001738 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001739 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00001740 }
Mike Stump11289f42009-09-09 15:08:12 +00001741
Chandler Carrutha70991b2011-09-13 09:13:49 +00001742 if (NoReturn)
1743 Block = createNoReturnBlock();
1744 else
1745 Block = createBlock();
1746
Ted Kremenek2866bab2011-03-10 01:14:08 +00001747 appendStmt(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00001748
Mike Stump04c68512010-01-21 15:20:48 +00001749 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00001750 // Add exceptional edges.
1751 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001752 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00001753 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001754 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00001755 }
Mike Stump11289f42009-09-09 15:08:12 +00001756
Mike Stump8c5d7992009-07-25 21:26:53 +00001757 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00001758}
Ted Kremenek9aae5132007-08-23 21:42:29 +00001759
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001760CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
1761 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001762 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001763 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001764 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001765 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001766
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001767 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00001768 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001769 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001770 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001771 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001772 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001773
Ted Kremenek21822592009-07-17 18:20:32 +00001774 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001775 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001776 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001777 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001778 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001779
Ted Kremenek21822592009-07-17 18:20:32 +00001780 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00001781 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001782 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00001783 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
1784 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00001785 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00001786 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00001787}
Mike Stump11289f42009-09-09 15:08:12 +00001788
1789
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001790CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Marcin Swiderski667ffec2010-10-01 00:23:17 +00001791 addLocalScopeAndDtors(C);
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001792 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001793
1794 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
1795 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00001796 // If we hit a segment of code just containing ';' (NullStmts), we can
1797 // get a null block back. In such cases, just use the LastBlock
1798 if (CFGBlock *newBlock = addStmt(*I))
1799 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00001800
Ted Kremenekce499c22009-08-27 23:16:26 +00001801 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001802 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001803 }
Mike Stump92244b02010-01-19 22:00:14 +00001804
Ted Kremenek93668002009-07-17 22:18:43 +00001805 return LastBlock;
1806}
Mike Stump11289f42009-09-09 15:08:12 +00001807
John McCallc07a0c72011-02-17 10:25:35 +00001808CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001809 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00001810 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00001811 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00001812
Ted Kremenek51d40b02009-07-17 18:15:54 +00001813 // Create the confluence block that will "merge" the results of the ternary
1814 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001815 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001816 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001817 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001818 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001819
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001820 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00001821
Ted Kremenek51d40b02009-07-17 18:15:54 +00001822 // Create a block for the LHS expression if there is an LHS expression. A
1823 // GCC extension allows LHS to be NULL, causing the condition to be the
1824 // value that is returned instead.
1825 // e.g: x ?: y is shorthand for: x ? x : y;
1826 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001827 Block = nullptr;
1828 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00001829 const Expr *trueExpr = C->getTrueExpr();
1830 if (trueExpr != opaqueValue) {
1831 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001832 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001833 return nullptr;
1834 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00001835 }
Ted Kremenekd8138012011-02-24 03:09:15 +00001836 else
1837 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00001838
Ted Kremenek51d40b02009-07-17 18:15:54 +00001839 // Create the block for the RHS expression.
1840 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001841 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001842 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001843 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001844
Richard Smithf676e452012-07-24 21:02:14 +00001845 // If the condition is a logical '&&' or '||', build a more accurate CFG.
1846 if (BinaryOperator *Cond =
1847 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
1848 if (Cond->isLogicalOp())
1849 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
1850
Ted Kremenek51d40b02009-07-17 18:15:54 +00001851 // Create the block that will contain the condition.
1852 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00001853
Mike Stump773582d2009-07-23 23:25:26 +00001854 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001855 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00001856 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
1857 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00001858 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00001859 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00001860
Ted Kremenekd8138012011-02-24 03:09:15 +00001861 if (opaqueValue) {
1862 // Run the condition expression if it's not trivially expressed in
1863 // terms of the opaque value (or if there is no opaque value).
1864 if (condExpr != opaqueValue)
1865 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00001866
Ted Kremenekd8138012011-02-24 03:09:15 +00001867 // Before that, run the common subexpression if there was one.
1868 // At least one of this or the above will be run.
1869 return addStmt(BCO->getCommon());
1870 }
1871
1872 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00001873}
1874
Ted Kremenek93668002009-07-17 22:18:43 +00001875CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00001876 // Check if the Decl is for an __label__. If so, elide it from the
1877 // CFG entirely.
1878 if (isa<LabelDecl>(*DS->decl_begin()))
1879 return Block;
1880
Ted Kremenek3a601142011-05-24 20:41:31 +00001881 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001882 if (DS->isSingleDecl())
1883 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00001884
Craig Topper25542942014-05-20 04:30:07 +00001885 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001886
Jordan Rose8c6c8a92012-07-20 18:50:48 +00001887 // Build an individual DeclStmt for each decl.
1888 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
1889 E = DS->decl_rend();
1890 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00001891 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
1892 unsigned A = llvm::AlignOf<DeclStmt>::Alignment < 8
1893 ? 8 : llvm::AlignOf<DeclStmt>::Alignment;
Mike Stump11289f42009-09-09 15:08:12 +00001894
Ted Kremenek93668002009-07-17 22:18:43 +00001895 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
1896 // automatically freed with the CFG.
1897 DeclGroupRef DG(*I);
1898 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00001899 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00001900 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00001901 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00001902
Ted Kremenek93668002009-07-17 22:18:43 +00001903 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001904 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00001905 }
Mike Stump11289f42009-09-09 15:08:12 +00001906
1907 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00001908}
Mike Stump11289f42009-09-09 15:08:12 +00001909
Ted Kremenek93668002009-07-17 22:18:43 +00001910/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001911/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001912CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001913 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001914 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00001915
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001916 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00001917 // Of everything that can be declared in a DeclStmt, only VarDecls impact
1918 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00001919 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001920 }
Mike Stump11289f42009-09-09 15:08:12 +00001921
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001922 bool IsReference = false;
1923 bool HasTemporaries = false;
1924
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00001925 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00001926 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00001927
1928 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
1929 // For static variables, we need to create a branch to track
1930 // whether or not they are initialized.
1931 if (Block) {
1932 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00001933 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00001934 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001935 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00001936 }
1937 blockAfterStaticInit = Succ;
1938 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00001939
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001940 // Destructors of temporaries in initialization expression should be called
1941 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00001942 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001943 if (Init) {
1944 IsReference = VD->getType()->isReferenceType();
John McCall5d413782010-12-06 08:20:24 +00001945 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001946
Jordan Rose6d671cc2012-09-05 22:55:23 +00001947 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001948 // Generate destructors for temporaries in initialization expression.
John McCall5d413782010-12-06 08:20:24 +00001949 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001950 IsReference);
1951 }
1952 }
1953
1954 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00001955 appendStmt(Block, DS);
Ted Kremenek213d0532012-03-22 05:57:43 +00001956
1957 // Keep track of the last non-null block, as 'Block' can be nulled out
1958 // if the initializer expression is something like a 'while' in a
1959 // statement-expression.
1960 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00001961
Ted Kremenek93668002009-07-17 22:18:43 +00001962 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00001963 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001964 // For expression with temporaries go directly to subexpression to omit
1965 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00001966 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
1967 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
1968 LastBlock = newBlock;
1969 }
1970 else {
1971 if (CFGBlock *newBlock = Visit(Init))
1972 LastBlock = newBlock;
1973 }
Ted Kremenek93668002009-07-17 22:18:43 +00001974 }
Mike Stump11289f42009-09-09 15:08:12 +00001975
Ted Kremenek93668002009-07-17 22:18:43 +00001976 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00001977 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00001978 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00001979 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
1980 LastBlock = newBlock;
1981 }
Mike Stump11289f42009-09-09 15:08:12 +00001982
Marcin Swiderski667ffec2010-10-01 00:23:17 +00001983 // Remove variable from local scope.
1984 if (ScopePos && VD == *ScopePos)
1985 ++ScopePos;
1986
Ted Kremenek338c3aa2013-03-29 00:09:28 +00001987 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00001988 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00001989 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00001990 Block = createBlock(false);
1991 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00001992 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00001993 addSuccessor(Block, B);
1994 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00001995 }
1996
1997 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001998}
1999
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002000CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002001 // We may see an if statement in the middle of a basic block, or it may be the
2002 // first statement we are processing. In either case, we create a new basic
2003 // block. First, we create the blocks for the then...else statements, and
2004 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002005 // middle of a block, we stop processing that block. That block is then the
2006 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002007
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002008 // Save local scope position because in case of condition variable ScopePos
2009 // won't be restored when traversing AST.
2010 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2011
2012 // Create local scope for possible condition variable.
2013 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002014 if (VarDecl *VD = I->getConditionVariable()) {
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002015 LocalScope::const_iterator BeginScopePos = ScopePos;
2016 addLocalScopeForVarDecl(VD);
2017 addAutomaticObjDtors(ScopePos, BeginScopePos, I);
2018 }
2019
Chris Lattner57540c52011-04-15 05:22:18 +00002020 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002021 // block.
2022 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002023 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002024 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002025 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002026 }
Mike Stump31feda52009-07-17 01:31:16 +00002027
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002028 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002029 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002030
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002031 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002032 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002033
Ted Kremenek9aae5132007-08-23 21:42:29 +00002034 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002035 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002036 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002037
2038 // If branch is not a compound statement create implicit scope
2039 // and add destructors.
2040 if (!isa<CompoundStmt>(Else))
2041 addLocalScopeAndDtors(Else);
2042
Ted Kremenek93668002009-07-17 22:18:43 +00002043 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002044
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002045 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2046 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002047 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002048 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002049 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002050 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002051 }
Mike Stump31feda52009-07-17 01:31:16 +00002052
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002053 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002054 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002055 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002056 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002057 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002058 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002059 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002060
2061 // If branch is not a compound statement create implicit scope
2062 // and add destructors.
2063 if (!isa<CompoundStmt>(Then))
2064 addLocalScopeAndDtors(Then);
2065
Ted Kremenek93668002009-07-17 22:18:43 +00002066 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002067
Ted Kremenek1b379512009-04-01 03:52:47 +00002068 if (!ThenBlock) {
2069 // We can reach here if the "then" body has all NullStmts.
2070 // Create an empty block so we can distinguish between true and false
2071 // branches in path-sensitive analyses.
2072 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002073 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002074 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002075 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002076 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002077 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002078 }
2079
Ted Kremenekb50e7162012-07-14 05:04:10 +00002080 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2081 // having these handle the actual control-flow jump. Note that
2082 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2083 // we resort to the old control-flow behavior. This special handling
2084 // removes infeasible paths from the control-flow graph by having the
2085 // control-flow transfer of '&&' or '||' go directly into the then/else
2086 // blocks directly.
2087 if (!I->getConditionVariable())
Richard Smithf676e452012-07-24 21:02:14 +00002088 if (BinaryOperator *Cond =
2089 dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002090 if (Cond->isLogicalOp())
2091 return VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2092
Mike Stump31feda52009-07-17 01:31:16 +00002093 // Now create a new block containing the if statement.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002094 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002095
Ted Kremenek9aae5132007-08-23 21:42:29 +00002096 // Set the terminator of the new block to the If statement.
2097 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002098
Mike Stump773582d2009-07-23 23:25:26 +00002099 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002100 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00002101
Ted Kremenekf3898612014-02-27 00:24:03 +00002102 // Add the successors. If we know that specific branches are
2103 // unreachable, inform addSuccessor() of that knowledge.
2104 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2105 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump31feda52009-07-17 01:31:16 +00002106
2107 // Add the condition as the last statement in the new block. This may create
2108 // new blocks as the condition may contain control-flow. Any newly created
2109 // blocks will be pointed to be "Block".
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002110 CFGBlock *LastBlock = addStmt(I->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002111
Manuel Klimek75f34c12014-05-05 18:21:06 +00002112 // Finally, if the IfStmt contains a condition variable, add it and its
2113 // initializer to the CFG.
2114 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2115 autoCreateBlock();
2116 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002117 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002118
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002119 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002120}
Mike Stump31feda52009-07-17 01:31:16 +00002121
2122
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002123CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002124 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002125 //
Mike Stump31feda52009-07-17 01:31:16 +00002126 // NOTE: If a "return" appears in the middle of a block, this means that the
2127 // code afterwards is DEAD (unreachable). We still keep a basic block
2128 // for that code; a simple "mark-and-sweep" from the entry block will be
2129 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002130
2131 // Create the new block.
2132 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002133
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002134 addAutomaticObjDtors(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002135
2136 // If the one of the destructors does not return, we already have the Exit
2137 // block as a successor.
2138 if (!Block->hasNoReturnElement())
2139 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002140
2141 // Add the return statement to the block. This may create new blocks if R
2142 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002143 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002144}
2145
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002146CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002147 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002148 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002149 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002150
Ted Kremenek93668002009-07-17 22:18:43 +00002151 if (!LabelBlock) // This can happen when the body is empty, i.e.
2152 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002153
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002154 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2155 "label already in map");
2156 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002157
2158 // Labels partition blocks, so this is the end of the basic block we were
2159 // processing (L is the block's label). Because this is label (and we have
2160 // already processed the substatement) there is no extra control-flow to worry
2161 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002162 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002163 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002164 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002165
2166 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002167 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002168
Ted Kremenek9aae5132007-08-23 21:42:29 +00002169 // This block is now the implicit successor of other blocks.
2170 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002171
Ted Kremenek9aae5132007-08-23 21:42:29 +00002172 return LabelBlock;
2173}
2174
Ted Kremenekda76a942012-04-12 20:34:52 +00002175CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
2176 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2177 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
2178 et = E->capture_init_end(); it != et; ++it) {
2179 if (Expr *Init = *it) {
2180 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00002181 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00002182 LastBlock = Tmp;
2183 }
2184 }
2185 return LastBlock;
2186}
2187
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002188CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00002189 // Goto is a control-flow statement. Thus we stop processing the current
2190 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00002191
Ted Kremenek9aae5132007-08-23 21:42:29 +00002192 Block = createBlock(false);
2193 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00002194
2195 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002196 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00002197
Ted Kremenek9aae5132007-08-23 21:42:29 +00002198 if (I == LabelMap.end())
2199 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002200 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
2201 else {
2202 JumpTarget JT = I->second;
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002203 addAutomaticObjDtors(ScopePos, JT.scopePosition, G);
2204 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002205 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002206
Mike Stump31feda52009-07-17 01:31:16 +00002207 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002208}
2209
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002210CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00002211 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002212
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002213 // Save local scope position because in case of condition variable ScopePos
2214 // won't be restored when traversing AST.
2215 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2216
2217 // Create local scope for init statement and possible condition variable.
2218 // Add destructor for init statement and condition variable.
2219 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002220 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002221 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002222 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
2223
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002224 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002225 addLocalScopeForVarDecl(VD);
2226 LocalScope::const_iterator ContinueScopePos = ScopePos;
2227
2228 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), F);
2229
Mike Stump014b3ea2009-07-21 01:12:51 +00002230 // "for" is a control-flow statement. Thus we stop processing the current
2231 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002232 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002233 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002234 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002235 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002236 } else
2237 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002238
Ted Kremenek304a9532010-05-21 20:30:15 +00002239 // Save the current value for the break targets.
2240 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002241 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002242 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00002243
Craig Topper25542942014-05-20 04:30:07 +00002244 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00002245
Ted Kremenek9aae5132007-08-23 21:42:29 +00002246 // Now create the loop body.
2247 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002248 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002249
Ted Kremenekb50e7162012-07-14 05:04:10 +00002250 // Save the current values for Block, Succ, continue and break targets.
2251 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2252 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002253
Ted Kremenekb50e7162012-07-14 05:04:10 +00002254 // Create an empty block to represent the transition block for looping back
2255 // to the head of the loop. If we have increment code, it will
2256 // go in this block as well.
2257 Block = Succ = TransitionBlock = createBlock(false);
2258 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002259
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002260 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00002261 // Generate increment code in its own basic block. This is the target of
2262 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00002263 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00002264 }
Mike Stump31feda52009-07-17 01:31:16 +00002265
Ted Kremenek902393b2009-04-28 00:51:56 +00002266 // Finish up the increment (or empty) block if it hasn't been already.
2267 if (Block) {
2268 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002269 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002270 return nullptr;
2271 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00002272 }
Mike Stump31feda52009-07-17 01:31:16 +00002273
Ted Kremenekb50e7162012-07-14 05:04:10 +00002274 // The starting block for the loop increment is the block that should
2275 // represent the 'loop target' for looping back to the start of the loop.
2276 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
2277 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002278
Ted Kremenekb50e7162012-07-14 05:04:10 +00002279 // Loop body should end with destructor of Condition variable (if any).
2280 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00002281
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002282 // If body is not a compound statement create implicit scope
2283 // and add destructors.
2284 if (!isa<CompoundStmt>(F->getBody()))
2285 addLocalScopeAndDtors(F->getBody());
2286
Mike Stump31feda52009-07-17 01:31:16 +00002287 // Now populate the body block, and in the process create new blocks as we
2288 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002289 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00002290
Ted Kremenekb50e7162012-07-14 05:04:10 +00002291 if (!BodyBlock) {
2292 // In the case of "for (...;...;...);" we can have a null BodyBlock.
2293 // Use the continue jump target as the proxy for the body.
2294 BodyBlock = ContinueJumpTarget.block;
2295 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002296 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002297 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002298 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00002299
2300 // Because of short-circuit evaluation, the condition of the loop can span
2301 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2302 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00002303 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002304
Ted Kremenekb50e7162012-07-14 05:04:10 +00002305 do {
2306 Expr *C = F->getCond();
2307
2308 // Specially handle logical operators, which have a slightly
2309 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00002310 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00002311 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002312 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002313 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002314 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
2315 break;
2316 }
2317
2318 // The default case when not handling logical operators.
2319 EntryConditionBlock = ExitConditionBlock = createBlock(false);
2320 ExitConditionBlock->setTerminator(F);
2321
2322 // See if this is a known constant.
2323 TryResult KnownVal(true);
2324
2325 if (C) {
2326 // Now add the actual condition to the condition block.
2327 // Because the condition itself may contain control-flow, new blocks may
2328 // be created. Thus we update "Succ" after adding the condition.
2329 Block = ExitConditionBlock;
2330 EntryConditionBlock = addStmt(C);
2331
2332 // If this block contains a condition variable, add both the condition
2333 // variable and initializer to the CFG.
2334 if (VarDecl *VD = F->getConditionVariable()) {
2335 if (Expr *Init = VD->getInit()) {
2336 autoCreateBlock();
2337 appendStmt(Block, F->getConditionVariableDeclStmt());
2338 EntryConditionBlock = addStmt(Init);
2339 assert(Block == EntryConditionBlock);
2340 }
2341 }
2342
2343 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002344 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002345
2346 KnownVal = tryEvaluateBool(C);
2347 }
2348
2349 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00002350 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002351 // Link up the condition block with the code that follows the loop. (the
2352 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00002353 addSuccessor(ExitConditionBlock,
2354 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002355
2356 } while (false);
2357
2358 // Link up the loop-back block to the entry condition block.
2359 addSuccessor(TransitionBlock, EntryConditionBlock);
2360
2361 // The condition block is the implicit successor for any code above the loop.
2362 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002363
Ted Kremenek9aae5132007-08-23 21:42:29 +00002364 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00002365 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002366 if (Stmt *I = F->getInit()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002367 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00002368 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002369 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002370
2371 // There is no loop initialization. We are thus basically a while loop.
2372 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00002373 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002374 Succ = EntryConditionBlock;
2375 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002376}
2377
Ted Kremenek5868ec62010-04-11 17:02:10 +00002378CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002379 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00002380 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002381 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002382 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002383 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00002384}
2385
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002386CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00002387 // Objective-C fast enumeration 'for' statements:
2388 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
2389 //
2390 // for ( Type newVariable in collection_expression ) { statements }
2391 //
2392 // becomes:
2393 //
2394 // prologue:
2395 // 1. collection_expression
2396 // T. jump to loop_entry
2397 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002398 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00002399 // 1. ObjCForCollectionStmt [performs binding to newVariable]
2400 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
2401 // TB:
2402 // statements
2403 // T. jump to loop_entry
2404 // FB:
2405 // what comes after
2406 //
2407 // and
2408 //
2409 // Type existingItem;
2410 // for ( existingItem in expression ) { statements }
2411 //
2412 // becomes:
2413 //
Mike Stump31feda52009-07-17 01:31:16 +00002414 // the same with newVariable replaced with existingItem; the binding works
2415 // the same except that for one ObjCForCollectionStmt::getElement() returns
2416 // a DeclStmt and the other returns a DeclRefExpr.
Ted Kremenek9d56e642008-11-11 17:10:00 +00002417 //
Mike Stump31feda52009-07-17 01:31:16 +00002418
Craig Topper25542942014-05-20 04:30:07 +00002419 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002420
Ted Kremenek9d56e642008-11-11 17:10:00 +00002421 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002422 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002423 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00002424 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00002425 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00002426 } else
2427 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002428
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002429 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002430 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002431
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002432 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00002433 ExitConditionBlock->setTerminator(S);
2434
2435 // The last statement in the block should be the ObjCForCollectionStmt, which
2436 // performs the actual binding to 'element' and determines if there are any
2437 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00002438 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002439 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002440
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002441 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00002442 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00002443 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00002444 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
2445 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00002446 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002447 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002448 return nullptr;
2449 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002450 }
Mike Stump31feda52009-07-17 01:31:16 +00002451
2452 // The condition block is the implicit successor for the loop body as well as
2453 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002454 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002455
Ted Kremenek9d56e642008-11-11 17:10:00 +00002456 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00002457 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002458 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00002459 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002460 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00002461 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002462
Anna Zaks56b49752013-06-22 00:23:20 +00002463 // Add an intermediate block between the BodyBlock and the
2464 // EntryConditionBlock to represent the "loop back" transition, for looping
2465 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00002466 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00002467 Succ = LoopBackBlock = createBlock();
2468 LoopBackBlock->setLoopTarget(S);
2469
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002470 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00002471 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002472
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002473 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002474
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002475 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00002476 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00002477 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002478 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002479 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002480 }
Mike Stump31feda52009-07-17 01:31:16 +00002481
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002482 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002483 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002484 }
Mike Stump31feda52009-07-17 01:31:16 +00002485
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002486 // Link up the condition block with the code that follows the loop.
2487 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002488 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002489
Ted Kremenek9d56e642008-11-11 17:10:00 +00002490 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002491 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00002492 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00002493}
2494
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002495CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
2496 // Inline the body.
2497 return addStmt(S->getSubStmt());
2498 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
2499}
2500
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002501CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00002502 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00002503
Ted Kremenek49805452009-05-02 01:49:13 +00002504 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00002505 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00002506
Ted Kremenekb3c657b2009-05-05 23:11:51 +00002507 // The sync body starts its own basic block. This makes it a little easier
2508 // for diagnostic clients.
2509 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002510 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002511 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002512
Craig Topper25542942014-05-20 04:30:07 +00002513 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00002514 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00002515 }
Mike Stump31feda52009-07-17 01:31:16 +00002516
Ted Kremeneked12f1b2010-09-10 03:05:33 +00002517 // Add the @synchronized to the CFG.
2518 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002519 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00002520
Ted Kremenek49805452009-05-02 01:49:13 +00002521 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00002522 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00002523}
Mike Stump31feda52009-07-17 01:31:16 +00002524
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002525CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00002526 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00002527 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00002528}
Ted Kremenek9d56e642008-11-11 17:10:00 +00002529
John McCallfe96e0b2011-11-06 09:01:30 +00002530CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
2531 autoCreateBlock();
2532
2533 // Add the PseudoObject as the last thing.
2534 appendStmt(Block, E);
2535
2536 CFGBlock *lastBlock = Block;
2537
2538 // Before that, evaluate all of the semantics in order. In
2539 // CFG-land, that means appending them in reverse order.
2540 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
2541 Expr *Semantic = E->getSemanticExpr(--i);
2542
2543 // If the semantic is an opaque value, we're being asked to bind
2544 // it to its source expression.
2545 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
2546 Semantic = OVE->getSourceExpr();
2547
2548 if (CFGBlock *B = Visit(Semantic))
2549 lastBlock = B;
2550 }
2551
2552 return lastBlock;
2553}
2554
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002555CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00002556 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002557
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002558 // Save local scope position because in case of condition variable ScopePos
2559 // won't be restored when traversing AST.
2560 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2561
2562 // Create local scope for possible condition variable.
2563 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002564 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002565 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002566 addLocalScopeForVarDecl(VD);
2567 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W);
2568 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002569
Mike Stump014b3ea2009-07-21 01:12:51 +00002570 // "while" is a control-flow statement. Thus we stop processing the current
2571 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002572 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002573 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002574 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002575 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00002576 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002577 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00002578 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00002579 }
Mike Stump31feda52009-07-17 01:31:16 +00002580
Craig Topper25542942014-05-20 04:30:07 +00002581 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00002582
Ted Kremenek9aae5132007-08-23 21:42:29 +00002583 // Process the loop body.
2584 {
Ted Kremenek49936f72009-04-28 03:09:44 +00002585 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00002586
Ted Kremenekb50e7162012-07-14 05:04:10 +00002587 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002588 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2589 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00002590 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00002591
Mike Stump31feda52009-07-17 01:31:16 +00002592 // Create an empty block to represent the transition block for looping back
2593 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002594 Succ = TransitionBlock = createBlock(false);
2595 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002596 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002597
Ted Kremenek9aae5132007-08-23 21:42:29 +00002598 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002599 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002600
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002601 // Loop body should end with destructor of Condition variable (if any).
2602 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W);
2603
2604 // If body is not a compound statement create implicit scope
2605 // and add destructors.
2606 if (!isa<CompoundStmt>(W->getBody()))
2607 addLocalScopeAndDtors(W->getBody());
2608
Ted Kremenek9aae5132007-08-23 21:42:29 +00002609 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002610 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002611
Ted Kremeneke9610502007-08-30 18:39:40 +00002612 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002613 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00002614 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002615 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002616 }
2617
2618 // Because of short-circuit evaluation, the condition of the loop can span
2619 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2620 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00002621 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002622
2623 do {
2624 Expr *C = W->getCond();
2625
2626 // Specially handle logical operators, which have a slightly
2627 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00002628 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002629 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002630 std::tie(EntryConditionBlock, ExitConditionBlock) =
2631 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002632 break;
2633 }
2634
2635 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00002636 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002637 ExitConditionBlock->setTerminator(W);
2638
2639 // Now add the actual condition to the condition block.
2640 // Because the condition itself may contain control-flow, new blocks may
2641 // be created. Thus we update "Succ" after adding the condition.
2642 Block = ExitConditionBlock;
2643 Block = EntryConditionBlock = addStmt(C);
2644
2645 // If this block contains a condition variable, add both the condition
2646 // variable and initializer to the CFG.
2647 if (VarDecl *VD = W->getConditionVariable()) {
2648 if (Expr *Init = VD->getInit()) {
2649 autoCreateBlock();
2650 appendStmt(Block, W->getConditionVariableDeclStmt());
2651 EntryConditionBlock = addStmt(Init);
2652 assert(Block == EntryConditionBlock);
2653 }
Ted Kremenek55957a82009-05-02 00:13:27 +00002654 }
Mike Stump31feda52009-07-17 01:31:16 +00002655
Ted Kremenekb50e7162012-07-14 05:04:10 +00002656 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002657 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002658
2659 // See if this is a known constant.
2660 const TryResult& KnownVal = tryEvaluateBool(C);
2661
Ted Kremenek30754282009-07-24 04:47:11 +00002662 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00002663 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002664 // Link up the condition block with the code that follows the loop. (the
2665 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00002666 addSuccessor(ExitConditionBlock,
2667 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00002668
Ted Kremenekb50e7162012-07-14 05:04:10 +00002669 } while(false);
2670
2671 // Link up the loop-back block to the entry condition block.
2672 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00002673
2674 // There can be no more statements in the condition block since we loop back
2675 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00002676 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002677
Ted Kremenek1ce53c42009-12-24 01:34:10 +00002678 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00002679 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00002680 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002681}
Mike Stump11289f42009-09-09 15:08:12 +00002682
2683
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002684CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00002685 // FIXME: For now we pretend that @catch and the code it contains does not
2686 // exit.
2687 return Block;
2688}
Mike Stump31feda52009-07-17 01:31:16 +00002689
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002690CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00002691 // FIXME: This isn't complete. We basically treat @throw like a return
2692 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00002693
Ted Kremenek0868eea2009-09-24 18:45:41 +00002694 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002695 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002696 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002697
Ted Kremenek93041ba2008-12-09 20:20:09 +00002698 // Create the new block.
2699 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002700
Ted Kremenek93041ba2008-12-09 20:20:09 +00002701 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002702 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002703
2704 // Add the statement to the block. This may create new blocks if S contains
2705 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002706 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00002707}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002708
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002709CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002710 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002711 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002712 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002713
2714 // Create the new block.
2715 Block = createBlock(false);
2716
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002717 if (TryTerminatedBlock)
2718 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002719 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002720 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002721 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002722 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002723
2724 // Add the statement to the block. This may create new blocks if S contains
2725 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002726 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002727}
2728
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002729CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00002730 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002731
Mike Stump8d50b6a2009-07-21 01:27:50 +00002732 // "do...while" is a control-flow statement. Thus we stop processing the
2733 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002734 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002735 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002736 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002737 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002738 } else
2739 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002740
2741 // Because of short-circuit evaluation, the condition of the loop can span
2742 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2743 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002744 CFGBlock *ExitConditionBlock = createBlock(false);
2745 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002746
Ted Kremenek81e14852007-08-27 19:46:09 +00002747 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00002748 ExitConditionBlock->setTerminator(D);
2749
2750 // Now add the actual condition to the condition block. Because the condition
2751 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002752 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00002753 Block = ExitConditionBlock;
2754 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00002755 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002756 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002757 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002758 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002759 }
Mike Stump31feda52009-07-17 01:31:16 +00002760
Ted Kremeneka1523a32008-02-27 07:20:00 +00002761 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00002762 Succ = EntryConditionBlock;
2763
Mike Stump773582d2009-07-23 23:25:26 +00002764 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002765 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00002766
Ted Kremenek9aae5132007-08-23 21:42:29 +00002767 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00002768 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002769 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002770 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002771
Ted Kremenek9aae5132007-08-23 21:42:29 +00002772 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002773 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2774 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
2775 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002776
Ted Kremenek9aae5132007-08-23 21:42:29 +00002777 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002778 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002779
Ted Kremenek9aae5132007-08-23 21:42:29 +00002780 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002781 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002782
Ted Kremenek9aae5132007-08-23 21:42:29 +00002783 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00002784 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002785
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002786 // If body is not a compound statement create implicit scope
2787 // and add destructors.
2788 if (!isa<CompoundStmt>(D->getBody()))
2789 addLocalScopeAndDtors(D->getBody());
2790
Ted Kremenek9aae5132007-08-23 21:42:29 +00002791 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00002792 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002793
Ted Kremeneke9610502007-08-30 18:39:40 +00002794 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00002795 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00002796 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002797 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002798 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002799 }
Mike Stump31feda52009-07-17 01:31:16 +00002800
Ted Kremenek110974d2010-08-17 20:59:56 +00002801 if (!KnownVal.isFalse()) {
2802 // Add an intermediate block between the BodyBlock and the
2803 // ExitConditionBlock to represent the "loop back" transition. Create an
2804 // empty block to represent the transition block for looping back to the
2805 // head of the loop.
2806 // FIXME: Can we do this more efficiently without adding another block?
Craig Topper25542942014-05-20 04:30:07 +00002807 Block = nullptr;
Ted Kremenek110974d2010-08-17 20:59:56 +00002808 Succ = BodyBlock;
2809 CFGBlock *LoopBackBlock = createBlock();
2810 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00002811
Ted Kremenek110974d2010-08-17 20:59:56 +00002812 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002813 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00002814 }
2815 else
Craig Topper25542942014-05-20 04:30:07 +00002816 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002817 }
Mike Stump31feda52009-07-17 01:31:16 +00002818
Ted Kremenek30754282009-07-24 04:47:11 +00002819 // Link up the condition block with the code that follows the loop.
2820 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00002821 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00002822
2823 // There can be no more statements in the body block(s) since we loop back to
2824 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00002825 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002826
Ted Kremenek9aae5132007-08-23 21:42:29 +00002827 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00002828 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002829 return BodyBlock;
2830}
2831
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002832CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002833 // "continue" is a control-flow statement. Thus we stop processing the
2834 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002835 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002836 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002837
Ted Kremenek9aae5132007-08-23 21:42:29 +00002838 // Now create a new block that ends with the continue statement.
2839 Block = createBlock(false);
2840 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00002841
Ted Kremenek9aae5132007-08-23 21:42:29 +00002842 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00002843 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002844 if (ContinueJumpTarget.block) {
2845 addAutomaticObjDtors(ScopePos, ContinueJumpTarget.scopePosition, C);
2846 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002847 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00002848 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00002849
Ted Kremenek9aae5132007-08-23 21:42:29 +00002850 return Block;
2851}
Mike Stump11289f42009-09-09 15:08:12 +00002852
Peter Collingbournee190dee2011-03-11 19:24:49 +00002853CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
2854 AddStmtChoice asc) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002855
Ted Kremenek7c58d352011-03-10 01:14:11 +00002856 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002857 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002858 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00002859 }
Mike Stump11289f42009-09-09 15:08:12 +00002860
Ted Kremenek93668002009-07-17 22:18:43 +00002861 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002862 CFGBlock *lastBlock = Block;
2863
Ted Kremenek93668002009-07-17 22:18:43 +00002864 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00002865 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002866 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002867 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00002868 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002869 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002870}
Mike Stump11289f42009-09-09 15:08:12 +00002871
Ted Kremenek93668002009-07-17 22:18:43 +00002872/// VisitStmtExpr - Utility method to handle (nested) statement
2873/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002874CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002875 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002876 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002877 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00002878 }
Ted Kremenek93668002009-07-17 22:18:43 +00002879 return VisitCompoundStmt(SE->getSubStmt());
2880}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002881
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002882CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00002883 // "switch" is a control-flow statement. Thus we stop processing the current
2884 // block.
Craig Topper25542942014-05-20 04:30:07 +00002885 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002886
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002887 // Save local scope position because in case of condition variable ScopePos
2888 // won't be restored when traversing AST.
2889 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2890
2891 // Create local scope for possible condition variable.
2892 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002893 if (VarDecl *VD = Terminator->getConditionVariable()) {
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002894 LocalScope::const_iterator SwitchBeginScopePos = ScopePos;
2895 addLocalScopeForVarDecl(VD);
2896 addAutomaticObjDtors(ScopePos, SwitchBeginScopePos, Terminator);
2897 }
2898
Ted Kremenek9aae5132007-08-23 21:42:29 +00002899 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002900 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002901 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002902 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002903 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002904
2905 // Save the current "switch" context.
2906 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00002907 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002908 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00002909
Mike Stump31feda52009-07-17 01:31:16 +00002910 // Set the "default" case to be the block after the switch statement. If the
2911 // switch statement contains a "default:", this value will be overwritten with
2912 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00002913 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00002914
Ted Kremenek9aae5132007-08-23 21:42:29 +00002915 // Create a new block that will contain the switch statement.
2916 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002917
Ted Kremenek9aae5132007-08-23 21:42:29 +00002918 // Now process the switch body. The code after the switch is the implicit
2919 // successor.
2920 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002921 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002922
2923 // When visiting the body, the case statements should automatically get linked
2924 // up to the switch. We also don't keep a pointer to the body, since all
2925 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002926 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00002927 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002928
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002929 // For pruning unreachable case statements, save the current state
2930 // for tracking the condition value.
2931 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
2932 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00002933
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002934 // Determine if the switch condition can be explicitly evaluated.
2935 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00002936 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00002937 bool b = tryEvaluate(Terminator->getCond(), result);
2938 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00002939 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00002940
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002941 // If body is not a compound statement create implicit scope
2942 // and add destructors.
2943 if (!isa<CompoundStmt>(Terminator->getBody()))
2944 addLocalScopeAndDtors(Terminator->getBody());
2945
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002946 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00002947 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002948 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002949 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002950 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002951
Mike Stump31feda52009-07-17 01:31:16 +00002952 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00002953 // following the switch body. Moreover, take into account if all the
2954 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00002955 //
2956 // Note: We add a successor to a switch that is considered covered yet has no
2957 // case statements if the enumeration has no enumerators.
2958 bool SwitchAlwaysHasSuccessor = false;
2959 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
2960 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
2961 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00002962 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
2963 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00002964
Ted Kremenek81e14852007-08-27 19:46:09 +00002965 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002966 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002967 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002968 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002969
Ted Kremenek8b5dc122009-12-24 00:39:26 +00002970 // Finally, if the SwitchStmt contains a condition variable, add both the
2971 // SwitchStmt and the condition variable initialization to the CFG.
2972 if (VarDecl *VD = Terminator->getConditionVariable()) {
2973 if (Expr *Init = VD->getInit()) {
2974 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00002975 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002976 LastBlock = addStmt(Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00002977 }
2978 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002979
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002980 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002981}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002982
2983static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00002984 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002985 const CaseStmt *CS,
2986 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00002987 if (!switchCond)
2988 return true;
2989
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002990 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00002991
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002992 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00002993 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002994 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00002995 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00002996 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00002997
2998 if (condInt == lhsInt) {
2999 addCase = true;
3000 switchExclusivelyCovered = true;
3001 }
3002 else if (condInt < lhsInt) {
3003 if (const Expr *RHS = CS->getRHS()) {
3004 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003005 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
3006 if (V2 <= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003007 addCase = true;
3008 switchExclusivelyCovered = true;
3009 }
3010 }
3011 }
3012 }
3013 else
3014 addCase = true;
3015 }
3016 return addCase;
3017}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003018
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003019CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003020 // CaseStmts are essentially labels, so they are the first statement in a
3021 // block.
Craig Topper25542942014-05-20 04:30:07 +00003022 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003023
Ted Kremenek60fa6572010-08-04 23:54:30 +00003024 if (Stmt *Sub = CS->getSubStmt()) {
3025 // For deeply nested chains of CaseStmts, instead of doing a recursion
3026 // (which can blow out the stack), manually unroll and create blocks
3027 // along the way.
3028 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003029 CFGBlock *currentBlock = createBlock(false);
3030 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003031
Ted Kremenek60fa6572010-08-04 23:54:30 +00003032 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003033 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003034 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003035 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003036
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003037 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003038 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003039 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003040 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003041
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003042 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003043 CS = cast<CaseStmt>(Sub);
3044 Sub = CS->getSubStmt();
3045 }
3046
3047 addStmt(Sub);
3048 }
Mike Stump11289f42009-09-09 15:08:12 +00003049
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003050 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003051 if (!CaseBlock)
3052 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003053
3054 // Cases statements partition blocks, so this is the top of the basic block we
3055 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003056 CaseBlock->setLabel(CS);
3057
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003058 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003059 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003060
3061 // Add this block to the list of successors for the block with the switch
3062 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003063 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003064 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003065 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003066 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003067
Ted Kremenek9aae5132007-08-23 21:42:29 +00003068 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003069 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003070
Ted Kremenek60fa6572010-08-04 23:54:30 +00003071 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003072 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003073 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003074 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003075 // This block is now the implicit successor of other blocks.
3076 Succ = CaseBlock;
3077 }
Mike Stump31feda52009-07-17 01:31:16 +00003078
Ted Kremenek60fa6572010-08-04 23:54:30 +00003079 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003080}
Mike Stump31feda52009-07-17 01:31:16 +00003081
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003082CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003083 if (Terminator->getSubStmt())
3084 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003085
Ted Kremenek654c78f2008-02-13 22:05:39 +00003086 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003087
3088 if (!DefaultCaseBlock)
3089 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003090
3091 // Default statements partition blocks, so this is the top of the basic block
3092 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003093 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003094
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003095 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003096 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003097
Mike Stump31feda52009-07-17 01:31:16 +00003098 // Unlike case statements, we don't add the default block to the successors
3099 // for the switch statement immediately. This is done when we finish
3100 // processing the switch statement. This allows for the default case
3101 // (including a fall-through to the code after the switch statement) to always
3102 // be the last successor of a switch-terminated block.
3103
Ted Kremenek654c78f2008-02-13 22:05:39 +00003104 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003105 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003106
Ted Kremenek654c78f2008-02-13 22:05:39 +00003107 // This block is now the implicit successor of other blocks.
3108 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003109
3110 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003111}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003112
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003113CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3114 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3115 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003116 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003117
3118 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003119 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003120 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003121 TrySuccessor = Block;
3122 } else TrySuccessor = Succ;
3123
Mike Stump0bdba6c2010-01-20 01:15:34 +00003124 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003125
3126 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003127 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003128 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003129 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003130
Mike Stump0bdba6c2010-01-20 01:15:34 +00003131 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003132 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3133 // The code after the try is the implicit successor.
3134 Succ = TrySuccessor;
3135 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003136 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003137 HasCatchAll = true;
3138 }
Craig Topper25542942014-05-20 04:30:07 +00003139 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003140 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00003141 if (!CatchBlock)
3142 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003143 // Add this block to the list of successors for the block with the try
3144 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003145 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003146 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00003147 if (!HasCatchAll) {
3148 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003149 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00003150 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003151 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00003152 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003153
3154 // The code after the try is the implicit successor.
3155 Succ = TrySuccessor;
3156
Mike Stump845384a2010-01-20 01:30:58 +00003157 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00003158 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
3159 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00003160
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003161 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003162 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003163 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003164}
3165
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003166CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003167 // CXXCatchStmt are treated like labels, so they are the first statement in a
3168 // block.
3169
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003170 // Save local scope position because in case of exception variable ScopePos
3171 // won't be restored when traversing AST.
3172 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3173
3174 // Create local scope for possible exception variable.
3175 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003176 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003177 LocalScope::const_iterator BeginScopePos = ScopePos;
3178 addLocalScopeForVarDecl(VD);
3179 addAutomaticObjDtors(ScopePos, BeginScopePos, CS);
3180 }
3181
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003182 if (CS->getHandlerBlock())
3183 addStmt(CS->getHandlerBlock());
3184
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003185 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003186 if (!CatchBlock)
3187 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003188
3189 // CXXCatchStmt is more than just a label. They have semantic meaning
3190 // as well, as they implicitly "initialize" the catch variable. Add
3191 // it to the CFG as a CFGElement so that the control-flow of these
3192 // semantics gets captured.
3193 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003194
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003195 // Also add the CXXCatchStmt as a label, to mirror handling of regular
3196 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003197 CatchBlock->setLabel(CS);
3198
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003199 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003200 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003201 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003202
3203 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003204 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003205
3206 return CatchBlock;
3207}
3208
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003209CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00003210 // C++0x for-range statements are specified as [stmt.ranged]:
3211 //
3212 // {
3213 // auto && __range = range-init;
3214 // for ( auto __begin = begin-expr,
3215 // __end = end-expr;
3216 // __begin != __end;
3217 // ++__begin ) {
3218 // for-range-declaration = *__begin;
3219 // statement
3220 // }
3221 // }
3222
3223 // Save local scope position before the addition of the implicit variables.
3224 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3225
3226 // Create local scopes and destructors for range, begin and end variables.
3227 if (Stmt *Range = S->getRangeStmt())
3228 addLocalScopeForStmt(Range);
3229 if (Stmt *BeginEnd = S->getBeginEndStmt())
3230 addLocalScopeForStmt(BeginEnd);
3231 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), S);
3232
3233 LocalScope::const_iterator ContinueScopePos = ScopePos;
3234
3235 // "for" is a control-flow statement. Thus we stop processing the current
3236 // block.
Craig Topper25542942014-05-20 04:30:07 +00003237 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003238 if (Block) {
3239 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003240 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003241 LoopSuccessor = Block;
3242 } else
3243 LoopSuccessor = Succ;
3244
3245 // Save the current value for the break targets.
3246 // All breaks should go to the code following the loop.
3247 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
3248 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
3249
3250 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003251 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00003252 ConditionBlock->setTerminator(S);
3253
3254 // Now add the actual condition to the condition block.
3255 if (Expr *C = S->getCond()) {
3256 Block = ConditionBlock;
3257 CFGBlock *BeginConditionBlock = addStmt(C);
3258 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003259 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003260 assert(BeginConditionBlock == ConditionBlock &&
3261 "condition block in for-range was unexpectedly complex");
3262 (void)BeginConditionBlock;
3263 }
3264
3265 // The condition block is the implicit successor for the loop body as well as
3266 // any code above the loop.
3267 Succ = ConditionBlock;
3268
3269 // See if this is a known constant.
3270 TryResult KnownVal(true);
3271
3272 if (S->getCond())
3273 KnownVal = tryEvaluateBool(S->getCond());
3274
3275 // Now create the loop body.
3276 {
3277 assert(S->getBody());
3278
3279 // Save the current values for Block, Succ, and continue targets.
3280 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3281 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
3282
3283 // Generate increment code in its own basic block. This is the target of
3284 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00003285 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003286 Succ = addStmt(S->getInc());
3287 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3288
3289 // The starting block for the loop increment is the block that should
3290 // represent the 'loop target' for looping back to the start of the loop.
3291 ContinueJumpTarget.block->setLoopTarget(S);
3292
3293 // Finish up the increment block and prepare to start the loop body.
3294 assert(Block);
3295 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003296 return nullptr;
3297 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003298
3299 // Add implicit scope and dtors for loop variable.
3300 addLocalScopeAndDtors(S->getLoopVarStmt());
3301
3302 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003303 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00003304 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003305 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003306 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003307 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003308 return nullptr;
3309
Richard Smith02e85f32011-04-14 22:09:26 +00003310 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00003311 addSuccessor(ConditionBlock,
3312 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00003313 }
3314
3315 // Link up the condition block with the code that follows the loop (the
3316 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003317 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00003318
3319 // Add the initialization statements.
3320 Block = createBlock();
Richard Smith0c502d22011-04-18 15:49:25 +00003321 addStmt(S->getBeginEndStmt());
3322 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003323}
3324
John McCall5d413782010-12-06 08:20:24 +00003325CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003326 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00003327 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003328 // If adding implicit destructors visit the full expression for adding
3329 // destructors of temporaries.
3330 VisitForTemporaryDtors(E->getSubExpr());
3331
3332 // Full expression has to be added as CFGStmt so it will be sequenced
3333 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003334 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003335 }
3336 return Visit(E->getSubExpr(), asc);
3337}
3338
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003339CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
3340 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003341 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003342 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003343 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003344
3345 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003346 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003347 }
3348 return Visit(E->getSubExpr(), asc);
3349}
3350
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003351CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
3352 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003353 autoCreateBlock();
Zhongxing Xuf0cb43f2012-01-11 02:39:07 +00003354 appendStmt(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003355
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003356 return VisitChildren(C);
3357}
3358
Jordan Rosec9176072014-01-13 17:59:19 +00003359CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
3360 AddStmtChoice asc) {
3361
3362 autoCreateBlock();
3363 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00003364
Jordan Rosec9176072014-01-13 17:59:19 +00003365 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00003366 Block = Visit(NE->getInitializer());
Jordan Rosec9176072014-01-13 17:59:19 +00003367 if (BuildOpts.AddCXXNewAllocator)
3368 appendNewAllocator(Block, NE);
3369 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00003370 Block = Visit(NE->getArraySize());
Jordan Rosec9176072014-01-13 17:59:19 +00003371 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
3372 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00003373 Block = Visit(*I);
Jordan Rosec9176072014-01-13 17:59:19 +00003374 return Block;
3375}
Jordan Rosed2f40792013-09-03 17:00:57 +00003376
3377CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
3378 AddStmtChoice asc) {
3379 autoCreateBlock();
3380 appendStmt(Block, DE);
3381 QualType DTy = DE->getDestroyedType();
3382 DTy = DTy.getNonReferenceType();
3383 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
3384 if (RD) {
Matt Beaumont-Gay093f2402013-09-09 21:07:58 +00003385 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
Jordan Rosed2f40792013-09-03 17:00:57 +00003386 appendDeleteDtor(Block, RD, DE);
3387 }
3388
3389 return VisitChildren(DE);
3390}
3391
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003392CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
3393 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003394 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003395 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003396 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003397 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003398 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003399 }
3400 return Visit(E->getSubExpr(), asc);
3401}
3402
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003403CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
3404 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003405 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003406 appendStmt(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003407 return VisitChildren(C);
3408}
3409
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003410CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
3411 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003412 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003413 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003414 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003415 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003416 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003417}
3418
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003419CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00003420 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003421 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003422
Ted Kremenekeda180e22007-08-28 19:26:49 +00003423 if (!IBlock) {
3424 IBlock = createBlock(false);
3425 cfg->setIndirectGotoBlock(IBlock);
3426 }
Mike Stump31feda52009-07-17 01:31:16 +00003427
Ted Kremenekeda180e22007-08-28 19:26:49 +00003428 // IndirectGoto is a control-flow statement. Thus we stop processing the
3429 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003430 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003431 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003432
Ted Kremenekeda180e22007-08-28 19:26:49 +00003433 Block = createBlock(false);
3434 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003435 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00003436 return addStmt(I->getTarget());
3437}
3438
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003439CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00003440 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
3441
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003442tryAgain:
3443 if (!E) {
3444 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00003445 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003446 }
3447 switch (E->getStmtClass()) {
3448 default:
3449 return VisitChildrenForTemporaryDtors(E);
3450
3451 case Stmt::BinaryOperatorClass:
3452 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E));
3453
3454 case Stmt::CXXBindTemporaryExprClass:
3455 return VisitCXXBindTemporaryExprForTemporaryDtors(
3456 cast<CXXBindTemporaryExpr>(E), BindToTemporary);
3457
John McCallc07a0c72011-02-17 10:25:35 +00003458 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003459 case Stmt::ConditionalOperatorClass:
3460 return VisitConditionalOperatorForTemporaryDtors(
John McCallc07a0c72011-02-17 10:25:35 +00003461 cast<AbstractConditionalOperator>(E), BindToTemporary);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003462
3463 case Stmt::ImplicitCastExprClass:
3464 // For implicit cast we want BindToTemporary to be passed further.
3465 E = cast<CastExpr>(E)->getSubExpr();
3466 goto tryAgain;
3467
3468 case Stmt::ParenExprClass:
3469 E = cast<ParenExpr>(E)->getSubExpr();
3470 goto tryAgain;
Douglas Gregorfe314812011-06-21 17:03:29 +00003471
3472 case Stmt::MaterializeTemporaryExprClass:
3473 E = cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr();
3474 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003475 }
3476}
3477
3478CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E) {
3479 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00003480 // order that they will appear in the CFG. Because the CFG is built
3481 // bottom-up, this means we visit them in their natural order, which
3482 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003483 CFGBlock *B = Block;
Ted Kremenek8ae67872013-02-05 22:00:19 +00003484 for (Stmt::child_range I = E->children(); I; ++I) {
3485 if (Stmt *Child = *I)
3486 if (CFGBlock *R = VisitForTemporaryDtors(Child))
3487 B = R;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003488 }
3489 return B;
3490}
3491
3492CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E) {
3493 if (E->isLogicalOp()) {
3494 // Destructors for temporaries in LHS expression should be called after
3495 // those for RHS expression. Even if this will unnecessarily create a block,
3496 // this block will be used at least by the full expression.
3497 autoCreateBlock();
3498 CFGBlock *ConfluenceBlock = VisitForTemporaryDtors(E->getLHS());
3499 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003500 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003501
3502 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00003503 Block = nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003504 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS());
3505
3506 if (RHSBlock) {
3507 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003508 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003509
3510 // If RHS expression did produce destructors we need to connect created
3511 // blocks to CFG in same manner as for binary operator itself.
3512 CFGBlock *LHSBlock = createBlock(false);
3513 LHSBlock->setTerminator(CFGTerminator(E, true));
3514
3515 // For binary operator LHS block is before RHS in list of predecessors
3516 // of ConfluenceBlock.
3517 std::reverse(ConfluenceBlock->pred_begin(),
3518 ConfluenceBlock->pred_end());
3519
3520 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003521 TryResult KnownVal = tryEvaluateBool(E->getLHS());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003522 if (KnownVal.isKnown() && (E->getOpcode() == BO_LOr))
3523 KnownVal.negate();
3524
3525 // Link LHSBlock with RHSBlock exactly the same way as for binary operator
3526 // itself.
3527 if (E->getOpcode() == BO_LOr) {
Craig Topper25542942014-05-20 04:30:07 +00003528 addSuccessor(LHSBlock, KnownVal.isTrue() ? nullptr : ConfluenceBlock);
3529 addSuccessor(LHSBlock, KnownVal.isFalse() ? nullptr : RHSBlock);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003530 } else {
3531 assert (E->getOpcode() == BO_LAnd);
Craig Topper25542942014-05-20 04:30:07 +00003532 addSuccessor(LHSBlock, KnownVal.isFalse() ? nullptr : RHSBlock);
3533 addSuccessor(LHSBlock, KnownVal.isTrue() ? nullptr : ConfluenceBlock);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003534 }
3535
3536 Block = LHSBlock;
3537 return LHSBlock;
3538 }
3539
3540 Block = ConfluenceBlock;
3541 return ConfluenceBlock;
3542 }
3543
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003544 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003545 // For assignment operator (=) LHS expression is visited
3546 // before RHS expression. For destructors visit them in reverse order.
3547 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS());
3548 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS());
3549 return LHSBlock ? LHSBlock : RHSBlock;
3550 }
3551
3552 // For any other binary operator RHS expression is visited before
3553 // LHS expression (order of children). For destructors visit them in reverse
3554 // order.
3555 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS());
3556 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS());
3557 return RHSBlock ? RHSBlock : LHSBlock;
3558}
3559
3560CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
3561 CXXBindTemporaryExpr *E, bool BindToTemporary) {
3562 // First add destructors for temporaries in subexpression.
3563 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr());
Zhongxing Xufee455f2010-11-14 15:23:50 +00003564 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003565 // If lifetime of temporary is not prolonged (by assigning to constant
3566 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00003567
3568 // If the destructor is marked as a no-return destructor, we need to create
3569 // a new block for the destructor which does not have as a successor
3570 // anything built thus far. Control won't flow out of this block.
3571 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Ted Kremenekff909f92014-03-08 02:22:25 +00003572 if (Dtor->isNoReturn()) {
3573 Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00003574 Block = createNoReturnBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00003575 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00003576 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00003577 }
Chandler Carruthad747252011-09-13 06:09:01 +00003578
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003579 appendTemporaryDtor(Block, E);
3580 B = Block;
3581 }
3582 return B;
3583}
3584
3585CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
John McCallc07a0c72011-02-17 10:25:35 +00003586 AbstractConditionalOperator *E, bool BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003587 // First add destructors for condition expression. Even if this will
3588 // unnecessarily create a block, this block will be used at least by the full
3589 // expression.
3590 autoCreateBlock();
3591 CFGBlock *ConfluenceBlock = VisitForTemporaryDtors(E->getCond());
3592 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003593 return nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003594 if (BinaryConditionalOperator *BCO
3595 = dyn_cast<BinaryConditionalOperator>(E)) {
3596 ConfluenceBlock = VisitForTemporaryDtors(BCO->getCommon());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003597 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003598 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003599 }
3600
John McCallc07a0c72011-02-17 10:25:35 +00003601 // Try to add block with destructors for LHS expression.
Craig Topper25542942014-05-20 04:30:07 +00003602 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003603 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00003604 Block = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003605 LHSBlock = VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary);
3606 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003607 return nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003608
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003609 // Try to add block with destructors for RHS expression;
3610 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00003611 Block = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00003612 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getFalseExpr(),
3613 BindToTemporary);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003614 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003615 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003616
3617 if (!RHSBlock && !LHSBlock) {
3618 // If neither LHS nor RHS expression had temporaries to destroy don't create
3619 // more blocks.
3620 Block = ConfluenceBlock;
3621 return Block;
3622 }
3623
3624 Block = createBlock(false);
3625 Block->setTerminator(CFGTerminator(E, true));
Ted Kremenekfcc14172014-03-08 02:22:29 +00003626 assert(Block->getTerminator().isTemporaryDtorsBranch());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003627
3628 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003629 const TryResult &KnownVal = tryEvaluateBool(E->getCond());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003630
3631 if (LHSBlock) {
Ted Kremenek5a095272014-03-04 21:53:26 +00003632 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003633 } else if (KnownVal.isFalse()) {
Craig Topper25542942014-05-20 04:30:07 +00003634 addSuccessor(Block, nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003635 } else {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003636 addSuccessor(Block, ConfluenceBlock);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003637 std::reverse(ConfluenceBlock->pred_begin(), ConfluenceBlock->pred_end());
3638 }
3639
3640 if (!RHSBlock)
3641 RHSBlock = ConfluenceBlock;
Ted Kremenek5a095272014-03-04 21:53:26 +00003642
3643 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003644
3645 return Block;
3646}
3647
Ted Kremenek04cca642007-08-23 21:26:19 +00003648} // end anonymous namespace
Ted Kremenek889073f2007-08-23 16:51:22 +00003649
Mike Stump31feda52009-07-17 01:31:16 +00003650/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
3651/// no successors or predecessors. If this is the first block created in the
3652/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003653CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00003654 bool first_block = begin() == end();
3655
3656 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003657 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00003658 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003659 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00003660
3661 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003662 if (first_block)
3663 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00003664
3665 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003666 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00003667}
3668
Ted Kremenek889073f2007-08-23 16:51:22 +00003669/// buildCFG - Constructs a CFG from an AST. Ownership of the returned
3670/// CFG is returned to the caller.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003671CFG* CFG::buildCFG(const Decl *D, Stmt *Statement, ASTContext *C,
Ted Kremenekf9d82902011-03-10 01:14:05 +00003672 const BuildOptions &BO) {
3673 CFGBuilder Builder(C, BO);
3674 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00003675}
3676
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003677const CXXDestructorDecl *
3678CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003679 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003680 case CFGElement::Statement:
3681 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00003682 case CFGElement::NewAllocator:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003683 llvm_unreachable("getDestructorDecl should only be used with "
3684 "ImplicitDtors");
3685 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00003686 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003687 QualType ty = var->getType();
Ted Kremenek1676a042011-03-03 01:01:03 +00003688 ty = ty.getNonReferenceType();
Ted Kremeneke7d78882012-03-19 23:48:41 +00003689 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003690 ty = arrayType->getElementType();
3691 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003692 const RecordType *recordType = ty->getAs<RecordType>();
3693 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00003694 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003695 return classDecl->getDestructor();
3696 }
Jordan Rosed2f40792013-09-03 17:00:57 +00003697 case CFGElement::DeleteDtor: {
3698 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
3699 QualType DTy = DE->getDestroyedType();
3700 DTy = DTy.getNonReferenceType();
3701 const CXXRecordDecl *classDecl =
3702 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
3703 return classDecl->getDestructor();
3704 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003705 case CFGElement::TemporaryDtor: {
3706 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00003707 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003708 const CXXTemporary *temp = bindExpr->getTemporary();
3709 return temp->getDestructor();
3710 }
3711 case CFGElement::BaseDtor:
3712 case CFGElement::MemberDtor:
3713
3714 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00003715 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003716 }
Ted Kremenek1676a042011-03-03 01:01:03 +00003717 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003718}
3719
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003720bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00003721 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
3722 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003723 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00003724}
3725
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00003726//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003727// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00003728//===----------------------------------------------------------------------===//
3729
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003730CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Craig Topper25542942014-05-20 04:30:07 +00003731 : ReachableBlock(IsReachable ? B : nullptr),
3732 UnreachableBlock(!IsReachable ? B : nullptr,
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003733 B && IsReachable ? AB_Normal : AB_Unreachable) {}
3734
3735CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
3736 : ReachableBlock(B),
Craig Topper25542942014-05-20 04:30:07 +00003737 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003738 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
3739
3740void CFGBlock::addSuccessor(AdjacentBlock Succ,
3741 BumpVectorContext &C) {
3742 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00003743 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003744
3745 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00003746 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003747
3748 Succs.push_back(Succ, C);
3749}
3750
Ted Kremenekb0371852010-09-09 00:06:04 +00003751bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00003752 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003753
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003754 if (F.IgnoreNullPredecessors && !From)
3755 return true;
3756
3757 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003758 // If the 'To' has no label or is labeled but the label isn't a
3759 // CaseStmt then filter this edge.
3760 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00003761 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003762 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00003763 const Stmt *L = To->getLabel();
3764 if (!L || !isa<CaseStmt>(L))
3765 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00003766 }
3767 }
3768 }
3769
3770 return false;
3771}
3772
3773//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00003774// CFG pretty printing
3775//===----------------------------------------------------------------------===//
3776
Ted Kremenek7e776b12007-08-22 18:22:34 +00003777namespace {
3778
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00003779class StmtPrinterHelper : public PrinterHelper {
Ted Kremenek96a7a592011-03-01 03:15:10 +00003780 typedef llvm::DenseMap<const Stmt*,std::pair<unsigned,unsigned> > StmtMapTy;
3781 typedef llvm::DenseMap<const Decl*,std::pair<unsigned,unsigned> > DeclMapTy;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003782 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003783 DeclMapTy DeclMap;
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003784 signed currentBlock;
Ted Kremenekd94854a2012-08-22 06:26:15 +00003785 unsigned currStmt;
Chris Lattnerc61089a2009-06-30 01:26:17 +00003786 const LangOptions &LangOpts;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003787public:
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003788
Chris Lattnerc61089a2009-06-30 01:26:17 +00003789 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Ted Kremenekd94854a2012-08-22 06:26:15 +00003790 : currentBlock(0), currStmt(0), LangOpts(LO)
Ted Kremenek96a7a592011-03-01 03:15:10 +00003791 {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003792 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
3793 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003794 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003795 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00003796 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
3797 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003798 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00003799 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003800
Ted Kremenek96a7a592011-03-01 03:15:10 +00003801 switch (stmt->getStmtClass()) {
3802 case Stmt::DeclStmtClass:
3803 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
3804 break;
3805 case Stmt::IfStmtClass: {
3806 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
3807 if (var)
3808 DeclMap[var] = P;
3809 break;
3810 }
3811 case Stmt::ForStmtClass: {
3812 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
3813 if (var)
3814 DeclMap[var] = P;
3815 break;
3816 }
3817 case Stmt::WhileStmtClass: {
3818 const VarDecl *var =
3819 cast<WhileStmt>(stmt)->getConditionVariable();
3820 if (var)
3821 DeclMap[var] = P;
3822 break;
3823 }
3824 case Stmt::SwitchStmtClass: {
3825 const VarDecl *var =
3826 cast<SwitchStmt>(stmt)->getConditionVariable();
3827 if (var)
3828 DeclMap[var] = P;
3829 break;
3830 }
3831 case Stmt::CXXCatchStmtClass: {
3832 const VarDecl *var =
3833 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
3834 if (var)
3835 DeclMap[var] = P;
3836 break;
3837 }
3838 default:
3839 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003840 }
3841 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003842 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00003843 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003844 }
Ted Kremenek96a7a592011-03-01 03:15:10 +00003845
Mike Stump31feda52009-07-17 01:31:16 +00003846
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003847 virtual ~StmtPrinterHelper() {}
Mike Stump31feda52009-07-17 01:31:16 +00003848
Chris Lattnerc61089a2009-06-30 01:26:17 +00003849 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003850 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00003851 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00003852
Craig Topperb45acb82014-03-14 06:02:07 +00003853 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003854 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003855
3856 if (I == StmtMap.end())
3857 return false;
Mike Stump31feda52009-07-17 01:31:16 +00003858
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003859 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00003860 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003861 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00003862 }
Mike Stump31feda52009-07-17 01:31:16 +00003863
Ted Kremenek60983dc2010-01-19 20:52:05 +00003864 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003865 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003866 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003867
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003868 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003869 DeclMapTy::iterator I = DeclMap.find(D);
3870
3871 if (I == DeclMap.end())
3872 return false;
3873
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003874 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00003875 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003876 return false;
3877 }
3878
3879 OS << "[B" << I->second.first << "." << I->second.second << "]";
3880 return true;
3881 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003882};
Chris Lattnerc61089a2009-06-30 01:26:17 +00003883} // end anonymous namespace
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003884
Chris Lattnerc61089a2009-06-30 01:26:17 +00003885
3886namespace {
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00003887class CFGBlockTerminatorPrint
Ted Kremenek83ebcef2008-01-08 18:15:10 +00003888 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Mike Stump31feda52009-07-17 01:31:16 +00003889
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003890 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003891 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00003892 PrintingPolicy Policy;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003893public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003894 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00003895 const PrintingPolicy &Policy)
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00003896 : OS(os), Helper(helper), Policy(Policy) {
3897 this->Policy.IncludeNewlines = false;
3898 }
Mike Stump31feda52009-07-17 01:31:16 +00003899
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003900 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003901 OS << "if ";
Douglas Gregor7de59662009-05-29 20:38:28 +00003902 I->getCond()->printPretty(OS,Helper,Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003903 }
Mike Stump31feda52009-07-17 01:31:16 +00003904
Ted Kremenek9aae5132007-08-23 21:42:29 +00003905 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003906 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003907 Terminator->printPretty(OS, Helper, Policy);
3908 }
3909
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00003910 void VisitDeclStmt(DeclStmt *DS) {
3911 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
3912 OS << "static init " << VD->getName();
3913 }
3914
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003915 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003916 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00003917 if (F->getInit())
3918 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00003919 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003920 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00003921 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00003922 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00003923 if (F->getInc())
3924 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00003925 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00003926 }
Mike Stump31feda52009-07-17 01:31:16 +00003927
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003928 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003929 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003930 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00003931 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003932 }
Mike Stump31feda52009-07-17 01:31:16 +00003933
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003934 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003935 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003936 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00003937 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00003938 }
Mike Stump31feda52009-07-17 01:31:16 +00003939
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003940 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00003941 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00003942 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00003943 }
Mike Stump31feda52009-07-17 01:31:16 +00003944
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003945 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003946 OS << "try ...";
3947 }
3948
John McCallc07a0c72011-02-17 10:25:35 +00003949 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Douglas Gregor7de59662009-05-29 20:38:28 +00003950 C->getCond()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00003951 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00003952 }
Mike Stump31feda52009-07-17 01:31:16 +00003953
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003954 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00003955 OS << "__builtin_choose_expr( ";
Douglas Gregor7de59662009-05-29 20:38:28 +00003956 C->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00003957 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00003958 }
Mike Stump31feda52009-07-17 01:31:16 +00003959
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003960 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003961 OS << "goto *";
Douglas Gregor7de59662009-05-29 20:38:28 +00003962 I->getTarget()->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003963 }
Mike Stump31feda52009-07-17 01:31:16 +00003964
Ted Kremenek7f7dd762007-08-31 21:49:40 +00003965 void VisitBinaryOperator(BinaryOperator* B) {
3966 if (!B->isLogicalOp()) {
3967 VisitExpr(B);
3968 return;
3969 }
Mike Stump31feda52009-07-17 01:31:16 +00003970
Douglas Gregor7de59662009-05-29 20:38:28 +00003971 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00003972
Ted Kremenek7f7dd762007-08-31 21:49:40 +00003973 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00003974 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00003975 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00003976 return;
John McCalle3027922010-08-25 11:45:40 +00003977 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00003978 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00003979 return;
3980 default:
David Blaikie83d382b2011-09-23 05:06:16 +00003981 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00003982 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00003983 }
Mike Stump31feda52009-07-17 01:31:16 +00003984
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003985 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00003986 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00003987 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00003988
3989public:
3990 void print(CFGTerminator T) {
3991 if (T.isTemporaryDtorsBranch())
3992 OS << "(Temp Dtor) ";
3993 Visit(T.getStmt());
3994 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003995};
Chris Lattnerc61089a2009-06-30 01:26:17 +00003996} // end anonymous namespace
3997
Aaron Ballmanff924b02013-11-18 20:11:50 +00003998static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00003999 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004000 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4001 const Stmt *S = CS->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004002
Aaron Ballmanff924b02013-11-18 20:11:50 +00004003 // special printing for statement-expressions.
4004 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
4005 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00004006
Aaron Ballmanff924b02013-11-18 20:11:50 +00004007 if (Sub->children()) {
4008 OS << "({ ... ; ";
4009 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
4010 OS << " })\n";
4011 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004012 }
4013 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00004014 // special printing for comma expressions.
4015 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
4016 if (B->getOpcode() == BO_Comma) {
4017 OS << "... , ";
4018 Helper.handledStmt(B->getRHS(),OS);
4019 OS << '\n';
4020 return;
4021 }
4022 }
4023 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00004024
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004025 if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004026 OS << " (OperatorCall)";
Ted Kremenek0ffba932011-12-21 19:32:38 +00004027 }
4028 else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004029 OS << " (BindTemporary)";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004030 }
Ted Kremenek1a7648b2011-12-21 19:39:59 +00004031 else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
4032 OS << " (CXXConstructExpr, " << CCE->getType().getAsString() << ")";
4033 }
Ted Kremenek0ffba932011-12-21 19:32:38 +00004034 else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
4035 OS << " (" << CE->getStmtClassName() << ", "
4036 << CE->getCastKindName()
4037 << ", " << CE->getType().getAsString()
4038 << ")";
4039 }
Mike Stump31feda52009-07-17 01:31:16 +00004040
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004041 // Expressions need a newline.
4042 if (isa<Expr>(S))
4043 OS << '\n';
Ted Kremenek0f5d8bc2010-08-31 18:47:37 +00004044
David Blaikie00be69a2013-02-23 00:29:34 +00004045 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
4046 const CXXCtorInitializer *I = IE->getInitializer();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004047 if (I->isBaseInitializer())
4048 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
Jordan Rose69d0aed2013-10-22 23:19:47 +00004049 else if (I->isDelegatingInitializer())
4050 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
Francois Pichetd583da02010-12-04 09:14:42 +00004051 else OS << I->getAnyMember()->getName();
Mike Stump31feda52009-07-17 01:31:16 +00004052
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004053 OS << "(";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004054 if (Expr *IE = I->getInit())
Aaron Ballmanff924b02013-11-18 20:11:50 +00004055 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004056 OS << ")";
4057
4058 if (I->isBaseInitializer())
4059 OS << " (Base initializer)\n";
Jordan Rose69d0aed2013-10-22 23:19:47 +00004060 else if (I->isDelegatingInitializer())
4061 OS << " (Delegating initializer)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004062 else OS << " (Member initializer)\n";
4063
David Blaikie00be69a2013-02-23 00:29:34 +00004064 } else if (Optional<CFGAutomaticObjDtor> DE =
4065 E.getAs<CFGAutomaticObjDtor>()) {
4066 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00004067 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004068
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00004069 const Type* T = VD->getType().getTypePtr();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004070 if (const ReferenceType* RT = T->getAs<ReferenceType>())
4071 T = RT->getPointeeType().getTypePtr();
Richard Smithf676e452012-07-24 21:02:14 +00004072 T = T->getBaseElementTypeUnsafe();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004073
4074 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
4075 OS << " (Implicit destructor)\n";
Marcin Swiderski20b88732010-10-05 05:37:00 +00004076
Jordan Rosec9176072014-01-13 17:59:19 +00004077 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
4078 OS << "CFGNewAllocator(";
4079 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
4080 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
4081 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00004082 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
4083 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
4084 if (!RD)
4085 return;
4086 CXXDeleteExpr *DelExpr =
4087 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00004088 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00004089 OS << "->~" << RD->getName().str() << "()";
4090 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004091 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
4092 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004093 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004094 OS << " (Base object destructor)\n";
Marcin Swiderski20b88732010-10-05 05:37:00 +00004095
David Blaikie00be69a2013-02-23 00:29:34 +00004096 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
4097 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00004098 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004099 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00004100 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004101 OS << " (Member object destructor)\n";
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004102
David Blaikie00be69a2013-02-23 00:29:34 +00004103 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
4104 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00004105 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004106 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00004107 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004108 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004109}
Mike Stump31feda52009-07-17 01:31:16 +00004110
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004111static void print_block(raw_ostream &OS, const CFG* cfg,
4112 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00004113 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004114 bool ShowColors) {
Mike Stump31feda52009-07-17 01:31:16 +00004115
Aaron Ballmanff924b02013-11-18 20:11:50 +00004116 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00004117
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004118 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004119 if (ShowColors)
4120 OS.changeColor(raw_ostream::YELLOW, true);
4121
4122 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00004123
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004124 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004125 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004126 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004127 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004128 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004129 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00004130 else if (B.hasNoReturnElement())
4131 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004132 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00004133 OS << "]\n";
4134
4135 if (ShowColors)
4136 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00004137
Ted Kremenek71eca012007-08-29 23:20:49 +00004138 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004139 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004140
4141 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004142 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004143
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004144 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004145 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004146 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00004147 OS << "case ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004148 C->getLHS()->printPretty(OS, &Helper,
4149 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004150 if (C->getRHS()) {
4151 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004152 C->getRHS()->printPretty(OS, &Helper,
4153 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004154 }
Mike Stump92244b02010-01-19 22:00:14 +00004155 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004156 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00004157 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004158 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00004159 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00004160 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00004161 0);
4162 else
4163 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004164 OS << ")";
4165
4166 } else
David Blaikie83d382b2011-09-23 05:06:16 +00004167 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00004168
Ted Kremenek71eca012007-08-29 23:20:49 +00004169 OS << ":\n";
4170 }
Mike Stump31feda52009-07-17 01:31:16 +00004171
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004172 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004173 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00004174
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004175 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
4176 I != E ; ++I, ++j ) {
Mike Stump31feda52009-07-17 01:31:16 +00004177
Ted Kremenek71eca012007-08-29 23:20:49 +00004178 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004179 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004180 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004181
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004182 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00004183
Aaron Ballmanff924b02013-11-18 20:11:50 +00004184 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00004185
Ted Kremenek72be32a2011-12-22 23:33:52 +00004186 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004187 }
Mike Stump31feda52009-07-17 01:31:16 +00004188
Ted Kremenek71eca012007-08-29 23:20:49 +00004189 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004190 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00004191 if (ShowColors)
4192 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00004193
Ted Kremenek72be32a2011-12-22 23:33:52 +00004194 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00004195
Aaron Ballmanff924b02013-11-18 20:11:50 +00004196 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00004197
Aaron Ballmanff924b02013-11-18 20:11:50 +00004198 PrintingPolicy PP(Helper.getLangOpts());
4199 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00004200 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004201 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00004202
4203 if (ShowColors)
4204 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004205 }
Mike Stump31feda52009-07-17 01:31:16 +00004206
Ted Kremenek71eca012007-08-29 23:20:49 +00004207 if (print_edges) {
4208 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004209 if (!B.pred_empty()) {
4210 const raw_ostream::Colors Color = raw_ostream::BLUE;
4211 if (ShowColors)
4212 OS.changeColor(Color);
4213 OS << " Preds " ;
4214 if (ShowColors)
4215 OS.resetColor();
4216 OS << '(' << B.pred_size() << "):";
4217 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00004218
Ted Kremenek72be32a2011-12-22 23:33:52 +00004219 if (ShowColors)
4220 OS.changeColor(Color);
4221
4222 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
4223 I != E; ++I, ++i) {
Mike Stump31feda52009-07-17 01:31:16 +00004224
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004225 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004226 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00004227
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004228 CFGBlock *B = *I;
4229 bool Reachable = true;
4230 if (!B) {
4231 Reachable = false;
4232 B = I->getPossiblyUnreachableBlock();
4233 }
4234
4235 OS << " B" << B->getBlockID();
4236 if (!Reachable)
4237 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00004238 }
4239
4240 if (ShowColors)
4241 OS.resetColor();
4242
4243 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00004244 }
Mike Stump31feda52009-07-17 01:31:16 +00004245
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004246 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004247 if (!B.succ_empty()) {
4248 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
4249 if (ShowColors)
4250 OS.changeColor(Color);
4251 OS << " Succs ";
4252 if (ShowColors)
4253 OS.resetColor();
4254 OS << '(' << B.succ_size() << "):";
4255 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004256
Ted Kremenek72be32a2011-12-22 23:33:52 +00004257 if (ShowColors)
4258 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00004259
Ted Kremenek72be32a2011-12-22 23:33:52 +00004260 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
4261 I != E; ++I, ++i) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004262
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004263 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004264 OS << "\n ";
4265
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004266 CFGBlock *B = *I;
4267
4268 bool Reachable = true;
4269 if (!B) {
4270 Reachable = false;
4271 B = I->getPossiblyUnreachableBlock();
4272 }
4273
4274 if (B) {
4275 OS << " B" << B->getBlockID();
4276 if (!Reachable)
4277 OS << "(Unreachable)";
4278 }
4279 else {
4280 OS << " NULL";
4281 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00004282 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004283
Ted Kremenek72be32a2011-12-22 23:33:52 +00004284 if (ShowColors)
4285 OS.resetColor();
4286 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004287 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004288 }
Mike Stump31feda52009-07-17 01:31:16 +00004289}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004290
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004291
4292/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004293void CFG::dump(const LangOptions &LO, bool ShowColors) const {
4294 print(llvm::errs(), LO, ShowColors);
4295}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004296
4297/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004298void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00004299 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00004300
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004301 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00004302 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00004303
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004304 // Iterate through the CFGBlocks and print them one by one.
4305 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
4306 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004307 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004308 continue;
Mike Stump31feda52009-07-17 01:31:16 +00004309
Aaron Ballmanff924b02013-11-18 20:11:50 +00004310 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004311 }
Mike Stump31feda52009-07-17 01:31:16 +00004312
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004313 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00004314 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00004315 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00004316 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00004317}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004318
4319/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004320void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
4321 bool ShowColors) const {
4322 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00004323}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004324
4325/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
4326/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004327void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004328 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00004329 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00004330 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00004331 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00004332}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004333
Ted Kremenek15647632008-01-30 23:02:42 +00004334/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004335void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00004336 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00004337 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00004338 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004339}
4340
Ted Kremenekec3bbf42014-03-29 00:35:20 +00004341Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00004342 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004343 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00004344 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004345
Craig Topper25542942014-05-20 04:30:07 +00004346 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004347
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004348 switch (Terminator->getStmtClass()) {
4349 default:
4350 break;
Mike Stump31feda52009-07-17 01:31:16 +00004351
Jordan Rosecf10ea82013-06-06 21:53:45 +00004352 case Stmt::CXXForRangeStmtClass:
4353 E = cast<CXXForRangeStmt>(Terminator)->getCond();
4354 break;
4355
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004356 case Stmt::ForStmtClass:
4357 E = cast<ForStmt>(Terminator)->getCond();
4358 break;
Mike Stump31feda52009-07-17 01:31:16 +00004359
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004360 case Stmt::WhileStmtClass:
4361 E = cast<WhileStmt>(Terminator)->getCond();
4362 break;
Mike Stump31feda52009-07-17 01:31:16 +00004363
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004364 case Stmt::DoStmtClass:
4365 E = cast<DoStmt>(Terminator)->getCond();
4366 break;
Mike Stump31feda52009-07-17 01:31:16 +00004367
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004368 case Stmt::IfStmtClass:
4369 E = cast<IfStmt>(Terminator)->getCond();
4370 break;
Mike Stump31feda52009-07-17 01:31:16 +00004371
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004372 case Stmt::ChooseExprClass:
4373 E = cast<ChooseExpr>(Terminator)->getCond();
4374 break;
Mike Stump31feda52009-07-17 01:31:16 +00004375
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004376 case Stmt::IndirectGotoStmtClass:
4377 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
4378 break;
Mike Stump31feda52009-07-17 01:31:16 +00004379
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004380 case Stmt::SwitchStmtClass:
4381 E = cast<SwitchStmt>(Terminator)->getCond();
4382 break;
Mike Stump31feda52009-07-17 01:31:16 +00004383
John McCallc07a0c72011-02-17 10:25:35 +00004384 case Stmt::BinaryConditionalOperatorClass:
4385 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
4386 break;
4387
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004388 case Stmt::ConditionalOperatorClass:
4389 E = cast<ConditionalOperator>(Terminator)->getCond();
4390 break;
Mike Stump31feda52009-07-17 01:31:16 +00004391
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004392 case Stmt::BinaryOperatorClass: // '&&' and '||'
4393 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00004394 break;
Mike Stump31feda52009-07-17 01:31:16 +00004395
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00004396 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00004397 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004398 }
Mike Stump31feda52009-07-17 01:31:16 +00004399
Ted Kremenekec3bbf42014-03-29 00:35:20 +00004400 if (!StripParens)
4401 return E;
4402
Craig Topper25542942014-05-20 04:30:07 +00004403 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004404}
4405
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004406//===----------------------------------------------------------------------===//
4407// CFG Graphviz Visualization
4408//===----------------------------------------------------------------------===//
4409
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004410
4411#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00004412static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004413#endif
4414
Chris Lattnerc61089a2009-06-30 01:26:17 +00004415void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004416#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00004417 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004418 GraphHelper = &H;
4419 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00004420 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004421#endif
4422}
4423
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004424namespace llvm {
4425template<>
4426struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Tobias Grosser9fc223a2009-11-30 14:16:05 +00004427
4428 DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
4429
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004430 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004431
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00004432#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004433 std::string OutSStr;
4434 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00004435 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004436 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004437
4438 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
4439
4440 // Process string output to make it nicer...
4441 for (unsigned i = 0; i != OutStr.length(); ++i)
4442 if (OutStr[i] == '\n') { // Left justify
4443 OutStr[i] = '\\';
4444 OutStr.insert(OutStr.begin()+i+1, 'l');
4445 }
Mike Stump31feda52009-07-17 01:31:16 +00004446
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004447 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00004448#else
4449 return "";
4450#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004451 }
4452};
4453} // end namespace llvm