blob: 3a26ff5ea961119edb791e84432c330bda523de2 [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;
Manuel Klimekd9b4ad62014-08-06 12:45:51 +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
Manuel Klimekd9b4ad62014-08-06 12:45:51 +0000413 /// When creating the CFG for temporary destructors, we want to mirror the
414 /// branch structure of the corresponding constructor calls.
415 /// Thus, while visiting a statement for temporary destructors, we keep a
416 /// context to keep track of the following information:
417 /// - whether a subexpression is executed unconditionally
418 /// - if a subexpression is executed conditionally, the first
419 /// CXXBindTemporaryExpr we encounter in that subexpression (which
420 /// corresponds to the last temporary destructor we have to call for this
421 /// subexpression) and the CFG block at that point (which will become the
422 /// successor block when inserting the decision point).
423 ///
424 /// That way, we can build the branch structure for temporary destructors as
425 /// follows:
426 /// 1. If a subexpression is executed unconditionally, we add the temporary
427 /// destructor calls to the current block.
428 /// 2. If a subexpression is executed conditionally, when we encounter a
429 /// CXXBindTemporaryExpr:
430 /// a) If it is the first temporary destructor call in the subexpression,
431 /// we remember the CXXBindTemporaryExpr and the current block in the
432 /// TempDtorContext; we start a new block, and insert the temporary
433 /// destructor call.
434 /// b) Otherwise, add the temporary destructor call to the current block.
435 /// 3. When we finished visiting a conditionally executed subexpression,
436 /// and we found at least one temporary constructor during the visitation
437 /// (2.a has executed), we insert a decision block that uses the
438 /// CXXBindTemporaryExpr as terminator, and branches to the current block
439 /// if the CXXBindTemporaryExpr was marked executed, and otherwise
440 /// branches to the stored successor.
441 struct TempDtorContext {
442 TempDtorContext(bool IsConditional)
443 : IsConditional(IsConditional),
444 Succ(nullptr),
445 TerminatorExpr(nullptr) {}
446
447 /// Returns whether we need to start a new branch for a temporary destructor
448 /// call. This is the case when the the temporary destructor is
449 /// conditionally executed, and it is the first one we encounter while
450 /// visiting a subexpression - other temporary destructors at the same level
451 /// will be added to the same block and are executed under the same
452 /// condition.
453 bool needsTempDtorBranch() const {
454 return IsConditional && !TerminatorExpr;
455 }
456
457 /// Remember the successor S of a temporary destructor decision branch for
458 /// the corresponding CXXBindTemporaryExpr E.
459 void setDecisionPoint(CFGBlock *S, CXXBindTemporaryExpr *E) {
460 Succ = S;
461 TerminatorExpr = E;
462 }
463
464 const bool IsConditional;
465 CFGBlock *Succ;
466 CXXBindTemporaryExpr *TerminatorExpr;
467 };
468
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000469 // Visitors to walk an AST and generate destructors of temporaries in
470 // full expression.
Manuel Klimekd9b4ad62014-08-06 12:45:51 +0000471 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
472 TempDtorContext &Context);
473 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E, TempDtorContext &Context);
474 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E,
475 TempDtorContext &Context);
476 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(
477 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context);
478 CFGBlock *VisitConditionalOperatorForTemporaryDtors(
479 AbstractConditionalOperator *E, bool BindToTemporary,
480 TempDtorContext &Context);
481 void InsertTempDtorDecisionBlock(const TempDtorContext &Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000482
Ted Kremenek6065ef62008-04-28 18:00:46 +0000483 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000484 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000485 badCFG = true;
486 return Block;
487 }
Mike Stump31feda52009-07-17 01:31:16 +0000488
Ted Kremenek93668002009-07-17 22:18:43 +0000489 void autoCreateBlock() { if (!Block) Block = createBlock(); }
490 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000491 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000492
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000493 CFGBlock *addStmt(Stmt *S) {
494 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000495 }
Alexis Hunt1d792652011-01-08 20:30:50 +0000496 CFGBlock *addInitializer(CXXCtorInitializer *I);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000497 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000498 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000499 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000500
Marcin Swiderski5e415732010-09-30 23:05:00 +0000501 // Local scopes creation.
502 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
503
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000504 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000505 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
506 LocalScope* Scope = nullptr);
507 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000508
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000509 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000510
511 // Interface to CFGBlock - adding CFGElements.
Ted Kremenek37881932011-04-04 23:29:12 +0000512 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000513 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000514 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000515
Jordy Rose17347372011-06-10 08:49:37 +0000516 // All block-level expressions should have already been IgnoreParens()ed.
517 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000518 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000519 }
Alexis Hunt1d792652011-01-08 20:30:50 +0000520 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000521 B->appendInitializer(I, cfg->getBumpVectorContext());
522 }
Jordan Rosec9176072014-01-13 17:59:19 +0000523 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
524 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
525 }
Marcin Swiderski20b88732010-10-05 05:37:00 +0000526 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
527 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
528 }
529 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
530 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
531 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000532 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
533 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
534 }
Chandler Carruthad747252011-09-13 06:09:01 +0000535 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
536 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
537 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000538
Jordan Rosed2f40792013-09-03 17:00:57 +0000539 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
540 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
541 }
542
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000543 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000544 LocalScope::const_iterator B, LocalScope::const_iterator E);
545
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000546 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
547 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
548 cfg->getBumpVectorContext());
549 }
550
551 /// Add a reachable successor to a block, with the alternate variant that is
552 /// unreachable.
553 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
554 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
555 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000556 }
Mike Stump11289f42009-09-09 15:08:12 +0000557
Richard Trieuf935b562014-04-05 05:17:01 +0000558 /// \brief Find a relational comparison with an expression evaluating to a
559 /// boolean and a constant other than 0 and 1.
560 /// e.g. if ((x < y) == 10)
561 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
562 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
563 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
564
565 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
566 const Expr *BoolExpr = RHSExpr;
567 bool IntFirst = true;
568 if (!IntLiteral) {
569 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
570 BoolExpr = LHSExpr;
571 IntFirst = false;
572 }
573
574 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
575 return TryResult();
576
577 llvm::APInt IntValue = IntLiteral->getValue();
578 if ((IntValue == 1) || (IntValue == 0))
579 return TryResult();
580
581 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
582 !IntValue.isNegative();
583
584 BinaryOperatorKind Bok = B->getOpcode();
585 if (Bok == BO_GT || Bok == BO_GE) {
586 // Always true for 10 > bool and bool > -1
587 // Always false for -1 > bool and bool > 10
588 return TryResult(IntFirst == IntLarger);
589 } else {
590 // Always true for -1 < bool and bool < 10
591 // Always false for 10 < bool and bool < -1
592 return TryResult(IntFirst != IntLarger);
593 }
594 }
595
Jordan Rose7afd71e2014-05-20 17:31:11 +0000596 /// Find an incorrect equality comparison. Either with an expression
597 /// evaluating to a boolean and a constant other than 0 and 1.
598 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
599 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000600 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
601 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
602 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
603
604 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
605 const Expr *BoolExpr = RHSExpr;
606
607 if (!IntLiteral) {
608 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
609 BoolExpr = LHSExpr;
610 }
611
Jordan Rose7afd71e2014-05-20 17:31:11 +0000612 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000613 return TryResult();
614
Jordan Rose7afd71e2014-05-20 17:31:11 +0000615 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
616 if (BitOp && (BitOp->getOpcode() == BO_And ||
617 BitOp->getOpcode() == BO_Or)) {
618 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
619 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
620
621 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
622
623 if (!IntLiteral2)
624 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
625
626 if (!IntLiteral2)
627 return TryResult();
628
629 llvm::APInt L1 = IntLiteral->getValue();
630 llvm::APInt L2 = IntLiteral2->getValue();
631 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
632 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
633 if (BuildOpts.Observer)
634 BuildOpts.Observer->compareBitwiseEquality(B,
635 B->getOpcode() != BO_EQ);
636 TryResult(B->getOpcode() != BO_EQ);
637 }
638 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
639 llvm::APInt IntValue = IntLiteral->getValue();
640 if ((IntValue == 1) || (IntValue == 0)) {
641 return TryResult();
642 }
643 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000644 }
645
Jordan Rose7afd71e2014-05-20 17:31:11 +0000646 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000647 }
648
649 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
650 const llvm::APSInt &Value1,
651 const llvm::APSInt &Value2) {
652 assert(Value1.isSigned() == Value2.isSigned());
653 switch (Relation) {
654 default:
655 return TryResult();
656 case BO_EQ:
657 return TryResult(Value1 == Value2);
658 case BO_NE:
659 return TryResult(Value1 != Value2);
660 case BO_LT:
661 return TryResult(Value1 < Value2);
662 case BO_LE:
663 return TryResult(Value1 <= Value2);
664 case BO_GT:
665 return TryResult(Value1 > Value2);
666 case BO_GE:
667 return TryResult(Value1 >= Value2);
668 }
669 }
670
671 /// \brief Find a pair of comparison expressions with or without parentheses
672 /// with a shared variable and constants and a logical operator between them
673 /// that always evaluates to either true or false.
674 /// e.g. if (x != 3 || x != 4)
675 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
676 assert(B->isLogicalOp());
677 const BinaryOperator *LHS =
678 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
679 const BinaryOperator *RHS =
680 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
681 if (!LHS || !RHS)
682 return TryResult();
683
684 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
685 return TryResult();
686
687 BinaryOperatorKind BO1 = LHS->getOpcode();
688 const DeclRefExpr *Decl1 =
689 dyn_cast<DeclRefExpr>(LHS->getLHS()->IgnoreParenImpCasts());
690 const IntegerLiteral *Literal1 =
691 dyn_cast<IntegerLiteral>(LHS->getRHS()->IgnoreParens());
692 if (!Decl1 && !Literal1) {
693 if (BO1 == BO_GT)
694 BO1 = BO_LT;
695 else if (BO1 == BO_GE)
696 BO1 = BO_LE;
697 else if (BO1 == BO_LT)
698 BO1 = BO_GT;
699 else if (BO1 == BO_LE)
700 BO1 = BO_GE;
701 Decl1 = dyn_cast<DeclRefExpr>(LHS->getRHS()->IgnoreParenImpCasts());
702 Literal1 = dyn_cast<IntegerLiteral>(LHS->getLHS()->IgnoreParens());
703 }
704
705 if (!Decl1 || !Literal1)
706 return TryResult();
707
708 BinaryOperatorKind BO2 = RHS->getOpcode();
709 const DeclRefExpr *Decl2 =
710 dyn_cast<DeclRefExpr>(RHS->getLHS()->IgnoreParenImpCasts());
711 const IntegerLiteral *Literal2 =
712 dyn_cast<IntegerLiteral>(RHS->getRHS()->IgnoreParens());
713 if (!Decl2 && !Literal2) {
714 if (BO2 == BO_GT)
715 BO2 = BO_LT;
716 else if (BO2 == BO_GE)
717 BO2 = BO_LE;
718 else if (BO2 == BO_LT)
719 BO2 = BO_GT;
720 else if (BO2 == BO_LE)
721 BO2 = BO_GE;
722 Decl2 = dyn_cast<DeclRefExpr>(RHS->getRHS()->IgnoreParenImpCasts());
723 Literal2 = dyn_cast<IntegerLiteral>(RHS->getLHS()->IgnoreParens());
724 }
725
726 if (!Decl2 || !Literal2)
727 return TryResult();
728
729 // Check that it is the same variable on both sides.
730 if (Decl1->getDecl() != Decl2->getDecl())
731 return TryResult();
732
733 llvm::APSInt L1, L2;
734
735 if (!Literal1->EvaluateAsInt(L1, *Context) ||
736 !Literal2->EvaluateAsInt(L2, *Context))
737 return TryResult();
738
739 // Can't compare signed with unsigned or with different bit width.
740 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
741 return TryResult();
742
743 // Values that will be used to determine if result of logical
744 // operator is always true/false
745 const llvm::APSInt Values[] = {
746 // Value less than both Value1 and Value2
747 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
748 // L1
749 L1,
750 // Value between Value1 and Value2
751 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
752 L1.isUnsigned()),
753 // L2
754 L2,
755 // Value greater than both Value1 and Value2
756 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
757 };
758
759 // Check whether expression is always true/false by evaluating the following
760 // * variable x is less than the smallest literal.
761 // * variable x is equal to the smallest literal.
762 // * Variable x is between smallest and largest literal.
763 // * Variable x is equal to the largest literal.
764 // * Variable x is greater than largest literal.
765 bool AlwaysTrue = true, AlwaysFalse = true;
766 for (unsigned int ValueIndex = 0;
767 ValueIndex < sizeof(Values) / sizeof(Values[0]);
768 ++ValueIndex) {
769 llvm::APSInt Value = Values[ValueIndex];
770 TryResult Res1, Res2;
771 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
772 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
773
774 if (!Res1.isKnown() || !Res2.isKnown())
775 return TryResult();
776
777 if (B->getOpcode() == BO_LAnd) {
778 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
779 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
780 } else {
781 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
782 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
783 }
784 }
785
786 if (AlwaysTrue || AlwaysFalse) {
787 if (BuildOpts.Observer)
788 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
789 return TryResult(AlwaysTrue);
790 }
791 return TryResult();
792 }
793
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000794 /// Try and evaluate an expression to an integer constant.
795 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
796 if (!BuildOpts.PruneTriviallyFalseEdges)
797 return false;
798 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +0000799 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +0000800 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000801 }
Mike Stump11289f42009-09-09 15:08:12 +0000802
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000803 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +0000804 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000805 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +0000806 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000807 S->isTypeDependent() || S->isValueDependent())
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000808 return TryResult();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000809
810 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
811 if (Bop->isLogicalOp()) {
812 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000813 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
814 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000815 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +0000816
817 // Retrieve result at first, or the map might be updated.
818 TryResult Result = evaluateAsBooleanConditionNoCache(S);
819 CachedBoolEvals[S] = Result; // update or insert
820 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000821 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +0000822 else {
823 switch (Bop->getOpcode()) {
824 default: break;
825 // For 'x & 0' and 'x * 0', we can determine that
826 // the value is always false.
827 case BO_Mul:
828 case BO_And: {
829 // If either operand is zero, we know the value
830 // must be false.
831 llvm::APSInt IntVal;
832 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
833 if (IntVal.getBoolValue() == false) {
834 return TryResult(false);
835 }
836 }
837 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
838 if (IntVal.getBoolValue() == false) {
839 return TryResult(false);
840 }
841 }
842 }
843 break;
844 }
845 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000846 }
847
848 return evaluateAsBooleanConditionNoCache(S);
849 }
850
851 /// \brief Evaluate as boolean \param E without using the cache.
852 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
853 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
854 if (Bop->isLogicalOp()) {
855 TryResult LHS = tryEvaluateBool(Bop->getLHS());
856 if (LHS.isKnown()) {
857 // We were able to evaluate the LHS, see if we can get away with not
858 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
859 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
860 return LHS.isTrue();
861
862 TryResult RHS = tryEvaluateBool(Bop->getRHS());
863 if (RHS.isKnown()) {
864 if (Bop->getOpcode() == BO_LOr)
865 return LHS.isTrue() || RHS.isTrue();
866 else
867 return LHS.isTrue() && RHS.isTrue();
868 }
869 } else {
870 TryResult RHS = tryEvaluateBool(Bop->getRHS());
871 if (RHS.isKnown()) {
872 // We can't evaluate the LHS; however, sometimes the result
873 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
874 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
875 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +0000876 } else {
877 TryResult BopRes = checkIncorrectLogicOperator(Bop);
878 if (BopRes.isKnown())
879 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000880 }
881 }
882
883 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000884 } else if (Bop->isEqualityOp()) {
885 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
886 if (BopRes.isKnown())
887 return BopRes.isTrue();
888 } else if (Bop->isRelationalOp()) {
889 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
890 if (BopRes.isKnown())
891 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000892 }
893 }
894
895 bool Result;
896 if (E->EvaluateAsBooleanCondition(Result, *Context))
897 return Result;
898
899 return TryResult();
Mike Stump773582d2009-07-23 23:25:26 +0000900 }
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000901
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000902};
Mike Stump31feda52009-07-17 01:31:16 +0000903
Ted Kremeneka099c592011-03-10 03:50:34 +0000904inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
905 const Stmt *stmt) const {
906 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
907}
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000908
Ted Kremeneka099c592011-03-10 03:50:34 +0000909bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000910 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
911
Ted Kremeneka099c592011-03-10 03:50:34 +0000912 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +0000913 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000914
915 if (lastLookup == stmt) {
916 if (cachedEntry) {
917 assert(cachedEntry->first == stmt);
918 return true;
919 }
Ted Kremenek8b46c002011-07-19 14:18:43 +0000920 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000921 }
Ted Kremeneka099c592011-03-10 03:50:34 +0000922
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000923 lastLookup = stmt;
924
925 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +0000926 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
927
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000928 if (!fb) {
929 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +0000930 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +0000931 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000932 }
Ted Kremeneka099c592011-03-10 03:50:34 +0000933
934 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000935 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +0000936 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +0000937 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +0000938 }
939
Ted Kremeneka099c592011-03-10 03:50:34 +0000940 cachedEntry = &*itr;
941 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +0000942}
943
Douglas Gregor4619e432008-12-05 23:32:09 +0000944// FIXME: Add support for dependent-sized array types in C++?
945// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +0000946static const VariableArrayType *FindVA(const Type *t) {
947 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
948 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000949 if (vat->getSizeExpr())
950 return vat;
Mike Stump31feda52009-07-17 01:31:16 +0000951
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000952 t = vt->getElementType().getTypePtr();
953 }
Mike Stump31feda52009-07-17 01:31:16 +0000954
Craig Topper25542942014-05-20 04:30:07 +0000955 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000956}
Mike Stump31feda52009-07-17 01:31:16 +0000957
958/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
959/// arbitrary statement. Examples include a single expression or a function
960/// body (compound statement). The ownership of the returned CFG is
961/// transferred to the caller. If CFG construction fails, this method returns
962/// NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000963CFG* CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +0000964 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +0000965 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +0000966 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +0000967
Mike Stump31feda52009-07-17 01:31:16 +0000968 // Create an empty block that will serve as the exit block for the CFG. Since
969 // this is the first block added to the CFG, it will be implicitly registered
970 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +0000971 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000972 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +0000973 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +0000974
Marcin Swiderski20b88732010-10-05 05:37:00 +0000975 if (BuildOpts.AddImplicitDtors)
976 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
977 addImplicitDtorsForDestructor(DD);
978
Ted Kremenek9aae5132007-08-23 21:42:29 +0000979 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000980 CFGBlock *B = addStmt(Statement);
981
982 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +0000983 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000984
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000985 // For C++ constructor add initializers to CFG.
986 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
987 for (CXXConstructorDecl::init_const_reverse_iterator I = CD->init_rbegin(),
988 E = CD->init_rend(); I != E; ++I) {
989 B = addInitializer(*I);
990 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +0000991 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000992 }
993 }
994
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000995 if (B)
996 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +0000997
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000998 // Backpatch the gotos whose label -> block mappings we didn't know when we
999 // encountered them.
1000 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1001 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001002
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001003 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001004 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001005 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001006
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001007 // If there is no target for the goto, then we are looking at an
1008 // incomplete AST. Handle this by not registering a successor.
1009 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001010
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001011 JumpTarget JT = LI->second;
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001012 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1013 JT.scopePosition);
1014 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001015 }
1016
1017 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001018 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001019 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1020 E = AddressTakenLabels.end(); I != E; ++I ) {
1021
1022 // Lookup the target block.
1023 LabelMapTy::iterator LI = LabelMap.find(*I);
1024
1025 // If there is no target block that contains label, then we are looking
1026 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001027 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001028
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001029 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001030 }
Mike Stump31feda52009-07-17 01:31:16 +00001031
Mike Stump31feda52009-07-17 01:31:16 +00001032 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001033 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001034
Ahmed Charles9a16beb2014-03-07 19:33:25 +00001035 return cfg.release();
Ted Kremenek9aae5132007-08-23 21:42:29 +00001036}
Mike Stump31feda52009-07-17 01:31:16 +00001037
Ted Kremenek9aae5132007-08-23 21:42:29 +00001038/// createBlock - Used to lazily create blocks that are connected
1039/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001040CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1041 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001042 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001043 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001044 return B;
1045}
Mike Stump31feda52009-07-17 01:31:16 +00001046
Chandler Carrutha70991b2011-09-13 09:13:49 +00001047/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1048/// CFG. It is *not* connected to the current (global) successor, and instead
1049/// directly tied to the exit block in order to be reachable.
1050CFGBlock *CFGBuilder::createNoReturnBlock() {
1051 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001052 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001053 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001054 return B;
1055}
1056
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001057/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001058CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001059 if (!BuildOpts.AddInitializers)
1060 return Block;
1061
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001062 bool HasTemporaries = false;
1063
1064 // Destructors of temporaries in initialization expression should be called
1065 // after initialization finishes.
1066 Expr *Init = I->getInit();
1067 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001068 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001069
Jordan Rose6d671cc2012-09-05 22:55:23 +00001070 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001071 // Generate destructors for temporaries in initialization expression.
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00001072 TempDtorContext Context(/*IsConditional=*/false);
1073 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1074 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001075 }
1076 }
1077
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001078 autoCreateBlock();
1079 appendInitializer(Block, I);
1080
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001081 if (Init) {
Ted Kremenek8219b822010-12-16 07:46:53 +00001082 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001083 // For expression with temporaries go directly to subexpression to omit
1084 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001085 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1086 }
1087 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001088 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001089
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001090 return Block;
1091}
1092
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001093/// \brief Retrieve the type of the temporary object whose lifetime was
1094/// extended by a local reference with the given initializer.
1095static QualType getReferenceInitTemporaryType(ASTContext &Context,
1096 const Expr *Init) {
1097 while (true) {
1098 // Skip parentheses.
1099 Init = Init->IgnoreParens();
1100
1101 // Skip through cleanups.
1102 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1103 Init = EWC->getSubExpr();
1104 continue;
1105 }
1106
1107 // Skip through the temporary-materialization expression.
1108 if (const MaterializeTemporaryExpr *MTE
1109 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1110 Init = MTE->GetTemporaryExpr();
1111 continue;
1112 }
1113
1114 // Skip derived-to-base and no-op casts.
1115 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) {
1116 if ((CE->getCastKind() == CK_DerivedToBase ||
1117 CE->getCastKind() == CK_UncheckedDerivedToBase ||
1118 CE->getCastKind() == CK_NoOp) &&
1119 Init->getType()->isRecordType()) {
1120 Init = CE->getSubExpr();
1121 continue;
1122 }
1123 }
1124
1125 // Skip member accesses into rvalues.
1126 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) {
1127 if (!ME->isArrow() && ME->getBase()->isRValue()) {
1128 Init = ME->getBase();
1129 continue;
1130 }
1131 }
1132
1133 break;
1134 }
1135
1136 return Init->getType();
1137}
1138
Marcin Swiderski5e415732010-09-30 23:05:00 +00001139/// addAutomaticObjDtors - Add to current block automatic objects destructors
1140/// for objects in range of local scope positions. Use S as trigger statement
1141/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001142void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001143 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001144 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001145 return;
1146
Marcin Swiderski5e415732010-09-30 23:05:00 +00001147 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001148 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001149
Chandler Carruthad747252011-09-13 06:09:01 +00001150 // We need to append the destructors in reverse order, but any one of them
1151 // may be a no-return destructor which changes the CFG. As a result, buffer
1152 // this sequence up and replay them in reverse order when appending onto the
1153 // CFGBlock(s).
1154 SmallVector<VarDecl*, 10> Decls;
1155 Decls.reserve(B.distance(E));
1156 for (LocalScope::const_iterator I = B; I != E; ++I)
1157 Decls.push_back(*I);
1158
1159 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1160 E = Decls.rend();
1161 I != E; ++I) {
1162 // If this destructor is marked as a no-return destructor, we need to
1163 // create a new block for the destructor which does not have as a successor
1164 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001165 QualType Ty = (*I)->getType();
1166 if (Ty->isReferenceType()) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001167 Ty = getReferenceInitTemporaryType(*Context, (*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001168 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001169 Ty = Context->getBaseElementType(Ty);
1170
Chandler Carruthad747252011-09-13 06:09:01 +00001171 const CXXDestructorDecl *Dtor = Ty->getAsCXXRecordDecl()->getDestructor();
Richard Smith10876ef2013-01-17 01:30:42 +00001172 if (Dtor->isNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001173 Block = createNoReturnBlock();
1174 else
Chandler Carruthad747252011-09-13 06:09:01 +00001175 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001176
1177 appendAutomaticObjDtor(Block, *I, S);
1178 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001179}
1180
Marcin Swiderski20b88732010-10-05 05:37:00 +00001181/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1182/// base and member objects in destructor.
1183void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
1184 assert (BuildOpts.AddImplicitDtors
1185 && "Can be called only when dtors should be added");
1186 const CXXRecordDecl *RD = DD->getParent();
1187
1188 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001189 for (const auto &VI : RD->vbases()) {
1190 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001191 if (!CD->hasTrivialDestructor()) {
1192 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001193 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001194 }
1195 }
1196
1197 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001198 for (const auto &BI : RD->bases()) {
1199 if (!BI.isVirtual()) {
1200 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001201 if (!CD->hasTrivialDestructor()) {
1202 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001203 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001204 }
1205 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001206 }
1207
1208 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001209 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001210 // Check for constant size array. Set type to array element type.
1211 QualType QT = FI->getType();
1212 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1213 if (AT->getSize() == 0)
1214 continue;
1215 QT = AT->getElementType();
1216 }
1217
1218 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001219 if (!CD->hasTrivialDestructor()) {
1220 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001221 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001222 }
1223 }
1224}
1225
Marcin Swiderski5e415732010-09-30 23:05:00 +00001226/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1227/// way return valid LocalScope object.
1228LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
1229 if (!Scope) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +00001230 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1231 Scope = alloc.Allocate<LocalScope>();
1232 BumpVectorContext ctx(alloc);
1233 new (Scope) LocalScope(ctx, ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001234 }
1235 return Scope;
1236}
1237
1238/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +00001239/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001240void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001241 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001242 return;
1243
Craig Topper25542942014-05-20 04:30:07 +00001244 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001245
1246 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001247 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001248 for (auto *BI : CS->body()) {
1249 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001250 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001251 Scope = addLocalScopeForDeclStmt(DS, Scope);
1252 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001253 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001254 }
1255
1256 // For any other statement scope will be implicit and as such will be
1257 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001258 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001259 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001260}
1261
1262/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1263/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001264LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001265 LocalScope* Scope) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001266 if (!BuildOpts.AddImplicitDtors)
1267 return Scope;
1268
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001269 for (auto *DI : DS->decls())
1270 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001271 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001272 return Scope;
1273}
1274
1275/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1276/// create add scope for automatic objects and temporary objects bound to
1277/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001278LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001279 LocalScope* Scope) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001280 if (!BuildOpts.AddImplicitDtors)
1281 return Scope;
1282
1283 // Check if variable is local.
1284 switch (VD->getStorageClass()) {
1285 case SC_None:
1286 case SC_Auto:
1287 case SC_Register:
1288 break;
1289 default: return Scope;
1290 }
1291
1292 // Check for const references bound to temporary. Set type to pointee.
1293 QualType QT = VD->getType();
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001294 if (QT.getTypePtr()->isReferenceType()) {
Richard Smith5a0ef782013-06-27 21:43:17 +00001295 // Attempt to determine whether this declaration lifetime-extends a
1296 // temporary.
1297 //
1298 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1299 // temporaries, and a single declaration can extend multiple temporaries.
1300 // We should look at the storage duration on each nested
1301 // MaterializeTemporaryExpr instead.
1302 const Expr *Init = VD->getInit();
1303 if (!Init)
1304 return Scope;
1305 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init))
1306 Init = EWC->getSubExpr();
1307 if (!isa<MaterializeTemporaryExpr>(Init))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001308 return Scope;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001309
Richard Smith5a0ef782013-06-27 21:43:17 +00001310 // Lifetime-extending a temporary.
1311 QT = getReferenceInitTemporaryType(*Context, Init);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001312 }
1313
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001314 // Check for constant size array. Set type to array element type.
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001315 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001316 if (AT->getSize() == 0)
1317 return Scope;
1318 QT = AT->getElementType();
1319 }
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001320
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00001321 // Check if type is a C++ class with non-trivial destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001322 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
David Blaikie0f2ae782012-01-24 04:51:48 +00001323 if (!CD->hasTrivialDestructor()) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001324 // Add the variable to scope
1325 Scope = createOrReuseLocalScope(Scope);
1326 Scope->addVar(VD);
1327 ScopePos = Scope->begin();
1328 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001329 return Scope;
1330}
1331
1332/// addLocalScopeAndDtors - For given statement add local scope for it and
1333/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001334void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001335 if (!BuildOpts.AddImplicitDtors)
1336 return;
1337
1338 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001339 addLocalScopeForStmt(S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001340 addAutomaticObjDtors(ScopePos, scopeBeginPos, S);
1341}
1342
Marcin Swiderski321a7072010-09-30 22:54:37 +00001343/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1344/// variables with automatic storage duration to CFGBlock's elements vector.
1345/// Elements will be prepended to physical beginning of the vector which
1346/// happens to be logical end. Use blocks terminator as statement that specifies
1347/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001348/// FIXME: This mechanism for adding automatic destructors doesn't handle
1349/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001350void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001351 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Chandler Carruthad747252011-09-13 06:09:01 +00001352 BumpVectorContext &C = cfg->getBumpVectorContext();
1353 CFGBlock::iterator InsertPos
1354 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1355 for (LocalScope::const_iterator I = B; I != E; ++I)
1356 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1357 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001358}
1359
Ted Kremenek93668002009-07-17 22:18:43 +00001360/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001361/// blocks for ternary operators, &&, and ||. We also process "," and
1362/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001363CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001364 if (!S) {
1365 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001366 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001367 }
Jordy Rose17347372011-06-10 08:49:37 +00001368
1369 if (Expr *E = dyn_cast<Expr>(S))
1370 S = E->IgnoreParens();
1371
Ted Kremenek93668002009-07-17 22:18:43 +00001372 switch (S->getStmtClass()) {
1373 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001374 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001375
1376 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001377 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001378
John McCallc07a0c72011-02-17 10:25:35 +00001379 case Stmt::BinaryConditionalOperatorClass:
1380 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1381
Ted Kremenek93668002009-07-17 22:18:43 +00001382 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001383 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001384
Ted Kremenek93668002009-07-17 22:18:43 +00001385 case Stmt::BlockExprClass:
Ted Kremeneke2499842012-04-12 20:03:44 +00001386 return VisitNoRecurse(cast<Expr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001387
Ted Kremenek93668002009-07-17 22:18:43 +00001388 case Stmt::BreakStmtClass:
1389 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001390
Ted Kremenek93668002009-07-17 22:18:43 +00001391 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001392 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001393 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001394 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001395 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001396
Ted Kremenek93668002009-07-17 22:18:43 +00001397 case Stmt::CaseStmtClass:
1398 return VisitCaseStmt(cast<CaseStmt>(S));
1399
1400 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001401 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001402
Ted Kremenek93668002009-07-17 22:18:43 +00001403 case Stmt::CompoundStmtClass:
1404 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001405
Ted Kremenek93668002009-07-17 22:18:43 +00001406 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001407 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001408
Ted Kremenek93668002009-07-17 22:18:43 +00001409 case Stmt::ContinueStmtClass:
1410 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001411
Ted Kremenekb27378c2010-01-19 20:40:33 +00001412 case Stmt::CXXCatchStmtClass:
1413 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1414
John McCall5d413782010-12-06 08:20:24 +00001415 case Stmt::ExprWithCleanupsClass:
1416 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001417
Jordan Rosee5d53932012-08-23 18:10:53 +00001418 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001419 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001420 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1421 // called function's declaration, not by the caller. If we simply add
1422 // this expression to the CFG, we could end up with the same Expr
1423 // appearing multiple times.
1424 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001425 //
1426 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1427 // expression to be used in the same function (through aggregate
1428 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00001429 return VisitStmt(S, asc);
1430
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001431 case Stmt::CXXBindTemporaryExprClass:
1432 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
1433
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001434 case Stmt::CXXConstructExprClass:
1435 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
1436
Jordan Rosec9176072014-01-13 17:59:19 +00001437 case Stmt::CXXNewExprClass:
1438 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
1439
Jordan Rosed2f40792013-09-03 17:00:57 +00001440 case Stmt::CXXDeleteExprClass:
1441 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
1442
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001443 case Stmt::CXXFunctionalCastExprClass:
1444 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
1445
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001446 case Stmt::CXXTemporaryObjectExprClass:
1447 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
1448
Ted Kremenekb27378c2010-01-19 20:40:33 +00001449 case Stmt::CXXThrowExprClass:
1450 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001451
Ted Kremenekb27378c2010-01-19 20:40:33 +00001452 case Stmt::CXXTryStmtClass:
1453 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001454
Richard Smith02e85f32011-04-14 22:09:26 +00001455 case Stmt::CXXForRangeStmtClass:
1456 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
1457
Ted Kremenek93668002009-07-17 22:18:43 +00001458 case Stmt::DeclStmtClass:
1459 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001460
Ted Kremenek93668002009-07-17 22:18:43 +00001461 case Stmt::DefaultStmtClass:
1462 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001463
Ted Kremenek93668002009-07-17 22:18:43 +00001464 case Stmt::DoStmtClass:
1465 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001466
Ted Kremenek93668002009-07-17 22:18:43 +00001467 case Stmt::ForStmtClass:
1468 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001469
Ted Kremenek93668002009-07-17 22:18:43 +00001470 case Stmt::GotoStmtClass:
1471 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001472
Ted Kremenek93668002009-07-17 22:18:43 +00001473 case Stmt::IfStmtClass:
1474 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001475
Ted Kremenek8219b822010-12-16 07:46:53 +00001476 case Stmt::ImplicitCastExprClass:
1477 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001478
Ted Kremenek93668002009-07-17 22:18:43 +00001479 case Stmt::IndirectGotoStmtClass:
1480 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001481
Ted Kremenek93668002009-07-17 22:18:43 +00001482 case Stmt::LabelStmtClass:
1483 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001484
Ted Kremenekda76a942012-04-12 20:34:52 +00001485 case Stmt::LambdaExprClass:
1486 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
1487
Ted Kremenek5868ec62010-04-11 17:02:10 +00001488 case Stmt::MemberExprClass:
1489 return VisitMemberExpr(cast<MemberExpr>(S), asc);
1490
Ted Kremenek04268232011-11-05 00:10:15 +00001491 case Stmt::NullStmtClass:
1492 return Block;
1493
Ted Kremenek93668002009-07-17 22:18:43 +00001494 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00001495 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
1496
Ted Kremenek5022f1d2012-03-06 23:40:47 +00001497 case Stmt::ObjCAutoreleasePoolStmtClass:
1498 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
1499
Ted Kremenek93668002009-07-17 22:18:43 +00001500 case Stmt::ObjCAtSynchronizedStmtClass:
1501 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001502
Ted Kremenek93668002009-07-17 22:18:43 +00001503 case Stmt::ObjCAtThrowStmtClass:
1504 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001505
Ted Kremenek93668002009-07-17 22:18:43 +00001506 case Stmt::ObjCAtTryStmtClass:
1507 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001508
Ted Kremenek93668002009-07-17 22:18:43 +00001509 case Stmt::ObjCForCollectionStmtClass:
1510 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001511
Ted Kremenek04268232011-11-05 00:10:15 +00001512 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00001513 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00001514
John McCallfe96e0b2011-11-06 09:01:30 +00001515 case Stmt::PseudoObjectExprClass:
1516 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
1517
Ted Kremenek93668002009-07-17 22:18:43 +00001518 case Stmt::ReturnStmtClass:
1519 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001520
Peter Collingbournee190dee2011-03-11 19:24:49 +00001521 case Stmt::UnaryExprOrTypeTraitExprClass:
1522 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
1523 asc);
Mike Stump11289f42009-09-09 15:08:12 +00001524
Ted Kremenek93668002009-07-17 22:18:43 +00001525 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001526 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001527
Ted Kremenek93668002009-07-17 22:18:43 +00001528 case Stmt::SwitchStmtClass:
1529 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001530
Zhanyong Wan6dace612010-11-22 08:45:56 +00001531 case Stmt::UnaryOperatorClass:
1532 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
1533
Ted Kremenek93668002009-07-17 22:18:43 +00001534 case Stmt::WhileStmtClass:
1535 return VisitWhileStmt(cast<WhileStmt>(S));
1536 }
1537}
Mike Stump11289f42009-09-09 15:08:12 +00001538
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001539CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001540 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001541 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001542 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00001543 }
Mike Stump11289f42009-09-09 15:08:12 +00001544
Ted Kremenek93668002009-07-17 22:18:43 +00001545 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00001546}
Mike Stump31feda52009-07-17 01:31:16 +00001547
Ted Kremenek93668002009-07-17 22:18:43 +00001548/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00001549CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
1550 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00001551
Ted Kremenek8ae67872013-02-05 22:00:19 +00001552 // Visit the children in their reverse order so that they appear in
1553 // left-to-right (natural) order in the CFG.
1554 reverse_children RChildren(S);
1555 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
1556 I != E; ++I) {
1557 if (Stmt *Child = *I)
1558 if (CFGBlock *R = Visit(Child))
1559 B = R;
1560 }
1561 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00001562}
Mike Stump11289f42009-09-09 15:08:12 +00001563
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001564CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
1565 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00001566 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00001567
Ted Kremenek7c58d352011-03-10 01:14:11 +00001568 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001569 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001570 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00001571 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001572
Ted Kremenek9aae5132007-08-23 21:42:29 +00001573 return Block;
1574}
Mike Stump11289f42009-09-09 15:08:12 +00001575
Zhanyong Wan6dace612010-11-22 08:45:56 +00001576CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00001577 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001578 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00001579 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001580 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00001581 }
1582
Ted Kremenek8219b822010-12-16 07:46:53 +00001583 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00001584}
1585
Ted Kremeneka16436f2012-07-14 05:04:06 +00001586CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
1587 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
1588 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00001589
Ted Kremeneka16436f2012-07-14 05:04:06 +00001590 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001591 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00001592
Craig Topper25542942014-05-20 04:30:07 +00001593 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
1594 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00001595}
1596
1597std::pair<CFGBlock*, CFGBlock*>
1598CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
1599 Stmt *Term,
1600 CFGBlock *TrueBlock,
1601 CFGBlock *FalseBlock) {
1602
1603 // Introspect the RHS. If it is a nested logical operation, we recursively
1604 // build the CFG using this function. Otherwise, resort to default
1605 // CFG construction behavior.
1606 Expr *RHS = B->getRHS()->IgnoreParens();
1607 CFGBlock *RHSBlock, *ExitBlock;
1608
1609 do {
1610 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
1611 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001612 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00001613 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
1614 break;
1615 }
1616
1617 // The RHS is not a nested logical operation. Don't push the terminator
1618 // down further, but instead visit RHS and construct the respective
1619 // pieces of the CFG, and link up the RHSBlock with the terminator
1620 // we have been provided.
1621 ExitBlock = RHSBlock = createBlock(false);
1622
1623 if (!Term) {
1624 assert(TrueBlock == FalseBlock);
1625 addSuccessor(RHSBlock, TrueBlock);
1626 }
1627 else {
1628 RHSBlock->setTerminator(Term);
1629 TryResult KnownVal = tryEvaluateBool(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001630 if (!KnownVal.isKnown())
1631 KnownVal = tryEvaluateBool(B);
Ted Kremenek782f0032014-03-07 02:25:53 +00001632 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
1633 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00001634 }
1635
1636 Block = RHSBlock;
1637 RHSBlock = addStmt(RHS);
1638 }
1639 while (false);
1640
1641 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001642 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00001643
1644 // Generate the blocks for evaluating the LHS.
1645 Expr *LHS = B->getLHS()->IgnoreParens();
1646
1647 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
1648 if (B_LHS->isLogicalOp()) {
1649 if (B->getOpcode() == BO_LOr)
1650 FalseBlock = RHSBlock;
1651 else
1652 TrueBlock = RHSBlock;
1653
1654 // For the LHS, treat 'B' as the terminator that we want to sink
1655 // into the nested branch. The RHS always gets the top-most
1656 // terminator.
1657 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
1658 }
1659
1660 // Create the block evaluating the LHS.
1661 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00001662 CFGBlock *LHSBlock = createBlock(false);
1663 LHSBlock->setTerminator(B);
1664
Ted Kremeneka16436f2012-07-14 05:04:06 +00001665 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00001666 CFGBlock *EntryLHSBlock = addStmt(LHS);
1667
1668 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001669 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001670
1671 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00001672 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001673
1674 // Now link the LHSBlock with RHSBlock.
1675 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00001676 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
1677 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00001678 } else {
1679 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00001680 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
1681 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00001682 }
1683
Ted Kremenekb50e7162012-07-14 05:04:10 +00001684 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00001685}
1686
Ted Kremenekb50e7162012-07-14 05:04:10 +00001687
Ted Kremeneka16436f2012-07-14 05:04:06 +00001688CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
1689 AddStmtChoice asc) {
1690 // && or ||
1691 if (B->isLogicalOp())
1692 return VisitLogicalOperator(B);
1693
Zhanyong Wan59f09c72010-11-22 19:32:14 +00001694 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00001695 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001696 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00001697 addStmt(B->getRHS());
1698 return addStmt(B->getLHS());
1699 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00001700
1701 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001702 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001703 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001704 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001705 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001706 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00001707 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00001708 }
Mike Stump11289f42009-09-09 15:08:12 +00001709
Ted Kremenek7c58d352011-03-10 01:14:11 +00001710 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00001711 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001712 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00001713 }
1714
Zhongxing Xud95ccd52010-10-27 03:23:10 +00001715 CFGBlock *RBlock = Visit(B->getRHS());
1716 CFGBlock *LBlock = Visit(B->getLHS());
1717 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
1718 // containing a DoStmt, and the LHS doesn't create a new block, then we should
1719 // return RBlock. Otherwise we'll incorrectly return NULL.
1720 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00001721}
1722
Ted Kremeneke2499842012-04-12 20:03:44 +00001723CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001724 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00001725 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001726 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00001727 }
1728 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001729}
1730
Ted Kremenek93668002009-07-17 22:18:43 +00001731CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
1732 // "break" is a control-flow statement. Thus we stop processing the current
1733 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001734 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001735 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001736
Ted Kremenek93668002009-07-17 22:18:43 +00001737 // Now create a new block that ends with the break statement.
1738 Block = createBlock(false);
1739 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00001740
Ted Kremenek93668002009-07-17 22:18:43 +00001741 // If there is no target for the break, then we are looking at an incomplete
1742 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001743 if (BreakJumpTarget.block) {
1744 addAutomaticObjDtors(ScopePos, BreakJumpTarget.scopePosition, B);
1745 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001746 } else
Ted Kremenek93668002009-07-17 22:18:43 +00001747 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00001748
1749
Ted Kremenek9aae5132007-08-23 21:42:29 +00001750 return Block;
1751}
Mike Stump11289f42009-09-09 15:08:12 +00001752
Sebastian Redl31ad7542011-03-13 17:09:40 +00001753static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00001754 QualType Ty = E->getType();
1755 if (Ty->isFunctionPointerType())
1756 Ty = Ty->getAs<PointerType>()->getPointeeType();
1757 else if (Ty->isBlockPointerType())
1758 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001759
Mike Stump04c68512010-01-21 15:20:48 +00001760 const FunctionType *FT = Ty->getAs<FunctionType>();
1761 if (FT) {
1762 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00001763 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smithf623c962012-04-17 00:58:00 +00001764 Proto->isNothrow(Ctx))
Mike Stump04c68512010-01-21 15:20:48 +00001765 return false;
1766 }
1767 return true;
1768}
1769
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001770CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00001771 // Compute the callee type.
1772 QualType calleeType = C->getCallee()->getType();
1773 if (calleeType == Context->BoundMemberTy) {
1774 QualType boundType = Expr::findBoundMemberType(C->getCallee());
1775
1776 // We should only get a null bound type if processing a dependent
1777 // CFG. Recover by assuming nothing.
1778 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00001779 }
Mike Stump8c5d7992009-07-25 21:26:53 +00001780
John McCallc67067f2011-05-11 07:19:11 +00001781 // If this is a call to a no-return function, this stops the block here.
1782 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
1783
Mike Stump04c68512010-01-21 15:20:48 +00001784 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00001785
1786 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001787 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00001788 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00001789 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00001790 }
1791
Jordan Rose5374c072013-08-19 16:27:28 +00001792 // If this is a call to a builtin function, it might not actually evaluate
1793 // its arguments. Don't add them to the CFG if this is the case.
1794 bool OmitArguments = false;
1795
Mike Stump92244b02010-01-19 22:00:14 +00001796 if (FunctionDecl *FD = C->getDirectCallee()) {
Richard Smith10876ef2013-01-17 01:30:42 +00001797 if (FD->isNoReturn())
Mike Stump8c5d7992009-07-25 21:26:53 +00001798 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00001799 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00001800 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00001801 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
1802 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00001803 }
Mike Stump8c5d7992009-07-25 21:26:53 +00001804
Sebastian Redl31ad7542011-03-13 17:09:40 +00001805 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00001806 AddEHEdge = false;
1807
Jordan Rose5374c072013-08-19 16:27:28 +00001808 if (OmitArguments) {
1809 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
1810 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
1811 autoCreateBlock();
1812 appendStmt(Block, C);
1813 return Visit(C->getCallee());
1814 }
1815
1816 if (!NoReturn && !AddEHEdge) {
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001817 return VisitStmt(C, asc.withAlwaysAdd(true));
Jordan Rose5374c072013-08-19 16:27:28 +00001818 }
Mike Stump11289f42009-09-09 15:08:12 +00001819
Mike Stump92244b02010-01-19 22:00:14 +00001820 if (Block) {
1821 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001822 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001823 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00001824 }
Mike Stump11289f42009-09-09 15:08:12 +00001825
Chandler Carrutha70991b2011-09-13 09:13:49 +00001826 if (NoReturn)
1827 Block = createNoReturnBlock();
1828 else
1829 Block = createBlock();
1830
Ted Kremenek2866bab2011-03-10 01:14:08 +00001831 appendStmt(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00001832
Mike Stump04c68512010-01-21 15:20:48 +00001833 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00001834 // Add exceptional edges.
1835 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001836 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00001837 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001838 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00001839 }
Mike Stump11289f42009-09-09 15:08:12 +00001840
Mike Stump8c5d7992009-07-25 21:26:53 +00001841 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00001842}
Ted Kremenek9aae5132007-08-23 21:42:29 +00001843
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001844CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
1845 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001846 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001847 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001848 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001849 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001850
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001851 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00001852 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001853 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001854 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001855 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001856 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001857
Ted Kremenek21822592009-07-17 18:20:32 +00001858 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001859 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001860 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001861 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001862 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001863
Ted Kremenek21822592009-07-17 18:20:32 +00001864 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00001865 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001866 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00001867 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
1868 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00001869 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00001870 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00001871}
Mike Stump11289f42009-09-09 15:08:12 +00001872
1873
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001874CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Marcin Swiderski667ffec2010-10-01 00:23:17 +00001875 addLocalScopeAndDtors(C);
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001876 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001877
1878 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
1879 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00001880 // If we hit a segment of code just containing ';' (NullStmts), we can
1881 // get a null block back. In such cases, just use the LastBlock
1882 if (CFGBlock *newBlock = addStmt(*I))
1883 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00001884
Ted Kremenekce499c22009-08-27 23:16:26 +00001885 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001886 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001887 }
Mike Stump92244b02010-01-19 22:00:14 +00001888
Ted Kremenek93668002009-07-17 22:18:43 +00001889 return LastBlock;
1890}
Mike Stump11289f42009-09-09 15:08:12 +00001891
John McCallc07a0c72011-02-17 10:25:35 +00001892CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001893 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00001894 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00001895 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00001896
Ted Kremenek51d40b02009-07-17 18:15:54 +00001897 // Create the confluence block that will "merge" the results of the ternary
1898 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001899 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001900 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001901 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001902 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001903
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00001904 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00001905
Ted Kremenek51d40b02009-07-17 18:15:54 +00001906 // Create a block for the LHS expression if there is an LHS expression. A
1907 // GCC extension allows LHS to be NULL, causing the condition to be the
1908 // value that is returned instead.
1909 // e.g: x ?: y is shorthand for: x ? x : y;
1910 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00001911 Block = nullptr;
1912 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00001913 const Expr *trueExpr = C->getTrueExpr();
1914 if (trueExpr != opaqueValue) {
1915 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001916 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001917 return nullptr;
1918 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00001919 }
Ted Kremenekd8138012011-02-24 03:09:15 +00001920 else
1921 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00001922
Ted Kremenek51d40b02009-07-17 18:15:54 +00001923 // Create the block for the RHS expression.
1924 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001925 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001926 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001927 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001928
Richard Smithf676e452012-07-24 21:02:14 +00001929 // If the condition is a logical '&&' or '||', build a more accurate CFG.
1930 if (BinaryOperator *Cond =
1931 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
1932 if (Cond->isLogicalOp())
1933 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
1934
Ted Kremenek51d40b02009-07-17 18:15:54 +00001935 // Create the block that will contain the condition.
1936 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00001937
Mike Stump773582d2009-07-23 23:25:26 +00001938 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001939 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00001940 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
1941 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00001942 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00001943 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00001944
Ted Kremenekd8138012011-02-24 03:09:15 +00001945 if (opaqueValue) {
1946 // Run the condition expression if it's not trivially expressed in
1947 // terms of the opaque value (or if there is no opaque value).
1948 if (condExpr != opaqueValue)
1949 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00001950
Ted Kremenekd8138012011-02-24 03:09:15 +00001951 // Before that, run the common subexpression if there was one.
1952 // At least one of this or the above will be run.
1953 return addStmt(BCO->getCommon());
1954 }
1955
1956 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00001957}
1958
Ted Kremenek93668002009-07-17 22:18:43 +00001959CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00001960 // Check if the Decl is for an __label__. If so, elide it from the
1961 // CFG entirely.
1962 if (isa<LabelDecl>(*DS->decl_begin()))
1963 return Block;
1964
Ted Kremenek3a601142011-05-24 20:41:31 +00001965 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001966 if (DS->isSingleDecl())
1967 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00001968
Craig Topper25542942014-05-20 04:30:07 +00001969 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00001970
Jordan Rose8c6c8a92012-07-20 18:50:48 +00001971 // Build an individual DeclStmt for each decl.
1972 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
1973 E = DS->decl_rend();
1974 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00001975 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
1976 unsigned A = llvm::AlignOf<DeclStmt>::Alignment < 8
1977 ? 8 : llvm::AlignOf<DeclStmt>::Alignment;
Mike Stump11289f42009-09-09 15:08:12 +00001978
Ted Kremenek93668002009-07-17 22:18:43 +00001979 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
1980 // automatically freed with the CFG.
1981 DeclGroupRef DG(*I);
1982 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00001983 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00001984 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00001985 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00001986
Ted Kremenek93668002009-07-17 22:18:43 +00001987 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001988 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00001989 }
Mike Stump11289f42009-09-09 15:08:12 +00001990
1991 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00001992}
Mike Stump11289f42009-09-09 15:08:12 +00001993
Ted Kremenek93668002009-07-17 22:18:43 +00001994/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001995/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001996CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001997 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001998 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00001999
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002000 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002001 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2002 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002003 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002004 }
Mike Stump11289f42009-09-09 15:08:12 +00002005
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002006 bool HasTemporaries = false;
2007
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002008 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002009 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002010
2011 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2012 // For static variables, we need to create a branch to track
2013 // whether or not they are initialized.
2014 if (Block) {
2015 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002016 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002017 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002018 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002019 }
2020 blockAfterStaticInit = Succ;
2021 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002022
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002023 // Destructors of temporaries in initialization expression should be called
2024 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002025 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002026 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002027 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002028
Jordan Rose6d671cc2012-09-05 22:55:23 +00002029 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002030 // Generate destructors for temporaries in initialization expression.
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00002031 TempDtorContext Context(/*IsConditional=*/false);
2032 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2033 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002034 }
2035 }
2036
2037 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002038 appendStmt(Block, DS);
Ted Kremenek213d0532012-03-22 05:57:43 +00002039
2040 // Keep track of the last non-null block, as 'Block' can be nulled out
2041 // if the initializer expression is something like a 'while' in a
2042 // statement-expression.
2043 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002044
Ted Kremenek93668002009-07-17 22:18:43 +00002045 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002046 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002047 // For expression with temporaries go directly to subexpression to omit
2048 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002049 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2050 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2051 LastBlock = newBlock;
2052 }
2053 else {
2054 if (CFGBlock *newBlock = Visit(Init))
2055 LastBlock = newBlock;
2056 }
Ted Kremenek93668002009-07-17 22:18:43 +00002057 }
Mike Stump11289f42009-09-09 15:08:12 +00002058
Ted Kremenek93668002009-07-17 22:18:43 +00002059 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002060 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002061 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002062 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2063 LastBlock = newBlock;
2064 }
Mike Stump11289f42009-09-09 15:08:12 +00002065
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002066 // Remove variable from local scope.
2067 if (ScopePos && VD == *ScopePos)
2068 ++ScopePos;
2069
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002070 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002071 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002072 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002073 Block = createBlock(false);
2074 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002075 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002076 addSuccessor(Block, B);
2077 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002078 }
2079
2080 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002081}
2082
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002083CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002084 // We may see an if statement in the middle of a basic block, or it may be the
2085 // first statement we are processing. In either case, we create a new basic
2086 // block. First, we create the blocks for the then...else statements, and
2087 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002088 // middle of a block, we stop processing that block. That block is then the
2089 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002090
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002091 // Save local scope position because in case of condition variable ScopePos
2092 // won't be restored when traversing AST.
2093 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2094
2095 // Create local scope for possible condition variable.
2096 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002097 if (VarDecl *VD = I->getConditionVariable()) {
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002098 LocalScope::const_iterator BeginScopePos = ScopePos;
2099 addLocalScopeForVarDecl(VD);
2100 addAutomaticObjDtors(ScopePos, BeginScopePos, I);
2101 }
2102
Chris Lattner57540c52011-04-15 05:22:18 +00002103 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002104 // block.
2105 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002106 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002107 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002108 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002109 }
Mike Stump31feda52009-07-17 01:31:16 +00002110
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002111 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002112 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002113
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002114 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002115 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002116
Ted Kremenek9aae5132007-08-23 21:42:29 +00002117 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002118 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002119 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002120
2121 // If branch is not a compound statement create implicit scope
2122 // and add destructors.
2123 if (!isa<CompoundStmt>(Else))
2124 addLocalScopeAndDtors(Else);
2125
Ted Kremenek93668002009-07-17 22:18:43 +00002126 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002127
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002128 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2129 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002130 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002131 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002132 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002133 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002134 }
Mike Stump31feda52009-07-17 01:31:16 +00002135
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002136 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002137 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002138 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002139 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002140 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002141 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002142 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002143
2144 // If branch is not a compound statement create implicit scope
2145 // and add destructors.
2146 if (!isa<CompoundStmt>(Then))
2147 addLocalScopeAndDtors(Then);
2148
Ted Kremenek93668002009-07-17 22:18:43 +00002149 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002150
Ted Kremenek1b379512009-04-01 03:52:47 +00002151 if (!ThenBlock) {
2152 // We can reach here if the "then" body has all NullStmts.
2153 // Create an empty block so we can distinguish between true and false
2154 // branches in path-sensitive analyses.
2155 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002156 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002157 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002158 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002159 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002160 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002161 }
2162
Ted Kremenekb50e7162012-07-14 05:04:10 +00002163 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2164 // having these handle the actual control-flow jump. Note that
2165 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2166 // we resort to the old control-flow behavior. This special handling
2167 // removes infeasible paths from the control-flow graph by having the
2168 // control-flow transfer of '&&' or '||' go directly into the then/else
2169 // blocks directly.
2170 if (!I->getConditionVariable())
Richard Smithf676e452012-07-24 21:02:14 +00002171 if (BinaryOperator *Cond =
2172 dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002173 if (Cond->isLogicalOp())
2174 return VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2175
Mike Stump31feda52009-07-17 01:31:16 +00002176 // Now create a new block containing the if statement.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002177 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002178
Ted Kremenek9aae5132007-08-23 21:42:29 +00002179 // Set the terminator of the new block to the If statement.
2180 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002181
Mike Stump773582d2009-07-23 23:25:26 +00002182 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002183 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00002184
Ted Kremenekf3898612014-02-27 00:24:03 +00002185 // Add the successors. If we know that specific branches are
2186 // unreachable, inform addSuccessor() of that knowledge.
2187 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2188 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump31feda52009-07-17 01:31:16 +00002189
2190 // Add the condition as the last statement in the new block. This may create
2191 // new blocks as the condition may contain control-flow. Any newly created
2192 // blocks will be pointed to be "Block".
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002193 CFGBlock *LastBlock = addStmt(I->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002194
Manuel Klimek75f34c12014-05-05 18:21:06 +00002195 // Finally, if the IfStmt contains a condition variable, add it and its
2196 // initializer to the CFG.
2197 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2198 autoCreateBlock();
2199 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002200 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002201
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002202 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002203}
Mike Stump31feda52009-07-17 01:31:16 +00002204
2205
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002206CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002207 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002208 //
Mike Stump31feda52009-07-17 01:31:16 +00002209 // NOTE: If a "return" appears in the middle of a block, this means that the
2210 // code afterwards is DEAD (unreachable). We still keep a basic block
2211 // for that code; a simple "mark-and-sweep" from the entry block will be
2212 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002213
2214 // Create the new block.
2215 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002216
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002217 addAutomaticObjDtors(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002218
2219 // If the one of the destructors does not return, we already have the Exit
2220 // block as a successor.
2221 if (!Block->hasNoReturnElement())
2222 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002223
2224 // Add the return statement to the block. This may create new blocks if R
2225 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002226 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002227}
2228
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002229CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002230 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002231 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002232 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002233
Ted Kremenek93668002009-07-17 22:18:43 +00002234 if (!LabelBlock) // This can happen when the body is empty, i.e.
2235 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002236
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002237 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2238 "label already in map");
2239 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002240
2241 // Labels partition blocks, so this is the end of the basic block we were
2242 // processing (L is the block's label). Because this is label (and we have
2243 // already processed the substatement) there is no extra control-flow to worry
2244 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002245 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002246 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002247 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002248
2249 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002250 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002251
Ted Kremenek9aae5132007-08-23 21:42:29 +00002252 // This block is now the implicit successor of other blocks.
2253 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002254
Ted Kremenek9aae5132007-08-23 21:42:29 +00002255 return LabelBlock;
2256}
2257
Ted Kremenekda76a942012-04-12 20:34:52 +00002258CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
2259 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2260 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
2261 et = E->capture_init_end(); it != et; ++it) {
2262 if (Expr *Init = *it) {
2263 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00002264 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00002265 LastBlock = Tmp;
2266 }
2267 }
2268 return LastBlock;
2269}
2270
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002271CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00002272 // Goto is a control-flow statement. Thus we stop processing the current
2273 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00002274
Ted Kremenek9aae5132007-08-23 21:42:29 +00002275 Block = createBlock(false);
2276 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00002277
2278 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002279 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00002280
Ted Kremenek9aae5132007-08-23 21:42:29 +00002281 if (I == LabelMap.end())
2282 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002283 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
2284 else {
2285 JumpTarget JT = I->second;
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002286 addAutomaticObjDtors(ScopePos, JT.scopePosition, G);
2287 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002288 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002289
Mike Stump31feda52009-07-17 01:31:16 +00002290 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002291}
2292
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002293CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00002294 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002295
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002296 // Save local scope position because in case of condition variable ScopePos
2297 // won't be restored when traversing AST.
2298 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2299
2300 // Create local scope for init statement and possible condition variable.
2301 // Add destructor for init statement and condition variable.
2302 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002303 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002304 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002305 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
2306
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002307 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002308 addLocalScopeForVarDecl(VD);
2309 LocalScope::const_iterator ContinueScopePos = ScopePos;
2310
2311 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), F);
2312
Mike Stump014b3ea2009-07-21 01:12:51 +00002313 // "for" is a control-flow statement. Thus we stop processing the current
2314 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002315 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002316 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002317 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002318 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002319 } else
2320 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002321
Ted Kremenek304a9532010-05-21 20:30:15 +00002322 // Save the current value for the break targets.
2323 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002324 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002325 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00002326
Craig Topper25542942014-05-20 04:30:07 +00002327 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00002328
Ted Kremenek9aae5132007-08-23 21:42:29 +00002329 // Now create the loop body.
2330 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002331 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002332
Ted Kremenekb50e7162012-07-14 05:04:10 +00002333 // Save the current values for Block, Succ, continue and break targets.
2334 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2335 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002336
Ted Kremenekb50e7162012-07-14 05:04:10 +00002337 // Create an empty block to represent the transition block for looping back
2338 // to the head of the loop. If we have increment code, it will
2339 // go in this block as well.
2340 Block = Succ = TransitionBlock = createBlock(false);
2341 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002342
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002343 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00002344 // Generate increment code in its own basic block. This is the target of
2345 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00002346 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00002347 }
Mike Stump31feda52009-07-17 01:31:16 +00002348
Ted Kremenek902393b2009-04-28 00:51:56 +00002349 // Finish up the increment (or empty) block if it hasn't been already.
2350 if (Block) {
2351 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002352 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002353 return nullptr;
2354 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00002355 }
Mike Stump31feda52009-07-17 01:31:16 +00002356
Ted Kremenekb50e7162012-07-14 05:04:10 +00002357 // The starting block for the loop increment is the block that should
2358 // represent the 'loop target' for looping back to the start of the loop.
2359 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
2360 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002361
Ted Kremenekb50e7162012-07-14 05:04:10 +00002362 // Loop body should end with destructor of Condition variable (if any).
2363 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00002364
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002365 // If body is not a compound statement create implicit scope
2366 // and add destructors.
2367 if (!isa<CompoundStmt>(F->getBody()))
2368 addLocalScopeAndDtors(F->getBody());
2369
Mike Stump31feda52009-07-17 01:31:16 +00002370 // Now populate the body block, and in the process create new blocks as we
2371 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002372 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00002373
Ted Kremenekb50e7162012-07-14 05:04:10 +00002374 if (!BodyBlock) {
2375 // In the case of "for (...;...;...);" we can have a null BodyBlock.
2376 // Use the continue jump target as the proxy for the body.
2377 BodyBlock = ContinueJumpTarget.block;
2378 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002379 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002380 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002381 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00002382
2383 // Because of short-circuit evaluation, the condition of the loop can span
2384 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2385 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00002386 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002387
Ted Kremenekb50e7162012-07-14 05:04:10 +00002388 do {
2389 Expr *C = F->getCond();
2390
2391 // Specially handle logical operators, which have a slightly
2392 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00002393 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00002394 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002395 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002396 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002397 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
2398 break;
2399 }
2400
2401 // The default case when not handling logical operators.
2402 EntryConditionBlock = ExitConditionBlock = createBlock(false);
2403 ExitConditionBlock->setTerminator(F);
2404
2405 // See if this is a known constant.
2406 TryResult KnownVal(true);
2407
2408 if (C) {
2409 // Now add the actual condition to the condition block.
2410 // Because the condition itself may contain control-flow, new blocks may
2411 // be created. Thus we update "Succ" after adding the condition.
2412 Block = ExitConditionBlock;
2413 EntryConditionBlock = addStmt(C);
2414
2415 // If this block contains a condition variable, add both the condition
2416 // variable and initializer to the CFG.
2417 if (VarDecl *VD = F->getConditionVariable()) {
2418 if (Expr *Init = VD->getInit()) {
2419 autoCreateBlock();
2420 appendStmt(Block, F->getConditionVariableDeclStmt());
2421 EntryConditionBlock = addStmt(Init);
2422 assert(Block == EntryConditionBlock);
2423 }
2424 }
2425
2426 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002427 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002428
2429 KnownVal = tryEvaluateBool(C);
2430 }
2431
2432 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00002433 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002434 // Link up the condition block with the code that follows the loop. (the
2435 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00002436 addSuccessor(ExitConditionBlock,
2437 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002438
2439 } while (false);
2440
2441 // Link up the loop-back block to the entry condition block.
2442 addSuccessor(TransitionBlock, EntryConditionBlock);
2443
2444 // The condition block is the implicit successor for any code above the loop.
2445 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002446
Ted Kremenek9aae5132007-08-23 21:42:29 +00002447 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00002448 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002449 if (Stmt *I = F->getInit()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002450 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00002451 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002452 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002453
2454 // There is no loop initialization. We are thus basically a while loop.
2455 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00002456 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002457 Succ = EntryConditionBlock;
2458 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002459}
2460
Ted Kremenek5868ec62010-04-11 17:02:10 +00002461CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002462 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00002463 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002464 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002465 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002466 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00002467}
2468
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002469CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00002470 // Objective-C fast enumeration 'for' statements:
2471 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
2472 //
2473 // for ( Type newVariable in collection_expression ) { statements }
2474 //
2475 // becomes:
2476 //
2477 // prologue:
2478 // 1. collection_expression
2479 // T. jump to loop_entry
2480 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002481 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00002482 // 1. ObjCForCollectionStmt [performs binding to newVariable]
2483 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
2484 // TB:
2485 // statements
2486 // T. jump to loop_entry
2487 // FB:
2488 // what comes after
2489 //
2490 // and
2491 //
2492 // Type existingItem;
2493 // for ( existingItem in expression ) { statements }
2494 //
2495 // becomes:
2496 //
Mike Stump31feda52009-07-17 01:31:16 +00002497 // the same with newVariable replaced with existingItem; the binding works
2498 // the same except that for one ObjCForCollectionStmt::getElement() returns
2499 // a DeclStmt and the other returns a DeclRefExpr.
Ted Kremenek9d56e642008-11-11 17:10:00 +00002500 //
Mike Stump31feda52009-07-17 01:31:16 +00002501
Craig Topper25542942014-05-20 04:30:07 +00002502 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002503
Ted Kremenek9d56e642008-11-11 17:10:00 +00002504 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002505 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002506 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00002507 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00002508 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00002509 } else
2510 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002511
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002512 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002513 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002514
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002515 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00002516 ExitConditionBlock->setTerminator(S);
2517
2518 // The last statement in the block should be the ObjCForCollectionStmt, which
2519 // performs the actual binding to 'element' and determines if there are any
2520 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00002521 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002522 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002523
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002524 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00002525 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00002526 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00002527 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
2528 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00002529 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002530 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002531 return nullptr;
2532 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002533 }
Mike Stump31feda52009-07-17 01:31:16 +00002534
2535 // The condition block is the implicit successor for the loop body as well as
2536 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002537 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002538
Ted Kremenek9d56e642008-11-11 17:10:00 +00002539 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00002540 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002541 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00002542 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002543 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00002544 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002545
Anna Zaks56b49752013-06-22 00:23:20 +00002546 // Add an intermediate block between the BodyBlock and the
2547 // EntryConditionBlock to represent the "loop back" transition, for looping
2548 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00002549 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00002550 Succ = LoopBackBlock = createBlock();
2551 LoopBackBlock->setLoopTarget(S);
2552
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002553 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00002554 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002555
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002556 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002557
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002558 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00002559 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00002560 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002561 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002562 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002563 }
Mike Stump31feda52009-07-17 01:31:16 +00002564
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002565 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002566 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002567 }
Mike Stump31feda52009-07-17 01:31:16 +00002568
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002569 // Link up the condition block with the code that follows the loop.
2570 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002571 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002572
Ted Kremenek9d56e642008-11-11 17:10:00 +00002573 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002574 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00002575 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00002576}
2577
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002578CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
2579 // Inline the body.
2580 return addStmt(S->getSubStmt());
2581 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
2582}
2583
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002584CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00002585 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00002586
Ted Kremenek49805452009-05-02 01:49:13 +00002587 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00002588 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00002589
Ted Kremenekb3c657b2009-05-05 23:11:51 +00002590 // The sync body starts its own basic block. This makes it a little easier
2591 // for diagnostic clients.
2592 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002593 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002594 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002595
Craig Topper25542942014-05-20 04:30:07 +00002596 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00002597 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00002598 }
Mike Stump31feda52009-07-17 01:31:16 +00002599
Ted Kremeneked12f1b2010-09-10 03:05:33 +00002600 // Add the @synchronized to the CFG.
2601 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002602 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00002603
Ted Kremenek49805452009-05-02 01:49:13 +00002604 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00002605 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00002606}
Mike Stump31feda52009-07-17 01:31:16 +00002607
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002608CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00002609 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00002610 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00002611}
Ted Kremenek9d56e642008-11-11 17:10:00 +00002612
John McCallfe96e0b2011-11-06 09:01:30 +00002613CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
2614 autoCreateBlock();
2615
2616 // Add the PseudoObject as the last thing.
2617 appendStmt(Block, E);
2618
2619 CFGBlock *lastBlock = Block;
2620
2621 // Before that, evaluate all of the semantics in order. In
2622 // CFG-land, that means appending them in reverse order.
2623 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
2624 Expr *Semantic = E->getSemanticExpr(--i);
2625
2626 // If the semantic is an opaque value, we're being asked to bind
2627 // it to its source expression.
2628 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
2629 Semantic = OVE->getSourceExpr();
2630
2631 if (CFGBlock *B = Visit(Semantic))
2632 lastBlock = B;
2633 }
2634
2635 return lastBlock;
2636}
2637
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002638CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00002639 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002640
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002641 // Save local scope position because in case of condition variable ScopePos
2642 // won't be restored when traversing AST.
2643 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2644
2645 // Create local scope for possible condition variable.
2646 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002647 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002648 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002649 addLocalScopeForVarDecl(VD);
2650 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W);
2651 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002652
Mike Stump014b3ea2009-07-21 01:12:51 +00002653 // "while" is a control-flow statement. Thus we stop processing the current
2654 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002655 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002656 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002657 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002658 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00002659 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002660 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00002661 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00002662 }
Mike Stump31feda52009-07-17 01:31:16 +00002663
Craig Topper25542942014-05-20 04:30:07 +00002664 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00002665
Ted Kremenek9aae5132007-08-23 21:42:29 +00002666 // Process the loop body.
2667 {
Ted Kremenek49936f72009-04-28 03:09:44 +00002668 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00002669
Ted Kremenekb50e7162012-07-14 05:04:10 +00002670 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002671 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2672 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00002673 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00002674
Mike Stump31feda52009-07-17 01:31:16 +00002675 // Create an empty block to represent the transition block for looping back
2676 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002677 Succ = TransitionBlock = createBlock(false);
2678 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002679 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002680
Ted Kremenek9aae5132007-08-23 21:42:29 +00002681 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002682 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002683
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002684 // Loop body should end with destructor of Condition variable (if any).
2685 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W);
2686
2687 // If body is not a compound statement create implicit scope
2688 // and add destructors.
2689 if (!isa<CompoundStmt>(W->getBody()))
2690 addLocalScopeAndDtors(W->getBody());
2691
Ted Kremenek9aae5132007-08-23 21:42:29 +00002692 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002693 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002694
Ted Kremeneke9610502007-08-30 18:39:40 +00002695 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002696 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00002697 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002698 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002699 }
2700
2701 // Because of short-circuit evaluation, the condition of the loop can span
2702 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2703 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00002704 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002705
2706 do {
2707 Expr *C = W->getCond();
2708
2709 // Specially handle logical operators, which have a slightly
2710 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00002711 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002712 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002713 std::tie(EntryConditionBlock, ExitConditionBlock) =
2714 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002715 break;
2716 }
2717
2718 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00002719 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002720 ExitConditionBlock->setTerminator(W);
2721
2722 // Now add the actual condition to the condition block.
2723 // Because the condition itself may contain control-flow, new blocks may
2724 // be created. Thus we update "Succ" after adding the condition.
2725 Block = ExitConditionBlock;
2726 Block = EntryConditionBlock = addStmt(C);
2727
2728 // If this block contains a condition variable, add both the condition
2729 // variable and initializer to the CFG.
2730 if (VarDecl *VD = W->getConditionVariable()) {
2731 if (Expr *Init = VD->getInit()) {
2732 autoCreateBlock();
2733 appendStmt(Block, W->getConditionVariableDeclStmt());
2734 EntryConditionBlock = addStmt(Init);
2735 assert(Block == EntryConditionBlock);
2736 }
Ted Kremenek55957a82009-05-02 00:13:27 +00002737 }
Mike Stump31feda52009-07-17 01:31:16 +00002738
Ted Kremenekb50e7162012-07-14 05:04:10 +00002739 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002740 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002741
2742 // See if this is a known constant.
2743 const TryResult& KnownVal = tryEvaluateBool(C);
2744
Ted Kremenek30754282009-07-24 04:47:11 +00002745 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00002746 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002747 // Link up the condition block with the code that follows the loop. (the
2748 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00002749 addSuccessor(ExitConditionBlock,
2750 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00002751
Ted Kremenekb50e7162012-07-14 05:04:10 +00002752 } while(false);
2753
2754 // Link up the loop-back block to the entry condition block.
2755 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00002756
2757 // There can be no more statements in the condition block since we loop back
2758 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00002759 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002760
Ted Kremenek1ce53c42009-12-24 01:34:10 +00002761 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00002762 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00002763 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002764}
Mike Stump11289f42009-09-09 15:08:12 +00002765
2766
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002767CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00002768 // FIXME: For now we pretend that @catch and the code it contains does not
2769 // exit.
2770 return Block;
2771}
Mike Stump31feda52009-07-17 01:31:16 +00002772
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002773CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00002774 // FIXME: This isn't complete. We basically treat @throw like a return
2775 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00002776
Ted Kremenek0868eea2009-09-24 18:45:41 +00002777 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002778 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002779 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002780
Ted Kremenek93041ba2008-12-09 20:20:09 +00002781 // Create the new block.
2782 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002783
Ted Kremenek93041ba2008-12-09 20:20:09 +00002784 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002785 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002786
2787 // Add the statement to the block. This may create new blocks if S contains
2788 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002789 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00002790}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002791
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002792CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002793 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002794 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002795 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002796
2797 // Create the new block.
2798 Block = createBlock(false);
2799
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002800 if (TryTerminatedBlock)
2801 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002802 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002803 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002804 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002805 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002806
2807 // Add the statement to the block. This may create new blocks if S contains
2808 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002809 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00002810}
2811
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002812CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00002813 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002814
Mike Stump8d50b6a2009-07-21 01:27:50 +00002815 // "do...while" is a control-flow statement. Thus we stop processing the
2816 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002817 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002818 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002819 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002820 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002821 } else
2822 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002823
2824 // Because of short-circuit evaluation, the condition of the loop can span
2825 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2826 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002827 CFGBlock *ExitConditionBlock = createBlock(false);
2828 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002829
Ted Kremenek81e14852007-08-27 19:46:09 +00002830 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00002831 ExitConditionBlock->setTerminator(D);
2832
2833 // Now add the actual condition to the condition block. Because the condition
2834 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002835 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00002836 Block = ExitConditionBlock;
2837 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00002838 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002839 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002840 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002841 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002842 }
Mike Stump31feda52009-07-17 01:31:16 +00002843
Ted Kremeneka1523a32008-02-27 07:20:00 +00002844 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00002845 Succ = EntryConditionBlock;
2846
Mike Stump773582d2009-07-23 23:25:26 +00002847 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002848 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00002849
Ted Kremenek9aae5132007-08-23 21:42:29 +00002850 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00002851 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002852 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002853 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002854
Ted Kremenek9aae5132007-08-23 21:42:29 +00002855 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002856 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2857 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
2858 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002859
Ted Kremenek9aae5132007-08-23 21:42:29 +00002860 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002861 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002862
Ted Kremenek9aae5132007-08-23 21:42:29 +00002863 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002864 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002865
Ted Kremenek9aae5132007-08-23 21:42:29 +00002866 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00002867 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002868
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00002869 // If body is not a compound statement create implicit scope
2870 // and add destructors.
2871 if (!isa<CompoundStmt>(D->getBody()))
2872 addLocalScopeAndDtors(D->getBody());
2873
Ted Kremenek9aae5132007-08-23 21:42:29 +00002874 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00002875 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002876
Ted Kremeneke9610502007-08-30 18:39:40 +00002877 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00002878 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00002879 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002880 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002881 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002882 }
Mike Stump31feda52009-07-17 01:31:16 +00002883
Ted Kremenek110974d2010-08-17 20:59:56 +00002884 if (!KnownVal.isFalse()) {
2885 // Add an intermediate block between the BodyBlock and the
2886 // ExitConditionBlock to represent the "loop back" transition. Create an
2887 // empty block to represent the transition block for looping back to the
2888 // head of the loop.
2889 // FIXME: Can we do this more efficiently without adding another block?
Craig Topper25542942014-05-20 04:30:07 +00002890 Block = nullptr;
Ted Kremenek110974d2010-08-17 20:59:56 +00002891 Succ = BodyBlock;
2892 CFGBlock *LoopBackBlock = createBlock();
2893 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00002894
Ted Kremenek110974d2010-08-17 20:59:56 +00002895 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002896 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00002897 }
2898 else
Craig Topper25542942014-05-20 04:30:07 +00002899 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002900 }
Mike Stump31feda52009-07-17 01:31:16 +00002901
Ted Kremenek30754282009-07-24 04:47:11 +00002902 // Link up the condition block with the code that follows the loop.
2903 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00002904 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00002905
2906 // There can be no more statements in the body block(s) since we loop back to
2907 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00002908 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002909
Ted Kremenek9aae5132007-08-23 21:42:29 +00002910 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00002911 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002912 return BodyBlock;
2913}
2914
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002915CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002916 // "continue" is a control-flow statement. Thus we stop processing the
2917 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002918 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002919 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002920
Ted Kremenek9aae5132007-08-23 21:42:29 +00002921 // Now create a new block that ends with the continue statement.
2922 Block = createBlock(false);
2923 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00002924
Ted Kremenek9aae5132007-08-23 21:42:29 +00002925 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00002926 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002927 if (ContinueJumpTarget.block) {
2928 addAutomaticObjDtors(ScopePos, ContinueJumpTarget.scopePosition, C);
2929 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002930 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00002931 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00002932
Ted Kremenek9aae5132007-08-23 21:42:29 +00002933 return Block;
2934}
Mike Stump11289f42009-09-09 15:08:12 +00002935
Peter Collingbournee190dee2011-03-11 19:24:49 +00002936CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
2937 AddStmtChoice asc) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002938
Ted Kremenek7c58d352011-03-10 01:14:11 +00002939 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002940 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002941 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00002942 }
Mike Stump11289f42009-09-09 15:08:12 +00002943
Ted Kremenek93668002009-07-17 22:18:43 +00002944 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002945 CFGBlock *lastBlock = Block;
2946
Ted Kremenek93668002009-07-17 22:18:43 +00002947 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00002948 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002949 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002950 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00002951 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00002952 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002953}
Mike Stump11289f42009-09-09 15:08:12 +00002954
Ted Kremenek93668002009-07-17 22:18:43 +00002955/// VisitStmtExpr - Utility method to handle (nested) statement
2956/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002957CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002958 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00002959 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002960 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00002961 }
Ted Kremenek93668002009-07-17 22:18:43 +00002962 return VisitCompoundStmt(SE->getSubStmt());
2963}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002964
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002965CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00002966 // "switch" is a control-flow statement. Thus we stop processing the current
2967 // block.
Craig Topper25542942014-05-20 04:30:07 +00002968 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002969
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002970 // Save local scope position because in case of condition variable ScopePos
2971 // won't be restored when traversing AST.
2972 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2973
2974 // Create local scope for possible condition variable.
2975 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002976 if (VarDecl *VD = Terminator->getConditionVariable()) {
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00002977 LocalScope::const_iterator SwitchBeginScopePos = ScopePos;
2978 addLocalScopeForVarDecl(VD);
2979 addAutomaticObjDtors(ScopePos, SwitchBeginScopePos, Terminator);
2980 }
2981
Ted Kremenek9aae5132007-08-23 21:42:29 +00002982 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002983 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002984 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002985 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002986 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002987
2988 // Save the current "switch" context.
2989 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00002990 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002991 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00002992
Mike Stump31feda52009-07-17 01:31:16 +00002993 // Set the "default" case to be the block after the switch statement. If the
2994 // switch statement contains a "default:", this value will be overwritten with
2995 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00002996 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00002997
Ted Kremenek9aae5132007-08-23 21:42:29 +00002998 // Create a new block that will contain the switch statement.
2999 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003000
Ted Kremenek9aae5132007-08-23 21:42:29 +00003001 // Now process the switch body. The code after the switch is the implicit
3002 // successor.
3003 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003004 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003005
3006 // When visiting the body, the case statements should automatically get linked
3007 // up to the switch. We also don't keep a pointer to the body, since all
3008 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003009 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003010 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003011
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003012 // For pruning unreachable case statements, save the current state
3013 // for tracking the condition value.
3014 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3015 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003016
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003017 // Determine if the switch condition can be explicitly evaluated.
3018 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003019 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003020 bool b = tryEvaluate(Terminator->getCond(), result);
3021 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003022 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003023
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003024 // If body is not a compound statement create implicit scope
3025 // and add destructors.
3026 if (!isa<CompoundStmt>(Terminator->getBody()))
3027 addLocalScopeAndDtors(Terminator->getBody());
3028
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003029 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003030 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003031 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003032 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003033 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003034
Mike Stump31feda52009-07-17 01:31:16 +00003035 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003036 // following the switch body. Moreover, take into account if all the
3037 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003038 //
3039 // Note: We add a successor to a switch that is considered covered yet has no
3040 // case statements if the enumeration has no enumerators.
3041 bool SwitchAlwaysHasSuccessor = false;
3042 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3043 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3044 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003045 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3046 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003047
Ted Kremenek81e14852007-08-27 19:46:09 +00003048 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003049 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003050 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003051 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003052
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003053 // Finally, if the SwitchStmt contains a condition variable, add both the
3054 // SwitchStmt and the condition variable initialization to the CFG.
3055 if (VarDecl *VD = Terminator->getConditionVariable()) {
3056 if (Expr *Init = VD->getInit()) {
3057 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003058 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003059 LastBlock = addStmt(Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003060 }
3061 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003062
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003063 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003064}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003065
3066static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003067 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003068 const CaseStmt *CS,
3069 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003070 if (!switchCond)
3071 return true;
3072
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003073 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003074
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003075 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003076 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003077 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003078 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003079 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003080
3081 if (condInt == lhsInt) {
3082 addCase = true;
3083 switchExclusivelyCovered = true;
3084 }
3085 else if (condInt < lhsInt) {
3086 if (const Expr *RHS = CS->getRHS()) {
3087 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003088 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
3089 if (V2 <= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003090 addCase = true;
3091 switchExclusivelyCovered = true;
3092 }
3093 }
3094 }
3095 }
3096 else
3097 addCase = true;
3098 }
3099 return addCase;
3100}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003101
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003102CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003103 // CaseStmts are essentially labels, so they are the first statement in a
3104 // block.
Craig Topper25542942014-05-20 04:30:07 +00003105 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003106
Ted Kremenek60fa6572010-08-04 23:54:30 +00003107 if (Stmt *Sub = CS->getSubStmt()) {
3108 // For deeply nested chains of CaseStmts, instead of doing a recursion
3109 // (which can blow out the stack), manually unroll and create blocks
3110 // along the way.
3111 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003112 CFGBlock *currentBlock = createBlock(false);
3113 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003114
Ted Kremenek60fa6572010-08-04 23:54:30 +00003115 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003116 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003117 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003118 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003119
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003120 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003121 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003122 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003123 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003124
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003125 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003126 CS = cast<CaseStmt>(Sub);
3127 Sub = CS->getSubStmt();
3128 }
3129
3130 addStmt(Sub);
3131 }
Mike Stump11289f42009-09-09 15:08:12 +00003132
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003133 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003134 if (!CaseBlock)
3135 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003136
3137 // Cases statements partition blocks, so this is the top of the basic block we
3138 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003139 CaseBlock->setLabel(CS);
3140
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003141 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003142 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003143
3144 // Add this block to the list of successors for the block with the switch
3145 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003146 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003147 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003148 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003149 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003150
Ted Kremenek9aae5132007-08-23 21:42:29 +00003151 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003152 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003153
Ted Kremenek60fa6572010-08-04 23:54:30 +00003154 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003155 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003156 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003157 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003158 // This block is now the implicit successor of other blocks.
3159 Succ = CaseBlock;
3160 }
Mike Stump31feda52009-07-17 01:31:16 +00003161
Ted Kremenek60fa6572010-08-04 23:54:30 +00003162 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003163}
Mike Stump31feda52009-07-17 01:31:16 +00003164
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003165CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003166 if (Terminator->getSubStmt())
3167 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003168
Ted Kremenek654c78f2008-02-13 22:05:39 +00003169 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003170
3171 if (!DefaultCaseBlock)
3172 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003173
3174 // Default statements partition blocks, so this is the top of the basic block
3175 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003176 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003177
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003178 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003179 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003180
Mike Stump31feda52009-07-17 01:31:16 +00003181 // Unlike case statements, we don't add the default block to the successors
3182 // for the switch statement immediately. This is done when we finish
3183 // processing the switch statement. This allows for the default case
3184 // (including a fall-through to the code after the switch statement) to always
3185 // be the last successor of a switch-terminated block.
3186
Ted Kremenek654c78f2008-02-13 22:05:39 +00003187 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003188 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003189
Ted Kremenek654c78f2008-02-13 22:05:39 +00003190 // This block is now the implicit successor of other blocks.
3191 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003192
3193 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003194}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003195
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003196CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3197 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3198 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003199 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003200
3201 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003202 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003203 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003204 TrySuccessor = Block;
3205 } else TrySuccessor = Succ;
3206
Mike Stump0bdba6c2010-01-20 01:15:34 +00003207 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003208
3209 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003210 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003211 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003212 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003213
Mike Stump0bdba6c2010-01-20 01:15:34 +00003214 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003215 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3216 // The code after the try is the implicit successor.
3217 Succ = TrySuccessor;
3218 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003219 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003220 HasCatchAll = true;
3221 }
Craig Topper25542942014-05-20 04:30:07 +00003222 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003223 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00003224 if (!CatchBlock)
3225 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003226 // Add this block to the list of successors for the block with the try
3227 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003228 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003229 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00003230 if (!HasCatchAll) {
3231 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003232 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00003233 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003234 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00003235 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003236
3237 // The code after the try is the implicit successor.
3238 Succ = TrySuccessor;
3239
Mike Stump845384a2010-01-20 01:30:58 +00003240 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00003241 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
3242 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00003243
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003244 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003245 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003246 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003247}
3248
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003249CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003250 // CXXCatchStmt are treated like labels, so they are the first statement in a
3251 // block.
3252
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003253 // Save local scope position because in case of exception variable ScopePos
3254 // won't be restored when traversing AST.
3255 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3256
3257 // Create local scope for possible exception variable.
3258 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003259 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003260 LocalScope::const_iterator BeginScopePos = ScopePos;
3261 addLocalScopeForVarDecl(VD);
3262 addAutomaticObjDtors(ScopePos, BeginScopePos, CS);
3263 }
3264
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003265 if (CS->getHandlerBlock())
3266 addStmt(CS->getHandlerBlock());
3267
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003268 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003269 if (!CatchBlock)
3270 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003271
3272 // CXXCatchStmt is more than just a label. They have semantic meaning
3273 // as well, as they implicitly "initialize" the catch variable. Add
3274 // it to the CFG as a CFGElement so that the control-flow of these
3275 // semantics gets captured.
3276 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003277
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003278 // Also add the CXXCatchStmt as a label, to mirror handling of regular
3279 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003280 CatchBlock->setLabel(CS);
3281
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003282 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003283 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003284 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003285
3286 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003287 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003288
3289 return CatchBlock;
3290}
3291
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003292CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00003293 // C++0x for-range statements are specified as [stmt.ranged]:
3294 //
3295 // {
3296 // auto && __range = range-init;
3297 // for ( auto __begin = begin-expr,
3298 // __end = end-expr;
3299 // __begin != __end;
3300 // ++__begin ) {
3301 // for-range-declaration = *__begin;
3302 // statement
3303 // }
3304 // }
3305
3306 // Save local scope position before the addition of the implicit variables.
3307 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3308
3309 // Create local scopes and destructors for range, begin and end variables.
3310 if (Stmt *Range = S->getRangeStmt())
3311 addLocalScopeForStmt(Range);
3312 if (Stmt *BeginEnd = S->getBeginEndStmt())
3313 addLocalScopeForStmt(BeginEnd);
3314 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), S);
3315
3316 LocalScope::const_iterator ContinueScopePos = ScopePos;
3317
3318 // "for" is a control-flow statement. Thus we stop processing the current
3319 // block.
Craig Topper25542942014-05-20 04:30:07 +00003320 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003321 if (Block) {
3322 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003323 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003324 LoopSuccessor = Block;
3325 } else
3326 LoopSuccessor = Succ;
3327
3328 // Save the current value for the break targets.
3329 // All breaks should go to the code following the loop.
3330 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
3331 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
3332
3333 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003334 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00003335 ConditionBlock->setTerminator(S);
3336
3337 // Now add the actual condition to the condition block.
3338 if (Expr *C = S->getCond()) {
3339 Block = ConditionBlock;
3340 CFGBlock *BeginConditionBlock = addStmt(C);
3341 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003342 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003343 assert(BeginConditionBlock == ConditionBlock &&
3344 "condition block in for-range was unexpectedly complex");
3345 (void)BeginConditionBlock;
3346 }
3347
3348 // The condition block is the implicit successor for the loop body as well as
3349 // any code above the loop.
3350 Succ = ConditionBlock;
3351
3352 // See if this is a known constant.
3353 TryResult KnownVal(true);
3354
3355 if (S->getCond())
3356 KnownVal = tryEvaluateBool(S->getCond());
3357
3358 // Now create the loop body.
3359 {
3360 assert(S->getBody());
3361
3362 // Save the current values for Block, Succ, and continue targets.
3363 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3364 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
3365
3366 // Generate increment code in its own basic block. This is the target of
3367 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00003368 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003369 Succ = addStmt(S->getInc());
3370 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3371
3372 // The starting block for the loop increment is the block that should
3373 // represent the 'loop target' for looping back to the start of the loop.
3374 ContinueJumpTarget.block->setLoopTarget(S);
3375
3376 // Finish up the increment block and prepare to start the loop body.
3377 assert(Block);
3378 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003379 return nullptr;
3380 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003381
3382 // Add implicit scope and dtors for loop variable.
3383 addLocalScopeAndDtors(S->getLoopVarStmt());
3384
3385 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003386 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00003387 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003388 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003389 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003390 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003391 return nullptr;
3392
Richard Smith02e85f32011-04-14 22:09:26 +00003393 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00003394 addSuccessor(ConditionBlock,
3395 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00003396 }
3397
3398 // Link up the condition block with the code that follows the loop (the
3399 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003400 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00003401
3402 // Add the initialization statements.
3403 Block = createBlock();
Richard Smith0c502d22011-04-18 15:49:25 +00003404 addStmt(S->getBeginEndStmt());
3405 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003406}
3407
John McCall5d413782010-12-06 08:20:24 +00003408CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003409 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00003410 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003411 // If adding implicit destructors visit the full expression for adding
3412 // destructors of temporaries.
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003413 TempDtorContext Context(/*IsConditional=*/false);
3414 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003415
3416 // Full expression has to be added as CFGStmt so it will be sequenced
3417 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003418 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003419 }
3420 return Visit(E->getSubExpr(), asc);
3421}
3422
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003423CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
3424 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003425 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003426 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003427 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003428
3429 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003430 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003431 }
3432 return Visit(E->getSubExpr(), asc);
3433}
3434
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003435CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
3436 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003437 autoCreateBlock();
Zhongxing Xuf0cb43f2012-01-11 02:39:07 +00003438 appendStmt(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003439
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003440 return VisitChildren(C);
3441}
3442
Jordan Rosec9176072014-01-13 17:59:19 +00003443CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
3444 AddStmtChoice asc) {
3445
3446 autoCreateBlock();
3447 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00003448
Jordan Rosec9176072014-01-13 17:59:19 +00003449 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00003450 Block = Visit(NE->getInitializer());
Jordan Rosec9176072014-01-13 17:59:19 +00003451 if (BuildOpts.AddCXXNewAllocator)
3452 appendNewAllocator(Block, NE);
3453 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00003454 Block = Visit(NE->getArraySize());
Jordan Rosec9176072014-01-13 17:59:19 +00003455 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
3456 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00003457 Block = Visit(*I);
Jordan Rosec9176072014-01-13 17:59:19 +00003458 return Block;
3459}
Jordan Rosed2f40792013-09-03 17:00:57 +00003460
3461CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
3462 AddStmtChoice asc) {
3463 autoCreateBlock();
3464 appendStmt(Block, DE);
3465 QualType DTy = DE->getDestroyedType();
3466 DTy = DTy.getNonReferenceType();
3467 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
3468 if (RD) {
Matt Beaumont-Gay093f2402013-09-09 21:07:58 +00003469 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
Jordan Rosed2f40792013-09-03 17:00:57 +00003470 appendDeleteDtor(Block, RD, DE);
3471 }
3472
3473 return VisitChildren(DE);
3474}
3475
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003476CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
3477 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003478 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003479 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003480 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003481 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003482 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003483 }
3484 return Visit(E->getSubExpr(), asc);
3485}
3486
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003487CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
3488 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003489 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003490 appendStmt(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003491 return VisitChildren(C);
3492}
3493
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003494CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
3495 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003496 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003497 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003498 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003499 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003500 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003501}
3502
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003503CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00003504 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003505 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003506
Ted Kremenekeda180e22007-08-28 19:26:49 +00003507 if (!IBlock) {
3508 IBlock = createBlock(false);
3509 cfg->setIndirectGotoBlock(IBlock);
3510 }
Mike Stump31feda52009-07-17 01:31:16 +00003511
Ted Kremenekeda180e22007-08-28 19:26:49 +00003512 // IndirectGoto is a control-flow statement. Thus we stop processing the
3513 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003514 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003515 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003516
Ted Kremenekeda180e22007-08-28 19:26:49 +00003517 Block = createBlock(false);
3518 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003519 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00003520 return addStmt(I->getTarget());
3521}
3522
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003523CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
3524 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00003525 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
3526
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003527tryAgain:
3528 if (!E) {
3529 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00003530 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003531 }
3532 switch (E->getStmtClass()) {
3533 default:
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003534 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003535
3536 case Stmt::BinaryOperatorClass:
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003537 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
3538 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003539
3540 case Stmt::CXXBindTemporaryExprClass:
3541 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003542 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003543
John McCallc07a0c72011-02-17 10:25:35 +00003544 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003545 case Stmt::ConditionalOperatorClass:
3546 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003547 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003548
3549 case Stmt::ImplicitCastExprClass:
3550 // For implicit cast we want BindToTemporary to be passed further.
3551 E = cast<CastExpr>(E)->getSubExpr();
3552 goto tryAgain;
3553
Manuel Klimekb0042c42014-07-30 08:34:42 +00003554 case Stmt::CXXFunctionalCastExprClass:
3555 // For functional cast we want BindToTemporary to be passed further.
3556 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
3557 goto tryAgain;
3558
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003559 case Stmt::ParenExprClass:
3560 E = cast<ParenExpr>(E)->getSubExpr();
3561 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00003562
Manuel Klimekb0042c42014-07-30 08:34:42 +00003563 case Stmt::MaterializeTemporaryExprClass: {
3564 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
3565 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
3566 SmallVector<const Expr *, 2> CommaLHSs;
3567 SmallVector<SubobjectAdjustment, 2> Adjustments;
3568 // Find the expression whose lifetime needs to be extended.
3569 E = const_cast<Expr *>(
3570 cast<MaterializeTemporaryExpr>(E)
3571 ->GetTemporaryExpr()
3572 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
3573 // Visit the skipped comma operator left-hand sides for other temporaries.
3574 for (const Expr *CommaLHS : CommaLHSs) {
3575 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003576 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00003577 }
Douglas Gregorfe314812011-06-21 17:03:29 +00003578 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00003579 }
Richard Smith4137af22014-07-27 05:12:49 +00003580
3581 case Stmt::BlockExprClass:
3582 // Don't recurse into blocks; their subexpressions don't get evaluated
3583 // here.
3584 return Block;
3585
3586 case Stmt::LambdaExprClass: {
3587 // For lambda expressions, only recurse into the capture initializers,
3588 // and not the body.
3589 auto *LE = cast<LambdaExpr>(E);
3590 CFGBlock *B = Block;
3591 for (Expr *Init : LE->capture_inits()) {
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003592 if (CFGBlock *R = VisitForTemporaryDtors(
3593 Init, /*BindToTemporary=*/false, Context))
Richard Smith4137af22014-07-27 05:12:49 +00003594 B = R;
3595 }
3596 return B;
3597 }
3598
3599 case Stmt::CXXDefaultArgExprClass:
3600 E = cast<CXXDefaultArgExpr>(E)->getExpr();
3601 goto tryAgain;
3602
3603 case Stmt::CXXDefaultInitExprClass:
3604 E = cast<CXXDefaultInitExpr>(E)->getExpr();
3605 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003606 }
3607}
3608
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003609CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
3610 TempDtorContext &Context) {
3611 if (isa<LambdaExpr>(E)) {
3612 // Do not visit the children of lambdas; they have their own CFGs.
3613 return Block;
3614 }
3615
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003616 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00003617 // order that they will appear in the CFG. Because the CFG is built
3618 // bottom-up, this means we visit them in their natural order, which
3619 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003620 CFGBlock *B = Block;
Ted Kremenek8ae67872013-02-05 22:00:19 +00003621 for (Stmt::child_range I = E->children(); I; ++I) {
3622 if (Stmt *Child = *I)
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003623 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00003624 B = R;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003625 }
3626 return B;
3627}
3628
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003629CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
3630 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003631 if (E->isLogicalOp()) {
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003632 VisitForTemporaryDtors(E->getLHS(), false, Context);
3633 // We do not know at CFG-construction time whether the right-hand-side was
3634 // executed, thus we add a branch node that depends on the temporary
3635 // constructor call.
3636 TempDtorContext RHSContext(/*IsConditional=*/true);
3637 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
3638 InsertTempDtorDecisionBlock(RHSContext);
3639 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003640 }
3641
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003642 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003643 // For assignment operator (=) LHS expression is visited
3644 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003645 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
3646 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003647 return LHSBlock ? LHSBlock : RHSBlock;
3648 }
3649
3650 // For any other binary operator RHS expression is visited before
3651 // LHS expression (order of children). For destructors visit them in reverse
3652 // order.
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003653 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
3654 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003655 return RHSBlock ? RHSBlock : LHSBlock;
3656}
3657
3658CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003659 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003660 // First add destructors for temporaries in subexpression.
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003661 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00003662 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003663 // If lifetime of temporary is not prolonged (by assigning to constant
3664 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00003665
Chandler Carruthad747252011-09-13 06:09:01 +00003666 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003667
Ted Kremenekff909f92014-03-08 02:22:25 +00003668 if (Dtor->isNoReturn()) {
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003669 // If the destructor is marked as a no-return destructor, we need to
3670 // create a new block for the destructor which does not have as a
3671 // successor anything built thus far. Control won't flow out of this
3672 // block.
3673 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00003674 Block = createNoReturnBlock();
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003675 } else if (Context.needsTempDtorBranch()) {
3676 // If we need to introduce a branch, we add a new block that we will hook
3677 // up to a decision block later.
3678 if (B) Succ = B;
3679 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00003680 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00003681 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00003682 }
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003683 if (Context.needsTempDtorBranch()) {
3684 Context.setDecisionPoint(Succ, E);
3685 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003686 appendTemporaryDtor(Block, E);
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003687
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003688 B = Block;
3689 }
3690 return B;
3691}
3692
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003693void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context) {
3694 if (!Context.TerminatorExpr) {
3695 // If no temporary was found, we do not need to insert a decision point.
3696 return;
3697 }
3698 assert(Context.TerminatorExpr);
3699 CFGBlock *Decision = createBlock(false);
3700 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
3701 addSuccessor(Decision, Block);
3702 addSuccessor(Decision, Context.Succ);
3703 Block = Decision;
3704}
3705
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003706CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekd9b4ad62014-08-06 12:45:51 +00003707 AbstractConditionalOperator *E, bool BindToTemporary,
3708 TempDtorContext &Context) {
3709 VisitForTemporaryDtors(E->getCond(), false, Context);
3710 TempDtorContext TrueContext(/*IsConditional=*/true);
3711 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
3712 InsertTempDtorDecisionBlock(TrueContext);
3713 TempDtorContext FalseContext(/*IsConditional=*/true);
3714 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
3715 InsertTempDtorDecisionBlock(FalseContext);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003716 return Block;
3717}
3718
Ted Kremenek04cca642007-08-23 21:26:19 +00003719} // end anonymous namespace
Ted Kremenek889073f2007-08-23 16:51:22 +00003720
Mike Stump31feda52009-07-17 01:31:16 +00003721/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
3722/// no successors or predecessors. If this is the first block created in the
3723/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003724CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00003725 bool first_block = begin() == end();
3726
3727 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003728 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00003729 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003730 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00003731
3732 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003733 if (first_block)
3734 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00003735
3736 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003737 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00003738}
3739
Ted Kremenek889073f2007-08-23 16:51:22 +00003740/// buildCFG - Constructs a CFG from an AST. Ownership of the returned
3741/// CFG is returned to the caller.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003742CFG* CFG::buildCFG(const Decl *D, Stmt *Statement, ASTContext *C,
Ted Kremenekf9d82902011-03-10 01:14:05 +00003743 const BuildOptions &BO) {
3744 CFGBuilder Builder(C, BO);
3745 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00003746}
3747
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003748const CXXDestructorDecl *
3749CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003750 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003751 case CFGElement::Statement:
3752 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00003753 case CFGElement::NewAllocator:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003754 llvm_unreachable("getDestructorDecl should only be used with "
3755 "ImplicitDtors");
3756 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00003757 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003758 QualType ty = var->getType();
Ted Kremenek1676a042011-03-03 01:01:03 +00003759 ty = ty.getNonReferenceType();
Ted Kremeneke7d78882012-03-19 23:48:41 +00003760 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003761 ty = arrayType->getElementType();
3762 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003763 const RecordType *recordType = ty->getAs<RecordType>();
3764 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00003765 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003766 return classDecl->getDestructor();
3767 }
Jordan Rosed2f40792013-09-03 17:00:57 +00003768 case CFGElement::DeleteDtor: {
3769 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
3770 QualType DTy = DE->getDestroyedType();
3771 DTy = DTy.getNonReferenceType();
3772 const CXXRecordDecl *classDecl =
3773 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
3774 return classDecl->getDestructor();
3775 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003776 case CFGElement::TemporaryDtor: {
3777 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00003778 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003779 const CXXTemporary *temp = bindExpr->getTemporary();
3780 return temp->getDestructor();
3781 }
3782 case CFGElement::BaseDtor:
3783 case CFGElement::MemberDtor:
3784
3785 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00003786 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003787 }
Ted Kremenek1676a042011-03-03 01:01:03 +00003788 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003789}
3790
Ted Kremenek8cfe2072011-03-03 01:21:32 +00003791bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00003792 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
3793 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00003794 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00003795}
3796
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00003797//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003798// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00003799//===----------------------------------------------------------------------===//
3800
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003801CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Craig Topper25542942014-05-20 04:30:07 +00003802 : ReachableBlock(IsReachable ? B : nullptr),
3803 UnreachableBlock(!IsReachable ? B : nullptr,
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003804 B && IsReachable ? AB_Normal : AB_Unreachable) {}
3805
3806CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
3807 : ReachableBlock(B),
Craig Topper25542942014-05-20 04:30:07 +00003808 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003809 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
3810
3811void CFGBlock::addSuccessor(AdjacentBlock Succ,
3812 BumpVectorContext &C) {
3813 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00003814 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003815
3816 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00003817 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003818
3819 Succs.push_back(Succ, C);
3820}
3821
Ted Kremenekb0371852010-09-09 00:06:04 +00003822bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00003823 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003824
Ted Kremenek4b6fee62014-02-27 00:24:00 +00003825 if (F.IgnoreNullPredecessors && !From)
3826 return true;
3827
3828 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003829 // If the 'To' has no label or is labeled but the label isn't a
3830 // CaseStmt then filter this edge.
3831 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00003832 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00003833 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00003834 const Stmt *L = To->getLabel();
3835 if (!L || !isa<CaseStmt>(L))
3836 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00003837 }
3838 }
3839 }
3840
3841 return false;
3842}
3843
3844//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00003845// CFG pretty printing
3846//===----------------------------------------------------------------------===//
3847
Ted Kremenek7e776b12007-08-22 18:22:34 +00003848namespace {
3849
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00003850class StmtPrinterHelper : public PrinterHelper {
Ted Kremenek96a7a592011-03-01 03:15:10 +00003851 typedef llvm::DenseMap<const Stmt*,std::pair<unsigned,unsigned> > StmtMapTy;
3852 typedef llvm::DenseMap<const Decl*,std::pair<unsigned,unsigned> > DeclMapTy;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003853 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003854 DeclMapTy DeclMap;
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003855 signed currentBlock;
Ted Kremenekd94854a2012-08-22 06:26:15 +00003856 unsigned currStmt;
Chris Lattnerc61089a2009-06-30 01:26:17 +00003857 const LangOptions &LangOpts;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003858public:
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003859
Chris Lattnerc61089a2009-06-30 01:26:17 +00003860 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Ted Kremenekd94854a2012-08-22 06:26:15 +00003861 : currentBlock(0), currStmt(0), LangOpts(LO)
Ted Kremenek96a7a592011-03-01 03:15:10 +00003862 {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003863 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
3864 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00003865 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003866 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00003867 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
3868 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003869 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00003870 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003871
Ted Kremenek96a7a592011-03-01 03:15:10 +00003872 switch (stmt->getStmtClass()) {
3873 case Stmt::DeclStmtClass:
3874 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
3875 break;
3876 case Stmt::IfStmtClass: {
3877 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
3878 if (var)
3879 DeclMap[var] = P;
3880 break;
3881 }
3882 case Stmt::ForStmtClass: {
3883 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
3884 if (var)
3885 DeclMap[var] = P;
3886 break;
3887 }
3888 case Stmt::WhileStmtClass: {
3889 const VarDecl *var =
3890 cast<WhileStmt>(stmt)->getConditionVariable();
3891 if (var)
3892 DeclMap[var] = P;
3893 break;
3894 }
3895 case Stmt::SwitchStmtClass: {
3896 const VarDecl *var =
3897 cast<SwitchStmt>(stmt)->getConditionVariable();
3898 if (var)
3899 DeclMap[var] = P;
3900 break;
3901 }
3902 case Stmt::CXXCatchStmtClass: {
3903 const VarDecl *var =
3904 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
3905 if (var)
3906 DeclMap[var] = P;
3907 break;
3908 }
3909 default:
3910 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003911 }
3912 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003913 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00003914 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003915 }
Ted Kremenek96a7a592011-03-01 03:15:10 +00003916
Mike Stump31feda52009-07-17 01:31:16 +00003917
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003918 virtual ~StmtPrinterHelper() {}
Mike Stump31feda52009-07-17 01:31:16 +00003919
Chris Lattnerc61089a2009-06-30 01:26:17 +00003920 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003921 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00003922 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00003923
Craig Topperb45acb82014-03-14 06:02:07 +00003924 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003925 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003926
3927 if (I == StmtMap.end())
3928 return false;
Mike Stump31feda52009-07-17 01:31:16 +00003929
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003930 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00003931 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003932 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00003933 }
Mike Stump31feda52009-07-17 01:31:16 +00003934
Ted Kremenek60983dc2010-01-19 20:52:05 +00003935 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00003936 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003937 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003938
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003939 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003940 DeclMapTy::iterator I = DeclMap.find(D);
3941
3942 if (I == DeclMap.end())
3943 return false;
3944
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003945 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00003946 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00003947 return false;
3948 }
3949
3950 OS << "[B" << I->second.first << "." << I->second.second << "]";
3951 return true;
3952 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003953};
Chris Lattnerc61089a2009-06-30 01:26:17 +00003954} // end anonymous namespace
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003955
Chris Lattnerc61089a2009-06-30 01:26:17 +00003956
3957namespace {
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00003958class CFGBlockTerminatorPrint
Ted Kremenek83ebcef2008-01-08 18:15:10 +00003959 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Mike Stump31feda52009-07-17 01:31:16 +00003960
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003961 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003962 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00003963 PrintingPolicy Policy;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00003964public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003965 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00003966 const PrintingPolicy &Policy)
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00003967 : OS(os), Helper(helper), Policy(Policy) {
3968 this->Policy.IncludeNewlines = false;
3969 }
Mike Stump31feda52009-07-17 01:31:16 +00003970
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003971 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003972 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00003973 if (Stmt *C = I->getCond())
3974 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003975 }
Mike Stump31feda52009-07-17 01:31:16 +00003976
Ted Kremenek9aae5132007-08-23 21:42:29 +00003977 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003978 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003979 Terminator->printPretty(OS, Helper, Policy);
3980 }
3981
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00003982 void VisitDeclStmt(DeclStmt *DS) {
3983 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
3984 OS << "static init " << VD->getName();
3985 }
3986
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003987 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003988 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00003989 if (F->getInit())
3990 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00003991 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003992 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00003993 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00003994 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00003995 if (F->getInc())
3996 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00003997 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00003998 }
Mike Stump31feda52009-07-17 01:31:16 +00003999
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004000 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004001 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004002 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004003 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004004 }
Mike Stump31feda52009-07-17 01:31:16 +00004005
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004006 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004007 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004008 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004009 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004010 }
Mike Stump31feda52009-07-17 01:31:16 +00004011
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004012 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004013 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004014 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004015 }
Mike Stump31feda52009-07-17 01:31:16 +00004016
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004017 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004018 OS << "try ...";
4019 }
4020
John McCallc07a0c72011-02-17 10:25:35 +00004021 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004022 if (Stmt *Cond = C->getCond())
4023 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004024 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004025 }
Mike Stump31feda52009-07-17 01:31:16 +00004026
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004027 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004028 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004029 if (Stmt *Cond = C->getCond())
4030 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004031 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004032 }
Mike Stump31feda52009-07-17 01:31:16 +00004033
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004034 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004035 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004036 if (Stmt *T = I->getTarget())
4037 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004038 }
Mike Stump31feda52009-07-17 01:31:16 +00004039
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004040 void VisitBinaryOperator(BinaryOperator* B) {
4041 if (!B->isLogicalOp()) {
4042 VisitExpr(B);
4043 return;
4044 }
Mike Stump31feda52009-07-17 01:31:16 +00004045
Richard Trieuddd01ce2014-06-09 22:53:25 +00004046 if (B->getLHS())
4047 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004048
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004049 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004050 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004051 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004052 return;
John McCalle3027922010-08-25 11:45:40 +00004053 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004054 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004055 return;
4056 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004057 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004058 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004059 }
Mike Stump31feda52009-07-17 01:31:16 +00004060
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004061 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004062 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004063 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004064
4065public:
4066 void print(CFGTerminator T) {
4067 if (T.isTemporaryDtorsBranch())
4068 OS << "(Temp Dtor) ";
4069 Visit(T.getStmt());
4070 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004071};
Chris Lattnerc61089a2009-06-30 01:26:17 +00004072} // end anonymous namespace
4073
Aaron Ballmanff924b02013-11-18 20:11:50 +00004074static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00004075 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004076 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4077 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00004078 assert(S != nullptr && "Expecting non-null Stmt");
4079
Aaron Ballmanff924b02013-11-18 20:11:50 +00004080 // special printing for statement-expressions.
4081 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
4082 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00004083
Aaron Ballmanff924b02013-11-18 20:11:50 +00004084 if (Sub->children()) {
4085 OS << "({ ... ; ";
4086 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
4087 OS << " })\n";
4088 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004089 }
4090 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00004091 // special printing for comma expressions.
4092 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
4093 if (B->getOpcode() == BO_Comma) {
4094 OS << "... , ";
4095 Helper.handledStmt(B->getRHS(),OS);
4096 OS << '\n';
4097 return;
4098 }
4099 }
4100 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00004101
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004102 if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004103 OS << " (OperatorCall)";
Ted Kremenek0ffba932011-12-21 19:32:38 +00004104 }
4105 else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004106 OS << " (BindTemporary)";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004107 }
Ted Kremenek1a7648b2011-12-21 19:39:59 +00004108 else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
4109 OS << " (CXXConstructExpr, " << CCE->getType().getAsString() << ")";
4110 }
Ted Kremenek0ffba932011-12-21 19:32:38 +00004111 else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
4112 OS << " (" << CE->getStmtClassName() << ", "
4113 << CE->getCastKindName()
4114 << ", " << CE->getType().getAsString()
4115 << ")";
4116 }
Mike Stump31feda52009-07-17 01:31:16 +00004117
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004118 // Expressions need a newline.
4119 if (isa<Expr>(S))
4120 OS << '\n';
Ted Kremenek0f5d8bc2010-08-31 18:47:37 +00004121
David Blaikie00be69a2013-02-23 00:29:34 +00004122 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
4123 const CXXCtorInitializer *I = IE->getInitializer();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004124 if (I->isBaseInitializer())
4125 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
Jordan Rose69d0aed2013-10-22 23:19:47 +00004126 else if (I->isDelegatingInitializer())
4127 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
Francois Pichetd583da02010-12-04 09:14:42 +00004128 else OS << I->getAnyMember()->getName();
Mike Stump31feda52009-07-17 01:31:16 +00004129
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004130 OS << "(";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004131 if (Expr *IE = I->getInit())
Aaron Ballmanff924b02013-11-18 20:11:50 +00004132 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004133 OS << ")";
4134
4135 if (I->isBaseInitializer())
4136 OS << " (Base initializer)\n";
Jordan Rose69d0aed2013-10-22 23:19:47 +00004137 else if (I->isDelegatingInitializer())
4138 OS << " (Delegating initializer)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004139 else OS << " (Member initializer)\n";
4140
David Blaikie00be69a2013-02-23 00:29:34 +00004141 } else if (Optional<CFGAutomaticObjDtor> DE =
4142 E.getAs<CFGAutomaticObjDtor>()) {
4143 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00004144 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004145
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00004146 const Type* T = VD->getType().getTypePtr();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004147 if (const ReferenceType* RT = T->getAs<ReferenceType>())
4148 T = RT->getPointeeType().getTypePtr();
Richard Smithf676e452012-07-24 21:02:14 +00004149 T = T->getBaseElementTypeUnsafe();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004150
4151 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
4152 OS << " (Implicit destructor)\n";
Marcin Swiderski20b88732010-10-05 05:37:00 +00004153
Jordan Rosec9176072014-01-13 17:59:19 +00004154 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
4155 OS << "CFGNewAllocator(";
4156 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
4157 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
4158 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00004159 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
4160 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
4161 if (!RD)
4162 return;
4163 CXXDeleteExpr *DelExpr =
4164 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00004165 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00004166 OS << "->~" << RD->getName().str() << "()";
4167 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004168 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
4169 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004170 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004171 OS << " (Base object destructor)\n";
Marcin Swiderski20b88732010-10-05 05:37:00 +00004172
David Blaikie00be69a2013-02-23 00:29:34 +00004173 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
4174 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00004175 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004176 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00004177 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004178 OS << " (Member object destructor)\n";
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004179
David Blaikie00be69a2013-02-23 00:29:34 +00004180 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
4181 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00004182 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004183 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00004184 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004185 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004186}
Mike Stump31feda52009-07-17 01:31:16 +00004187
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004188static void print_block(raw_ostream &OS, const CFG* cfg,
4189 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00004190 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004191 bool ShowColors) {
Mike Stump31feda52009-07-17 01:31:16 +00004192
Aaron Ballmanff924b02013-11-18 20:11:50 +00004193 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00004194
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004195 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004196 if (ShowColors)
4197 OS.changeColor(raw_ostream::YELLOW, true);
4198
4199 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00004200
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004201 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004202 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004203 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004204 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004205 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004206 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00004207 else if (B.hasNoReturnElement())
4208 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004209 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00004210 OS << "]\n";
4211
4212 if (ShowColors)
4213 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00004214
Ted Kremenek71eca012007-08-29 23:20:49 +00004215 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004216 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004217
4218 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004219 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004220
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004221 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004222 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004223 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00004224 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004225 if (C->getLHS())
4226 C->getLHS()->printPretty(OS, &Helper,
4227 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004228 if (C->getRHS()) {
4229 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004230 C->getRHS()->printPretty(OS, &Helper,
4231 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004232 }
Mike Stump92244b02010-01-19 22:00:14 +00004233 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004234 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00004235 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004236 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00004237 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00004238 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00004239 0);
4240 else
4241 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004242 OS << ")";
4243
4244 } else
David Blaikie83d382b2011-09-23 05:06:16 +00004245 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00004246
Ted Kremenek71eca012007-08-29 23:20:49 +00004247 OS << ":\n";
4248 }
Mike Stump31feda52009-07-17 01:31:16 +00004249
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004250 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004251 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00004252
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004253 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
4254 I != E ; ++I, ++j ) {
Mike Stump31feda52009-07-17 01:31:16 +00004255
Ted Kremenek71eca012007-08-29 23:20:49 +00004256 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004257 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004258 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004259
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004260 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00004261
Aaron Ballmanff924b02013-11-18 20:11:50 +00004262 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00004263
Ted Kremenek72be32a2011-12-22 23:33:52 +00004264 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004265 }
Mike Stump31feda52009-07-17 01:31:16 +00004266
Ted Kremenek71eca012007-08-29 23:20:49 +00004267 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004268 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00004269 if (ShowColors)
4270 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00004271
Ted Kremenek72be32a2011-12-22 23:33:52 +00004272 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00004273
Aaron Ballmanff924b02013-11-18 20:11:50 +00004274 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00004275
Aaron Ballmanff924b02013-11-18 20:11:50 +00004276 PrintingPolicy PP(Helper.getLangOpts());
4277 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00004278 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004279 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00004280
4281 if (ShowColors)
4282 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004283 }
Mike Stump31feda52009-07-17 01:31:16 +00004284
Ted Kremenek71eca012007-08-29 23:20:49 +00004285 if (print_edges) {
4286 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004287 if (!B.pred_empty()) {
4288 const raw_ostream::Colors Color = raw_ostream::BLUE;
4289 if (ShowColors)
4290 OS.changeColor(Color);
4291 OS << " Preds " ;
4292 if (ShowColors)
4293 OS.resetColor();
4294 OS << '(' << B.pred_size() << "):";
4295 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00004296
Ted Kremenek72be32a2011-12-22 23:33:52 +00004297 if (ShowColors)
4298 OS.changeColor(Color);
4299
4300 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
4301 I != E; ++I, ++i) {
Mike Stump31feda52009-07-17 01:31:16 +00004302
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004303 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004304 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00004305
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004306 CFGBlock *B = *I;
4307 bool Reachable = true;
4308 if (!B) {
4309 Reachable = false;
4310 B = I->getPossiblyUnreachableBlock();
4311 }
4312
4313 OS << " B" << B->getBlockID();
4314 if (!Reachable)
4315 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00004316 }
4317
4318 if (ShowColors)
4319 OS.resetColor();
4320
4321 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00004322 }
Mike Stump31feda52009-07-17 01:31:16 +00004323
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004324 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004325 if (!B.succ_empty()) {
4326 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
4327 if (ShowColors)
4328 OS.changeColor(Color);
4329 OS << " Succs ";
4330 if (ShowColors)
4331 OS.resetColor();
4332 OS << '(' << B.succ_size() << "):";
4333 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004334
Ted Kremenek72be32a2011-12-22 23:33:52 +00004335 if (ShowColors)
4336 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00004337
Ted Kremenek72be32a2011-12-22 23:33:52 +00004338 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
4339 I != E; ++I, ++i) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004340
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004341 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004342 OS << "\n ";
4343
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004344 CFGBlock *B = *I;
4345
4346 bool Reachable = true;
4347 if (!B) {
4348 Reachable = false;
4349 B = I->getPossiblyUnreachableBlock();
4350 }
4351
4352 if (B) {
4353 OS << " B" << B->getBlockID();
4354 if (!Reachable)
4355 OS << "(Unreachable)";
4356 }
4357 else {
4358 OS << " NULL";
4359 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00004360 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004361
Ted Kremenek72be32a2011-12-22 23:33:52 +00004362 if (ShowColors)
4363 OS.resetColor();
4364 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004365 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004366 }
Mike Stump31feda52009-07-17 01:31:16 +00004367}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004368
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004369
4370/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004371void CFG::dump(const LangOptions &LO, bool ShowColors) const {
4372 print(llvm::errs(), LO, ShowColors);
4373}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004374
4375/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004376void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00004377 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00004378
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004379 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00004380 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00004381
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004382 // Iterate through the CFGBlocks and print them one by one.
4383 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
4384 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004385 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004386 continue;
Mike Stump31feda52009-07-17 01:31:16 +00004387
Aaron Ballmanff924b02013-11-18 20:11:50 +00004388 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004389 }
Mike Stump31feda52009-07-17 01:31:16 +00004390
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004391 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00004392 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00004393 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00004394 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00004395}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004396
4397/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004398void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
4399 bool ShowColors) const {
4400 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00004401}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004402
Anna Zaksa6fea132014-06-13 23:47:38 +00004403void CFGBlock::dump() const {
4404 dump(getParent(), LangOptions(), false);
4405}
4406
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004407/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
4408/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004409void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004410 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00004411 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00004412 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00004413 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00004414}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004415
Ted Kremenek15647632008-01-30 23:02:42 +00004416/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004417void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00004418 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00004419 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00004420 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004421}
4422
Ted Kremenekec3bbf42014-03-29 00:35:20 +00004423Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00004424 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004425 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00004426 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004427
Craig Topper25542942014-05-20 04:30:07 +00004428 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004429
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004430 switch (Terminator->getStmtClass()) {
4431 default:
4432 break;
Mike Stump31feda52009-07-17 01:31:16 +00004433
Jordan Rosecf10ea82013-06-06 21:53:45 +00004434 case Stmt::CXXForRangeStmtClass:
4435 E = cast<CXXForRangeStmt>(Terminator)->getCond();
4436 break;
4437
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004438 case Stmt::ForStmtClass:
4439 E = cast<ForStmt>(Terminator)->getCond();
4440 break;
Mike Stump31feda52009-07-17 01:31:16 +00004441
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004442 case Stmt::WhileStmtClass:
4443 E = cast<WhileStmt>(Terminator)->getCond();
4444 break;
Mike Stump31feda52009-07-17 01:31:16 +00004445
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004446 case Stmt::DoStmtClass:
4447 E = cast<DoStmt>(Terminator)->getCond();
4448 break;
Mike Stump31feda52009-07-17 01:31:16 +00004449
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004450 case Stmt::IfStmtClass:
4451 E = cast<IfStmt>(Terminator)->getCond();
4452 break;
Mike Stump31feda52009-07-17 01:31:16 +00004453
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004454 case Stmt::ChooseExprClass:
4455 E = cast<ChooseExpr>(Terminator)->getCond();
4456 break;
Mike Stump31feda52009-07-17 01:31:16 +00004457
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004458 case Stmt::IndirectGotoStmtClass:
4459 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
4460 break;
Mike Stump31feda52009-07-17 01:31:16 +00004461
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004462 case Stmt::SwitchStmtClass:
4463 E = cast<SwitchStmt>(Terminator)->getCond();
4464 break;
Mike Stump31feda52009-07-17 01:31:16 +00004465
John McCallc07a0c72011-02-17 10:25:35 +00004466 case Stmt::BinaryConditionalOperatorClass:
4467 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
4468 break;
4469
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004470 case Stmt::ConditionalOperatorClass:
4471 E = cast<ConditionalOperator>(Terminator)->getCond();
4472 break;
Mike Stump31feda52009-07-17 01:31:16 +00004473
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004474 case Stmt::BinaryOperatorClass: // '&&' and '||'
4475 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00004476 break;
Mike Stump31feda52009-07-17 01:31:16 +00004477
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00004478 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00004479 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004480 }
Mike Stump31feda52009-07-17 01:31:16 +00004481
Ted Kremenekec3bbf42014-03-29 00:35:20 +00004482 if (!StripParens)
4483 return E;
4484
Craig Topper25542942014-05-20 04:30:07 +00004485 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004486}
4487
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004488//===----------------------------------------------------------------------===//
4489// CFG Graphviz Visualization
4490//===----------------------------------------------------------------------===//
4491
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004492
4493#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00004494static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004495#endif
4496
Chris Lattnerc61089a2009-06-30 01:26:17 +00004497void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004498#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00004499 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004500 GraphHelper = &H;
4501 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00004502 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004503#endif
4504}
4505
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004506namespace llvm {
4507template<>
4508struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Tobias Grosser9fc223a2009-11-30 14:16:05 +00004509
4510 DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
4511
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004512 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004513
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00004514#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004515 std::string OutSStr;
4516 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00004517 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004518 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004519
4520 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
4521
4522 // Process string output to make it nicer...
4523 for (unsigned i = 0; i != OutStr.length(); ++i)
4524 if (OutStr[i] == '\n') { // Left justify
4525 OutStr[i] = '\\';
4526 OutStr.insert(OutStr.begin()+i+1, 'l');
4527 }
Mike Stump31feda52009-07-17 01:31:16 +00004528
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004529 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00004530#else
4531 return "";
4532#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004533 }
4534};
4535} // end namespace llvm