blob: 278df139f609d4abbd7e665ebb94bdac2c91b1ea [file] [log] [blame]
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001//===--- CFG.cpp - Classes for representing and building CFGs----*- C++ -*-===//
2//
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 Kremenekb1c170e2009-07-22 21:45:16 +000015#include "clang/Analysis/Support/SaveAndRestore.h"
Ted Kremenek6796fbd2009-07-16 18:13:04 +000016#include "clang/Analysis/CFG.h"
Mike Stump6bf1c082010-01-21 02:21:40 +000017#include "clang/AST/DeclCXX.h"
Ted Kremenek1b8ac852007-08-21 22:06:14 +000018#include "clang/AST/StmtVisitor.h"
Ted Kremenek04f3cee2007-08-31 21:30:12 +000019#include "clang/AST/PrettyPrinter.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000020#include "llvm/Support/GraphWriter.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000021#include "llvm/Support/Allocator.h"
22#include "llvm/Support/Format.h"
Ted Kremenek8a632182007-08-21 23:26:17 +000023#include "llvm/ADT/DenseMap.h"
Ted Kremenekeda180e22007-08-28 19:26:49 +000024#include "llvm/ADT/SmallPtrSet.h"
Ted Kremenek8aed4902009-10-20 23:46:25 +000025#include "llvm/ADT/OwningPtr.h"
Ted Kremeneke5ccf9a2008-01-11 00:40:29 +000026
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +000027using namespace clang;
28
29namespace {
30
Douglas Gregor6e6ad602009-01-20 01:17:11 +000031static SourceLocation GetEndLoc(Decl* D) {
Ted Kremenek8889bb32008-08-06 23:20:50 +000032 if (VarDecl* VD = dyn_cast<VarDecl>(D))
33 if (Expr* Ex = VD->getInit())
34 return Ex->getSourceRange().getEnd();
Mike Stump31feda52009-07-17 01:31:16 +000035
36 return D->getLocation();
Ted Kremenek8889bb32008-08-06 23:20:50 +000037}
Ted Kremenekdc03bd02010-08-02 23:46:59 +000038
Ted Kremenek4cad5fc2009-12-16 03:18:58 +000039class AddStmtChoice {
40public:
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +000041 enum Kind { NotAlwaysAdd = 0,
42 AlwaysAdd = 1,
43 AsLValueNotAlwaysAdd = 2,
44 AlwaysAddAsLValue = 3 };
45
Benjamin Kramera3b13412010-03-03 16:28:47 +000046 AddStmtChoice(Kind kind) : k(kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +000047
Benjamin Kramera3b13412010-03-03 16:28:47 +000048 bool alwaysAdd() const { return (unsigned)k & 0x1; }
Ted Kremenek66de6032010-04-11 17:02:04 +000049 bool asLValue() const { return k >= AsLValueNotAlwaysAdd; }
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +000050
Ted Kremenek4cad5fc2009-12-16 03:18:58 +000051private:
Benjamin Kramera3b13412010-03-03 16:28:47 +000052 Kind k;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +000053};
Mike Stump31feda52009-07-17 01:31:16 +000054
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +000055/// LocalScope - Node in tree of local scopes created for C++ implicit
56/// destructor calls generation. It contains list of automatic variables
57/// declared in the scope and link to position in previous scope this scope
58/// began in.
59///
60/// The process of creating local scopes is as follows:
61/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
62/// - Before processing statements in scope (e.g. CompoundStmt) create
63/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
64/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +000065/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +000066/// at this VarDecl,
67/// - For every normal (without jump) end of scope add to CFGBlock destructors
68/// for objects in the current scope,
69/// - For every jump add to CFGBlock destructors for objects
70/// between CFGBuilder::ScopePos and local scope position saved for jump
71/// target. Thanks to C++ restrictions on goto jumps we can be sure that
72/// jump target position will be on the path to root from CFGBuilder::ScopePos
73/// (adding any variable that doesn't need constructor to be called to
74/// LocalScope can break this assumption),
75///
76class LocalScope {
77public:
78 typedef llvm::SmallVector<VarDecl*, 4> AutomaticVarsTy;
79
80 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +000081 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +000082 class const_iterator {
83 const LocalScope* Scope;
84
85 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
86 /// Invalid iterator (with null Scope) has VarIter equal to 0.
87 unsigned VarIter;
88
89 public:
90 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
91 /// Incrementing invalid iterator is allowed and will result in invalid
92 /// iterator.
93 const_iterator()
94 : Scope(NULL), VarIter(0) {}
95
96 /// Create valid iterator. In case when S.Prev is an invalid iterator and
97 /// I is equal to 0, this will create invalid iterator.
98 const_iterator(const LocalScope& S, unsigned I)
99 : Scope(&S), VarIter(I) {
100 // Iterator to "end" of scope is not allowed. Handle it by going up
101 // in scopes tree possibly up to invalid iterator in the root.
102 if (VarIter == 0 && Scope)
103 *this = Scope->Prev;
104 }
105
106 VarDecl* const* operator->() const {
107 assert (Scope && "Dereferencing invalid iterator is not allowed");
108 assert (VarIter != 0 && "Iterator has invalid value of VarIter member");
109 return &Scope->Vars[VarIter - 1];
110 }
111 VarDecl* operator*() const {
112 return *this->operator->();
113 }
114
115 const_iterator& operator++() {
116 if (!Scope)
117 return *this;
118
119 assert (VarIter != 0 && "Iterator has invalid value of VarIter member");
120 --VarIter;
121 if (VarIter == 0)
122 *this = Scope->Prev;
123 return *this;
124 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000125 const_iterator operator++(int) {
126 const_iterator P = *this;
127 ++*this;
128 return P;
129 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000130
131 bool operator==(const const_iterator& rhs) const {
132 return Scope == rhs.Scope && VarIter == rhs.VarIter;
133 }
134 bool operator!=(const const_iterator& rhs) const {
135 return !(*this == rhs);
136 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000137
138 operator bool() const {
139 return *this != const_iterator();
140 }
141
142 int distance(const_iterator L);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000143 };
144
145 friend class const_iterator;
146
147private:
148 /// Automatic variables in order of declaration.
149 AutomaticVarsTy Vars;
150 /// Iterator to variable in previous scope that was declared just before
151 /// begin of this scope.
152 const_iterator Prev;
153
154public:
155 /// Constructs empty scope linked to previous scope in specified place.
156 LocalScope(const_iterator P)
157 : Vars()
158 , Prev(P) {}
159
160 /// Begin of scope in direction of CFG building (backwards).
161 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000162
163 void addVar(VarDecl* VD) {
164 Vars.push_back(VD);
165 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000166};
167
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000168/// distance - Calculates distance from this to L. L must be reachable from this
169/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
170/// number of scopes between this and L.
171int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
172 int D = 0;
173 const_iterator F = *this;
174 while (F.Scope != L.Scope) {
175 assert (F != const_iterator()
176 && "L iterator is not reachable from F iterator.");
177 D += F.VarIter;
178 F = F.Scope->Prev;
179 }
180 D += F.VarIter - L.VarIter;
181 return D;
182}
183
184/// BlockScopePosPair - Structure for specifying position in CFG during its
185/// build process. It consists of CFGBlock that specifies position in CFG graph
186/// and LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000187struct BlockScopePosPair {
188 BlockScopePosPair() {}
189 BlockScopePosPair(CFGBlock* B, LocalScope::const_iterator S)
190 : Block(B), ScopePos(S) {}
191
192 CFGBlock* Block;
193 LocalScope::const_iterator ScopePos;
194};
195
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000196/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000197/// The builder is stateful: an instance of the builder should be used to only
198/// construct a single CFG.
199///
200/// Example usage:
201///
202/// CFGBuilder builder;
203/// CFG* cfg = builder.BuildAST(stmt1);
204///
Mike Stump31feda52009-07-17 01:31:16 +0000205/// CFG construction is done via a recursive walk of an AST. We actually parse
206/// the AST in reverse order so that the successor of a basic block is
207/// constructed prior to its predecessor. This allows us to nicely capture
208/// implicit fall-throughs without extra basic blocks.
Ted Kremenek1b8ac852007-08-21 22:06:14 +0000209///
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000210class CFGBuilder {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000211 typedef BlockScopePosPair JumpTarget;
212 typedef BlockScopePosPair JumpSource;
213
Mike Stump0d76d072009-07-20 23:24:15 +0000214 ASTContext *Context;
Ted Kremenek8aed4902009-10-20 23:46:25 +0000215 llvm::OwningPtr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000216
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000217 CFGBlock* Block;
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000218 CFGBlock* Succ;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000219 JumpTarget ContinueJumpTarget;
220 JumpTarget BreakJumpTarget;
Ted Kremenek879d8e12007-08-23 18:43:24 +0000221 CFGBlock* SwitchTerminatedBlock;
Ted Kremenek654c78f2008-02-13 22:05:39 +0000222 CFGBlock* DefaultCaseBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +0000223 CFGBlock* TryTerminatedBlock;
Mike Stump31feda52009-07-17 01:31:16 +0000224
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000225 // Current position in local scope.
226 LocalScope::const_iterator ScopePos;
227
228 // LabelMap records the mapping from Label expressions to their jump targets.
229 typedef llvm::DenseMap<LabelStmt*, JumpTarget> LabelMapTy;
Ted Kremenek8a632182007-08-21 23:26:17 +0000230 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000231
232 // A list of blocks that end with a "goto" that must be backpatched to their
233 // resolved targets upon completion of CFG construction.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000234 typedef std::vector<JumpSource> BackpatchBlocksTy;
Ted Kremenek8a632182007-08-21 23:26:17 +0000235 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000236
Ted Kremenekeda180e22007-08-28 19:26:49 +0000237 // A list of labels whose address has been taken (for indirect gotos).
238 typedef llvm::SmallPtrSet<LabelStmt*,5> LabelSetTy;
239 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000240
Zhongxing Xud38fb842010-09-16 03:28:18 +0000241 bool badCFG;
242 CFG::BuildOptions BuildOpts;
243
Mike Stump31feda52009-07-17 01:31:16 +0000244public:
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000245 explicit CFGBuilder() : cfg(new CFG()), // crew a new CFG
246 Block(NULL), Succ(NULL),
Mike Stumpbbf5ba62010-01-19 02:20:09 +0000247 SwitchTerminatedBlock(NULL), DefaultCaseBlock(NULL),
Zhongxing Xud38fb842010-09-16 03:28:18 +0000248 TryTerminatedBlock(NULL), badCFG(false) {}
Mike Stump31feda52009-07-17 01:31:16 +0000249
Ted Kremenek9aae5132007-08-23 21:42:29 +0000250 // buildCFG - Used by external clients to construct the CFG.
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000251 CFG* buildCFG(const Decl *D, Stmt *Statement, ASTContext *C,
Ted Kremeneke97b1eb2010-09-14 23:41:16 +0000252 CFG::BuildOptions BO);
Mike Stump31feda52009-07-17 01:31:16 +0000253
Ted Kremenek93668002009-07-17 22:18:43 +0000254private:
255 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000256 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
257 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
258 CFGBlock *VisitBlockExpr(BlockExpr* E, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000259 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenekd2ba1f92010-04-11 17:01:59 +0000260 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
261 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
262 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Zhongxing Xu7e612172010-04-13 09:38:01 +0000263 CFGBlock *VisitCXXMemberCallExpr(CXXMemberCallExpr *C, AddStmtChoice asc);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000264 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000265 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000266 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000267 CFGBlock *VisitCompoundStmt(CompoundStmt *C);
Ted Kremenekd2ba1f92010-04-11 17:01:59 +0000268 CFGBlock *VisitConditionalOperator(ConditionalOperator *C, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000269 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek93668002009-07-17 22:18:43 +0000270 CFGBlock *VisitDeclStmt(DeclStmt *DS);
271 CFGBlock *VisitDeclSubExpr(Decl* D);
Ted Kremenek21822592009-07-17 18:20:32 +0000272 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
273 CFGBlock *VisitDoStmt(DoStmt *D);
274 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek93668002009-07-17 22:18:43 +0000275 CFGBlock *VisitGotoStmt(GotoStmt* G);
276 CFGBlock *VisitIfStmt(IfStmt *I);
277 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I);
278 CFGBlock *VisitLabelStmt(LabelStmt *L);
Ted Kremenek5868ec62010-04-11 17:02:10 +0000279 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000280 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S);
281 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S);
282 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S);
283 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S);
284 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S);
285 CFGBlock *VisitReturnStmt(ReturnStmt* R);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000286 CFGBlock *VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E, AddStmtChoice asc);
287 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000288 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
289 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000290
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000291 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd);
292 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000293 CFGBlock *VisitChildren(Stmt* S);
Mike Stump48871a22009-07-17 01:04:31 +0000294
Ted Kremenek6065ef62008-04-28 18:00:46 +0000295 // NYS == Not Yet Supported
296 CFGBlock* NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000297 badCFG = true;
298 return Block;
299 }
Mike Stump31feda52009-07-17 01:31:16 +0000300
Ted Kremenek93668002009-07-17 22:18:43 +0000301 void autoCreateBlock() { if (!Block) Block = createBlock(); }
302 CFGBlock *createBlock(bool add_successor = true);
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000303
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000304 CFGBlock *addStmt(Stmt *S) {
305 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000306 }
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000307
308 void addAutomaticObjDtors(LocalScope::const_iterator B,
309 LocalScope::const_iterator E, Stmt* S);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000310
Marcin Swiderski5e415732010-09-30 23:05:00 +0000311 // Local scopes creation.
312 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
313
Zhongxing Xu81714f22010-10-01 03:00:16 +0000314 void addLocalScopeForStmt(Stmt* S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000315 LocalScope* addLocalScopeForDeclStmt(DeclStmt* DS, LocalScope* Scope = NULL);
316 LocalScope* addLocalScopeForVarDecl(VarDecl* VD, LocalScope* Scope = NULL);
317
318 void addLocalScopeAndDtors(Stmt* S);
319
320 // Interface to CFGBlock - adding CFGElements.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000321 void AppendStmt(CFGBlock *B, Stmt *S,
322 AddStmtChoice asc = AddStmtChoice::AlwaysAdd) {
323 B->appendStmt(S, cfg->getBumpVectorContext(), asc.asLValue());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000324 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000325
Marcin Swiderski321a7072010-09-30 22:54:37 +0000326 void insertAutomaticObjDtors(CFGBlock* Blk, CFGBlock::iterator I,
327 LocalScope::const_iterator B, LocalScope::const_iterator E, Stmt* S);
328 void appendAutomaticObjDtors(CFGBlock* Blk, LocalScope::const_iterator B,
329 LocalScope::const_iterator E, Stmt* S);
330 void prependAutomaticObjDtorsWithTerminator(CFGBlock* Blk,
331 LocalScope::const_iterator B, LocalScope::const_iterator E);
332
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000333 void AddSuccessor(CFGBlock *B, CFGBlock *S) {
334 B->addSuccessor(S, cfg->getBumpVectorContext());
335 }
Mike Stump11289f42009-09-09 15:08:12 +0000336
Ted Kremenek963cc312009-07-24 06:55:42 +0000337 /// TryResult - a class representing a variant over the values
338 /// 'true', 'false', or 'unknown'. This is returned by TryEvaluateBool,
339 /// and is used by the CFGBuilder to decide if a branch condition
340 /// can be decided up front during CFG construction.
Ted Kremenek30754282009-07-24 04:47:11 +0000341 class TryResult {
342 int X;
343 public:
344 TryResult(bool b) : X(b ? 1 : 0) {}
345 TryResult() : X(-1) {}
Mike Stump11289f42009-09-09 15:08:12 +0000346
Ted Kremenek30754282009-07-24 04:47:11 +0000347 bool isTrue() const { return X == 1; }
348 bool isFalse() const { return X == 0; }
349 bool isKnown() const { return X >= 0; }
350 void negate() {
351 assert(isKnown());
352 X ^= 0x1;
353 }
354 };
Mike Stump11289f42009-09-09 15:08:12 +0000355
Mike Stump773582d2009-07-23 23:25:26 +0000356 /// TryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
357 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek30754282009-07-24 04:47:11 +0000358 TryResult TryEvaluateBool(Expr *S) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +0000359 if (!BuildOpts.PruneTriviallyFalseEdges)
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000360 return TryResult();
361
Mike Stump773582d2009-07-23 23:25:26 +0000362 Expr::EvalResult Result;
Douglas Gregor4c952882009-08-24 21:39:56 +0000363 if (!S->isTypeDependent() && !S->isValueDependent() &&
364 S->Evaluate(Result, *Context) && Result.Val.isInt())
Ted Kremenek963cc312009-07-24 06:55:42 +0000365 return Result.Val.getInt().getBoolValue();
Ted Kremenek30754282009-07-24 04:47:11 +0000366
367 return TryResult();
Mike Stump773582d2009-07-23 23:25:26 +0000368 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000369};
Mike Stump31feda52009-07-17 01:31:16 +0000370
Douglas Gregor4619e432008-12-05 23:32:09 +0000371// FIXME: Add support for dependent-sized array types in C++?
372// Does it even make sense to build a CFG for an uninstantiated template?
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000373static VariableArrayType* FindVA(Type* t) {
374 while (ArrayType* vt = dyn_cast<ArrayType>(t)) {
375 if (VariableArrayType* vat = dyn_cast<VariableArrayType>(vt))
376 if (vat->getSizeExpr())
377 return vat;
Mike Stump31feda52009-07-17 01:31:16 +0000378
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000379 t = vt->getElementType().getTypePtr();
380 }
Mike Stump31feda52009-07-17 01:31:16 +0000381
Ted Kremenekd86d39c2008-09-26 22:58:57 +0000382 return 0;
383}
Mike Stump31feda52009-07-17 01:31:16 +0000384
385/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
386/// arbitrary statement. Examples include a single expression or a function
387/// body (compound statement). The ownership of the returned CFG is
388/// transferred to the caller. If CFG construction fails, this method returns
389/// NULL.
Mike Stump6bf1c082010-01-21 02:21:40 +0000390CFG* CFGBuilder::buildCFG(const Decl *D, Stmt* Statement, ASTContext* C,
Ted Kremeneke97b1eb2010-09-14 23:41:16 +0000391 CFG::BuildOptions BO) {
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000392
Mike Stump0d76d072009-07-20 23:24:15 +0000393 Context = C;
Ted Kremenek8aed4902009-10-20 23:46:25 +0000394 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +0000395 if (!Statement)
396 return NULL;
Ted Kremenek9aae5132007-08-23 21:42:29 +0000397
Ted Kremeneke97b1eb2010-09-14 23:41:16 +0000398 BuildOpts = BO;
399 if (!C->getLangOptions().CPlusPlus)
400 BuildOpts.AddImplicitDtors = false;
Mike Stump31feda52009-07-17 01:31:16 +0000401
402 // Create an empty block that will serve as the exit block for the CFG. Since
403 // this is the first block added to the CFG, it will be implicitly registered
404 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +0000405 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000406 assert(Succ == &cfg->getExit());
Ted Kremenek81e14852007-08-27 19:46:09 +0000407 Block = NULL; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +0000408
Ted Kremenek9aae5132007-08-23 21:42:29 +0000409 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000410 CFGBlock *B = addStmt(Statement);
411
412 if (badCFG)
413 return NULL;
414
415 if (B)
416 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +0000417
418 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
419 // FIXME: Add code for base initializers and member initializers.
420 (void)CD;
421 }
Mike Stump31feda52009-07-17 01:31:16 +0000422
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000423 // Backpatch the gotos whose label -> block mappings we didn't know when we
424 // encountered them.
425 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
426 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +0000427
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000428 CFGBlock* B = I->Block;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000429 GotoStmt* G = cast<GotoStmt>(B->getTerminator());
430 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +0000431
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000432 // If there is no target for the goto, then we are looking at an
433 // incomplete AST. Handle this by not registering a successor.
434 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +0000435
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000436 JumpTarget JT = LI->second;
Marcin Swiderski667ffec2010-10-01 00:23:17 +0000437 prependAutomaticObjDtorsWithTerminator(B, I->ScopePos, JT.ScopePos);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000438 AddSuccessor(B, JT.Block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000439 }
440
441 // Add successors to the Indirect Goto Dispatch block (if we have one).
442 if (CFGBlock* B = cfg->getIndirectGotoBlock())
443 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
444 E = AddressTakenLabels.end(); I != E; ++I ) {
445
446 // Lookup the target block.
447 LabelMapTy::iterator LI = LabelMap.find(*I);
448
449 // If there is no target block that contains label, then we are looking
450 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +0000451 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000452
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000453 AddSuccessor(B, LI->second.Block);
Ted Kremenekeda180e22007-08-28 19:26:49 +0000454 }
Mike Stump31feda52009-07-17 01:31:16 +0000455
Mike Stump31feda52009-07-17 01:31:16 +0000456 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +0000457 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +0000458
Zhongxing Xub1e10aa2010-09-06 07:04:06 +0000459 return cfg.take();
Ted Kremenek9aae5132007-08-23 21:42:29 +0000460}
Mike Stump31feda52009-07-17 01:31:16 +0000461
Ted Kremenek9aae5132007-08-23 21:42:29 +0000462/// createBlock - Used to lazily create blocks that are connected
463/// to the current (global) succcessor.
Mike Stump31feda52009-07-17 01:31:16 +0000464CFGBlock* CFGBuilder::createBlock(bool add_successor) {
Ted Kremenek813dd672007-09-05 20:02:05 +0000465 CFGBlock* B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +0000466 if (add_successor && Succ)
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000467 AddSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +0000468 return B;
469}
Mike Stump31feda52009-07-17 01:31:16 +0000470
Marcin Swiderski5e415732010-09-30 23:05:00 +0000471/// addAutomaticObjDtors - Add to current block automatic objects destructors
472/// for objects in range of local scope positions. Use S as trigger statement
473/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000474void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
475 LocalScope::const_iterator E, Stmt* S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +0000476 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000477 return;
478
Marcin Swiderski5e415732010-09-30 23:05:00 +0000479 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000480 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +0000481
482 autoCreateBlock();
483 appendAutomaticObjDtors(Block, B, E, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000484}
485
486/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
487/// way return valid LocalScope object.
488LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
489 if (!Scope) {
490 Scope = cfg->getAllocator().Allocate<LocalScope>();
491 new (Scope) LocalScope(ScopePos);
492 }
493 return Scope;
494}
495
496/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +0000497/// that should create implicit scope (e.g. if/else substatements).
498void CFGBuilder::addLocalScopeForStmt(Stmt* S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +0000499 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu81714f22010-10-01 03:00:16 +0000500 return;
501
502 LocalScope *Scope = 0;
Marcin Swiderski5e415732010-09-30 23:05:00 +0000503
504 // For compound statement we will be creating explicit scope.
505 if (CompoundStmt* CS = dyn_cast<CompoundStmt>(S)) {
506 for (CompoundStmt::body_iterator BI = CS->body_begin(), BE = CS->body_end()
507 ; BI != BE; ++BI) {
508 Stmt* SI = *BI;
509 if (LabelStmt* LS = dyn_cast<LabelStmt>(SI))
510 SI = LS->getSubStmt();
511 if (DeclStmt* DS = dyn_cast<DeclStmt>(SI))
512 Scope = addLocalScopeForDeclStmt(DS, Scope);
513 }
Zhongxing Xu81714f22010-10-01 03:00:16 +0000514 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +0000515 }
516
517 // For any other statement scope will be implicit and as such will be
518 // interesting only for DeclStmt.
519 if (LabelStmt* LS = dyn_cast<LabelStmt>(S))
520 S = LS->getSubStmt();
521 if (DeclStmt* DS = dyn_cast<DeclStmt>(S))
Zhongxing Xu307701e2010-10-01 03:09:09 +0000522 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000523}
524
525/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
526/// reuse Scope if not NULL.
527LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt* DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +0000528 LocalScope* Scope) {
Marcin Swiderski5e415732010-09-30 23:05:00 +0000529 if (!BuildOpts.AddImplicitDtors)
530 return Scope;
531
532 for (DeclStmt::decl_iterator DI = DS->decl_begin(), DE = DS->decl_end()
533 ; DI != DE; ++DI) {
534 if (VarDecl* VD = dyn_cast<VarDecl>(*DI))
535 Scope = addLocalScopeForVarDecl(VD, Scope);
536 }
537 return Scope;
538}
539
540/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
541/// create add scope for automatic objects and temporary objects bound to
542/// const reference. Will reuse Scope if not NULL.
543LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl* VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +0000544 LocalScope* Scope) {
Marcin Swiderski5e415732010-09-30 23:05:00 +0000545 if (!BuildOpts.AddImplicitDtors)
546 return Scope;
547
548 // Check if variable is local.
549 switch (VD->getStorageClass()) {
550 case SC_None:
551 case SC_Auto:
552 case SC_Register:
553 break;
554 default: return Scope;
555 }
556
557 // Check for const references bound to temporary. Set type to pointee.
558 QualType QT = VD->getType();
559 if (const ReferenceType* RT = QT.getTypePtr()->getAs<ReferenceType>()) {
560 QT = RT->getPointeeType();
561 if (!QT.isConstQualified())
562 return Scope;
563 if (!VD->getInit() || !VD->getInit()->Classify(*Context).isRValue())
564 return Scope;
565 }
566
567 // Check if type is a C++ class with non-trivial destructor.
Marcin Swiderskie84cb972010-10-01 00:31:22 +0000568 if (const RecordType* RT = QT.getTypePtr()->getAs<RecordType>())
569 if (const CXXRecordDecl* CD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
Zhongxing Xuea360a32010-10-01 02:47:11 +0000570 if (!CD->hasTrivialDestructor()) {
571 // Add the variable to scope
572 Scope = createOrReuseLocalScope(Scope);
573 Scope->addVar(VD);
574 ScopePos = Scope->begin();
575 }
Marcin Swiderski5e415732010-09-30 23:05:00 +0000576 return Scope;
577}
578
579/// addLocalScopeAndDtors - For given statement add local scope for it and
580/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
581void CFGBuilder::addLocalScopeAndDtors(Stmt* S) {
582 if (!BuildOpts.AddImplicitDtors)
583 return;
584
585 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +0000586 addLocalScopeForStmt(S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000587 addAutomaticObjDtors(ScopePos, scopeBeginPos, S);
588}
589
Marcin Swiderski321a7072010-09-30 22:54:37 +0000590/// insertAutomaticObjDtors - Insert destructor CFGElements for variables with
591/// automatic storage duration to CFGBlock's elements vector. Insertion will be
592/// performed in place specified with iterator.
593void CFGBuilder::insertAutomaticObjDtors(CFGBlock* Blk, CFGBlock::iterator I,
594 LocalScope::const_iterator B, LocalScope::const_iterator E, Stmt* S) {
595 BumpVectorContext& C = cfg->getBumpVectorContext();
596 I = Blk->beginAutomaticObjDtorsInsert(I, B.distance(E), C);
597 while (B != E)
598 I = Blk->insertAutomaticObjDtor(I, *B++, S);
599}
600
601/// appendAutomaticObjDtors - Append destructor CFGElements for variables with
602/// automatic storage duration to CFGBlock's elements vector. Elements will be
603/// appended to physical end of the vector which happens to be logical
604/// beginning.
605void CFGBuilder::appendAutomaticObjDtors(CFGBlock* Blk,
606 LocalScope::const_iterator B, LocalScope::const_iterator E, Stmt* S) {
607 insertAutomaticObjDtors(Blk, Blk->begin(), B, E, S);
608}
609
610/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
611/// variables with automatic storage duration to CFGBlock's elements vector.
612/// Elements will be prepended to physical beginning of the vector which
613/// happens to be logical end. Use blocks terminator as statement that specifies
614/// destructors call site.
615void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock* Blk,
616 LocalScope::const_iterator B, LocalScope::const_iterator E) {
617 insertAutomaticObjDtors(Blk, Blk->end(), B, E, Blk->getTerminator());
618}
619
Ted Kremenek93668002009-07-17 22:18:43 +0000620/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +0000621/// blocks for ternary operators, &&, and ||. We also process "," and
622/// DeclStmts (which may contain nested control-flow).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000623CFGBlock* CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +0000624tryAgain:
Ted Kremenekbc1416d2010-04-30 22:25:53 +0000625 if (!S) {
626 badCFG = true;
627 return 0;
628 }
Ted Kremenek93668002009-07-17 22:18:43 +0000629 switch (S->getStmtClass()) {
630 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000631 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000632
633 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000634 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +0000635
Ted Kremenek93668002009-07-17 22:18:43 +0000636 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000637 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +0000638
Ted Kremenek93668002009-07-17 22:18:43 +0000639 case Stmt::BlockExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000640 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000641
Ted Kremenek93668002009-07-17 22:18:43 +0000642 case Stmt::BreakStmtClass:
643 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000644
Ted Kremenek93668002009-07-17 22:18:43 +0000645 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +0000646 case Stmt::CXXOperatorCallExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000647 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +0000648
Ted Kremenek93668002009-07-17 22:18:43 +0000649 case Stmt::CaseStmtClass:
650 return VisitCaseStmt(cast<CaseStmt>(S));
651
652 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000653 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +0000654
Ted Kremenek93668002009-07-17 22:18:43 +0000655 case Stmt::CompoundStmtClass:
656 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000657
Ted Kremenek93668002009-07-17 22:18:43 +0000658 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000659 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +0000660
Ted Kremenek93668002009-07-17 22:18:43 +0000661 case Stmt::ContinueStmtClass:
662 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000663
Ted Kremenekb27378c2010-01-19 20:40:33 +0000664 case Stmt::CXXCatchStmtClass:
665 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
666
Ted Kremenek82bfc862010-08-28 00:19:02 +0000667 case Stmt::CXXExprWithTemporariesClass: {
668 // FIXME: Handle temporaries. For now, just visit the subexpression
669 // so we don't artificially create extra blocks.
Ted Kremenek128d04d2010-08-31 18:47:34 +0000670 return Visit(cast<CXXExprWithTemporaries>(S)->getSubExpr(), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +0000671 }
672
Zhongxing Xu7e612172010-04-13 09:38:01 +0000673 case Stmt::CXXMemberCallExprClass:
674 return VisitCXXMemberCallExpr(cast<CXXMemberCallExpr>(S), asc);
675
Ted Kremenekb27378c2010-01-19 20:40:33 +0000676 case Stmt::CXXThrowExprClass:
677 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000678
Ted Kremenekb27378c2010-01-19 20:40:33 +0000679 case Stmt::CXXTryStmtClass:
680 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000681
Ted Kremenek93668002009-07-17 22:18:43 +0000682 case Stmt::DeclStmtClass:
683 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000684
Ted Kremenek93668002009-07-17 22:18:43 +0000685 case Stmt::DefaultStmtClass:
686 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000687
Ted Kremenek93668002009-07-17 22:18:43 +0000688 case Stmt::DoStmtClass:
689 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000690
Ted Kremenek93668002009-07-17 22:18:43 +0000691 case Stmt::ForStmtClass:
692 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000693
Ted Kremenek93668002009-07-17 22:18:43 +0000694 case Stmt::GotoStmtClass:
695 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000696
Ted Kremenek93668002009-07-17 22:18:43 +0000697 case Stmt::IfStmtClass:
698 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000699
Ted Kremenek93668002009-07-17 22:18:43 +0000700 case Stmt::IndirectGotoStmtClass:
701 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000702
Ted Kremenek93668002009-07-17 22:18:43 +0000703 case Stmt::LabelStmtClass:
704 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000705
Ted Kremenek5868ec62010-04-11 17:02:10 +0000706 case Stmt::MemberExprClass:
707 return VisitMemberExpr(cast<MemberExpr>(S), asc);
708
Ted Kremenek93668002009-07-17 22:18:43 +0000709 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +0000710 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
711
Ted Kremenek93668002009-07-17 22:18:43 +0000712 case Stmt::ObjCAtSynchronizedStmtClass:
713 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000714
Ted Kremenek93668002009-07-17 22:18:43 +0000715 case Stmt::ObjCAtThrowStmtClass:
716 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000717
Ted Kremenek93668002009-07-17 22:18:43 +0000718 case Stmt::ObjCAtTryStmtClass:
719 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000720
Ted Kremenek93668002009-07-17 22:18:43 +0000721 case Stmt::ObjCForCollectionStmtClass:
722 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000723
Ted Kremenek93668002009-07-17 22:18:43 +0000724 case Stmt::ParenExprClass:
725 S = cast<ParenExpr>(S)->getSubExpr();
Mike Stump11289f42009-09-09 15:08:12 +0000726 goto tryAgain;
727
Ted Kremenek93668002009-07-17 22:18:43 +0000728 case Stmt::NullStmtClass:
729 return Block;
Mike Stump11289f42009-09-09 15:08:12 +0000730
Ted Kremenek93668002009-07-17 22:18:43 +0000731 case Stmt::ReturnStmtClass:
732 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000733
Ted Kremenek93668002009-07-17 22:18:43 +0000734 case Stmt::SizeOfAlignOfExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000735 return VisitSizeOfAlignOfExpr(cast<SizeOfAlignOfExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +0000736
Ted Kremenek93668002009-07-17 22:18:43 +0000737 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000738 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +0000739
Ted Kremenek93668002009-07-17 22:18:43 +0000740 case Stmt::SwitchStmtClass:
741 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +0000742
Ted Kremenek93668002009-07-17 22:18:43 +0000743 case Stmt::WhileStmtClass:
744 return VisitWhileStmt(cast<WhileStmt>(S));
745 }
746}
Mike Stump11289f42009-09-09 15:08:12 +0000747
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000748CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
749 if (asc.alwaysAdd()) {
Ted Kremenek93668002009-07-17 22:18:43 +0000750 autoCreateBlock();
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000751 AppendStmt(Block, S, asc);
Mike Stump31feda52009-07-17 01:31:16 +0000752 }
Mike Stump11289f42009-09-09 15:08:12 +0000753
Ted Kremenek93668002009-07-17 22:18:43 +0000754 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +0000755}
Mike Stump31feda52009-07-17 01:31:16 +0000756
Ted Kremenek93668002009-07-17 22:18:43 +0000757/// VisitChildren - Visit the children of a Stmt.
758CFGBlock *CFGBuilder::VisitChildren(Stmt* Terminator) {
759 CFGBlock *B = Block;
Mike Stumpd8ba7a22009-02-26 08:00:25 +0000760 for (Stmt::child_iterator I = Terminator->child_begin(),
Ted Kremenek93668002009-07-17 22:18:43 +0000761 E = Terminator->child_end(); I != E; ++I) {
762 if (*I) B = Visit(*I);
763 }
Ted Kremenek9e248872007-08-27 21:27:44 +0000764 return B;
765}
Mike Stump11289f42009-09-09 15:08:12 +0000766
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000767CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
768 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +0000769 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +0000770
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000771 if (asc.alwaysAdd()) {
Ted Kremenek93668002009-07-17 22:18:43 +0000772 autoCreateBlock();
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000773 AppendStmt(Block, A, asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000774 }
Ted Kremenek81e14852007-08-27 19:46:09 +0000775
Ted Kremenek9aae5132007-08-23 21:42:29 +0000776 return Block;
777}
Mike Stump11289f42009-09-09 15:08:12 +0000778
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000779CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
780 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +0000781 if (B->isLogicalOp()) { // && or ||
Ted Kremenek93668002009-07-17 22:18:43 +0000782 CFGBlock* ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000783 AppendStmt(ConfluenceBlock, B, asc);
Mike Stump11289f42009-09-09 15:08:12 +0000784
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000785 if (badCFG)
Ted Kremenek93668002009-07-17 22:18:43 +0000786 return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000787
Ted Kremenek93668002009-07-17 22:18:43 +0000788 // create the block evaluating the LHS
789 CFGBlock* LHSBlock = createBlock(false);
790 LHSBlock->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +0000791
Ted Kremenek93668002009-07-17 22:18:43 +0000792 // create the block evaluating the RHS
793 Succ = ConfluenceBlock;
794 Block = NULL;
795 CFGBlock* RHSBlock = addStmt(B->getRHS());
Ted Kremenek989da5e2010-04-29 01:10:26 +0000796
797 if (RHSBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000798 if (badCFG)
Ted Kremenek989da5e2010-04-29 01:10:26 +0000799 return 0;
800 }
801 else {
802 // Create an empty block for cases where the RHS doesn't require
803 // any explicit statements in the CFG.
804 RHSBlock = createBlock();
805 }
Mike Stump11289f42009-09-09 15:08:12 +0000806
Mike Stump773582d2009-07-23 23:25:26 +0000807 // See if this is a known constant.
Ted Kremenek30754282009-07-24 04:47:11 +0000808 TryResult KnownVal = TryEvaluateBool(B->getLHS());
John McCalle3027922010-08-25 11:45:40 +0000809 if (KnownVal.isKnown() && (B->getOpcode() == BO_LOr))
Ted Kremenek30754282009-07-24 04:47:11 +0000810 KnownVal.negate();
Mike Stump773582d2009-07-23 23:25:26 +0000811
Ted Kremenek93668002009-07-17 22:18:43 +0000812 // Now link the LHSBlock with RHSBlock.
John McCalle3027922010-08-25 11:45:40 +0000813 if (B->getOpcode() == BO_LOr) {
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000814 AddSuccessor(LHSBlock, KnownVal.isTrue() ? NULL : ConfluenceBlock);
815 AddSuccessor(LHSBlock, KnownVal.isFalse() ? NULL : RHSBlock);
Mike Stump11289f42009-09-09 15:08:12 +0000816 } else {
John McCalle3027922010-08-25 11:45:40 +0000817 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000818 AddSuccessor(LHSBlock, KnownVal.isFalse() ? NULL : RHSBlock);
819 AddSuccessor(LHSBlock, KnownVal.isTrue() ? NULL : ConfluenceBlock);
Ted Kremenek93668002009-07-17 22:18:43 +0000820 }
Mike Stump11289f42009-09-09 15:08:12 +0000821
Ted Kremenek93668002009-07-17 22:18:43 +0000822 // Generate the blocks for evaluating the LHS.
823 Block = LHSBlock;
824 return addStmt(B->getLHS());
Mike Stump11289f42009-09-09 15:08:12 +0000825 }
John McCalle3027922010-08-25 11:45:40 +0000826 else if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +0000827 autoCreateBlock();
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000828 AppendStmt(Block, B, asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000829 addStmt(B->getRHS());
830 return addStmt(B->getLHS());
831 }
Zhongxing Xu41cdf582010-06-03 06:23:18 +0000832 else if (B->isAssignmentOp()) {
833 if (asc.alwaysAdd()) {
834 autoCreateBlock();
835 AppendStmt(Block, B, asc);
836 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000837
Ted Kremenek8abff772010-09-14 01:13:32 +0000838 // If visiting RHS causes us to finish 'Block' and the LHS doesn't
839 // create a new block, then we should return RBlock. Otherwise
840 // we'll incorrectly return NULL.
841 CFGBlock *RBlock = Visit(B->getRHS());
842 CFGBlock *LBlock = Visit(B->getLHS(), AddStmtChoice::AsLValueNotAlwaysAdd);
843 return LBlock ? LBlock : RBlock;
Zhongxing Xu41cdf582010-06-03 06:23:18 +0000844 }
Mike Stump11289f42009-09-09 15:08:12 +0000845
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000846 return VisitStmt(B, asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000847}
848
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000849CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
850 if (asc.alwaysAdd()) {
Ted Kremenek470bfa42009-11-25 01:34:30 +0000851 autoCreateBlock();
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000852 AppendStmt(Block, E, asc);
Ted Kremenek470bfa42009-11-25 01:34:30 +0000853 }
854 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +0000855}
856
Ted Kremenek93668002009-07-17 22:18:43 +0000857CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
858 // "break" is a control-flow statement. Thus we stop processing the current
859 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000860 if (badCFG)
861 return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000862
Ted Kremenek93668002009-07-17 22:18:43 +0000863 // Now create a new block that ends with the break statement.
864 Block = createBlock(false);
865 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +0000866
Ted Kremenek93668002009-07-17 22:18:43 +0000867 // If there is no target for the break, then we are looking at an incomplete
868 // AST. This means that the CFG cannot be constructed.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000869 if (BreakJumpTarget.Block) {
Marcin Swiderski667ffec2010-10-01 00:23:17 +0000870 addAutomaticObjDtors(ScopePos, BreakJumpTarget.ScopePos, B);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000871 AddSuccessor(Block, BreakJumpTarget.Block);
872 } else
Ted Kremenek93668002009-07-17 22:18:43 +0000873 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +0000874
875
Ted Kremenek9aae5132007-08-23 21:42:29 +0000876 return Block;
877}
Mike Stump11289f42009-09-09 15:08:12 +0000878
Mike Stump04c68512010-01-21 15:20:48 +0000879static bool CanThrow(Expr *E) {
880 QualType Ty = E->getType();
881 if (Ty->isFunctionPointerType())
882 Ty = Ty->getAs<PointerType>()->getPointeeType();
883 else if (Ty->isBlockPointerType())
884 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000885
Mike Stump04c68512010-01-21 15:20:48 +0000886 const FunctionType *FT = Ty->getAs<FunctionType>();
887 if (FT) {
888 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
889 if (Proto->hasEmptyExceptionSpec())
890 return false;
891 }
892 return true;
893}
894
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000895CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +0000896 // If this is a call to a no-return function, this stops the block here.
Mike Stump8c5d7992009-07-25 21:26:53 +0000897 bool NoReturn = false;
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000898 if (getFunctionExtInfo(*C->getCallee()->getType()).getNoReturn()) {
Mike Stump8c5d7992009-07-25 21:26:53 +0000899 NoReturn = true;
Ted Kremenek93668002009-07-17 22:18:43 +0000900 }
Mike Stump8c5d7992009-07-25 21:26:53 +0000901
Mike Stump04c68512010-01-21 15:20:48 +0000902 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +0000903
904 // Languages without exceptions are assumed to not throw.
905 if (Context->getLangOptions().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +0000906 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +0000907 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +0000908 }
909
910 if (FunctionDecl *FD = C->getDirectCallee()) {
Mike Stump8c5d7992009-07-25 21:26:53 +0000911 if (FD->hasAttr<NoReturnAttr>())
912 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +0000913 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +0000914 AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +0000915 }
Mike Stump8c5d7992009-07-25 21:26:53 +0000916
Mike Stump04c68512010-01-21 15:20:48 +0000917 if (!CanThrow(C->getCallee()))
918 AddEHEdge = false;
919
Zhongxing Xu41cdf582010-06-03 06:23:18 +0000920 if (!NoReturn && !AddEHEdge) {
921 if (asc.asLValue())
922 return VisitStmt(C, AddStmtChoice::AlwaysAddAsLValue);
923 else
924 return VisitStmt(C, AddStmtChoice::AlwaysAdd);
925 }
Mike Stump11289f42009-09-09 15:08:12 +0000926
Mike Stump92244b02010-01-19 22:00:14 +0000927 if (Block) {
928 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000929 if (badCFG)
Mike Stump92244b02010-01-19 22:00:14 +0000930 return 0;
931 }
Mike Stump11289f42009-09-09 15:08:12 +0000932
Mike Stump92244b02010-01-19 22:00:14 +0000933 Block = createBlock(!NoReturn);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000934 AppendStmt(Block, C, asc);
Mike Stump8c5d7992009-07-25 21:26:53 +0000935
Mike Stump92244b02010-01-19 22:00:14 +0000936 if (NoReturn) {
937 // Wire this to the exit block directly.
938 AddSuccessor(Block, &cfg->getExit());
939 }
Mike Stump04c68512010-01-21 15:20:48 +0000940 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +0000941 // Add exceptional edges.
942 if (TryTerminatedBlock)
943 AddSuccessor(Block, TryTerminatedBlock);
944 else
945 AddSuccessor(Block, &cfg->getExit());
946 }
Mike Stump11289f42009-09-09 15:08:12 +0000947
Mike Stump8c5d7992009-07-25 21:26:53 +0000948 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +0000949}
Ted Kremenek9aae5132007-08-23 21:42:29 +0000950
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000951CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
952 AddStmtChoice asc) {
Ted Kremenek21822592009-07-17 18:20:32 +0000953 CFGBlock* ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000954 AppendStmt(ConfluenceBlock, C, asc);
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000955 if (badCFG)
Ted Kremenek21822592009-07-17 18:20:32 +0000956 return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000957
Ted Kremenek5868ec62010-04-11 17:02:10 +0000958 asc = asc.asLValue() ? AddStmtChoice::AlwaysAddAsLValue
959 : AddStmtChoice::AlwaysAdd;
960
Ted Kremenek21822592009-07-17 18:20:32 +0000961 Succ = ConfluenceBlock;
962 Block = NULL;
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000963 CFGBlock* LHSBlock = Visit(C->getLHS(), asc);
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000964 if (badCFG)
Ted Kremenek21822592009-07-17 18:20:32 +0000965 return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000966
Ted Kremenek21822592009-07-17 18:20:32 +0000967 Succ = ConfluenceBlock;
968 Block = NULL;
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000969 CFGBlock* RHSBlock = Visit(C->getRHS(), asc);
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000970 if (badCFG)
Ted Kremenek21822592009-07-17 18:20:32 +0000971 return 0;
Mike Stump11289f42009-09-09 15:08:12 +0000972
Ted Kremenek21822592009-07-17 18:20:32 +0000973 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +0000974 // See if this is a known constant.
Ted Kremenek30754282009-07-24 04:47:11 +0000975 const TryResult& KnownVal = TryEvaluateBool(C->getCond());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000976 AddSuccessor(Block, KnownVal.isFalse() ? NULL : LHSBlock);
977 AddSuccessor(Block, KnownVal.isTrue() ? NULL : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +0000978 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +0000979 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +0000980}
Mike Stump11289f42009-09-09 15:08:12 +0000981
982
983CFGBlock* CFGBuilder::VisitCompoundStmt(CompoundStmt* C) {
Marcin Swiderski667ffec2010-10-01 00:23:17 +0000984 addLocalScopeAndDtors(C);
Mike Stump11289f42009-09-09 15:08:12 +0000985 CFGBlock* LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +0000986
987 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
988 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +0000989 // If we hit a segment of code just containing ';' (NullStmts), we can
990 // get a null block back. In such cases, just use the LastBlock
991 if (CFGBlock *newBlock = addStmt(*I))
992 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +0000993
Ted Kremenekce499c22009-08-27 23:16:26 +0000994 if (badCFG)
995 return NULL;
Mike Stump11289f42009-09-09 15:08:12 +0000996 }
Mike Stump92244b02010-01-19 22:00:14 +0000997
Ted Kremenek93668002009-07-17 22:18:43 +0000998 return LastBlock;
999}
Mike Stump11289f42009-09-09 15:08:12 +00001000
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001001CFGBlock *CFGBuilder::VisitConditionalOperator(ConditionalOperator *C,
1002 AddStmtChoice asc) {
Ted Kremenek51d40b02009-07-17 18:15:54 +00001003 // Create the confluence block that will "merge" the results of the ternary
1004 // expression.
1005 CFGBlock* ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001006 AppendStmt(ConfluenceBlock, C, asc);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001007 if (badCFG)
Ted Kremenek51d40b02009-07-17 18:15:54 +00001008 return 0;
Mike Stump11289f42009-09-09 15:08:12 +00001009
Ted Kremenek5868ec62010-04-11 17:02:10 +00001010 asc = asc.asLValue() ? AddStmtChoice::AlwaysAddAsLValue
1011 : AddStmtChoice::AlwaysAdd;
1012
Ted Kremenek51d40b02009-07-17 18:15:54 +00001013 // Create a block for the LHS expression if there is an LHS expression. A
1014 // GCC extension allows LHS to be NULL, causing the condition to be the
1015 // value that is returned instead.
1016 // e.g: x ?: y is shorthand for: x ? x : y;
1017 Succ = ConfluenceBlock;
1018 Block = NULL;
1019 CFGBlock* LHSBlock = NULL;
1020 if (C->getLHS()) {
Zhongxing Xuea9fcff2010-06-03 06:43:23 +00001021 LHSBlock = Visit(C->getLHS(), asc);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001022 if (badCFG)
Ted Kremenek51d40b02009-07-17 18:15:54 +00001023 return 0;
1024 Block = NULL;
1025 }
Mike Stump11289f42009-09-09 15:08:12 +00001026
Ted Kremenek51d40b02009-07-17 18:15:54 +00001027 // Create the block for the RHS expression.
1028 Succ = ConfluenceBlock;
Zhongxing Xuea9fcff2010-06-03 06:43:23 +00001029 CFGBlock* RHSBlock = Visit(C->getRHS(), asc);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001030 if (badCFG)
Ted Kremenek51d40b02009-07-17 18:15:54 +00001031 return 0;
Mike Stump11289f42009-09-09 15:08:12 +00001032
Ted Kremenek51d40b02009-07-17 18:15:54 +00001033 // Create the block that will contain the condition.
1034 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00001035
Mike Stump773582d2009-07-23 23:25:26 +00001036 // See if this is a known constant.
Ted Kremenek30754282009-07-24 04:47:11 +00001037 const TryResult& KnownVal = TryEvaluateBool(C->getCond());
Mike Stump0d76d072009-07-20 23:24:15 +00001038 if (LHSBlock) {
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001039 AddSuccessor(Block, KnownVal.isFalse() ? NULL : LHSBlock);
Mike Stump0d76d072009-07-20 23:24:15 +00001040 } else {
Ted Kremenek30754282009-07-24 04:47:11 +00001041 if (KnownVal.isFalse()) {
Mike Stump0d76d072009-07-20 23:24:15 +00001042 // If we know the condition is false, add NULL as the successor for
1043 // the block containing the condition. In this case, the confluence
1044 // block will have just one predecessor.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001045 AddSuccessor(Block, 0);
Ted Kremenek30754282009-07-24 04:47:11 +00001046 assert(ConfluenceBlock->pred_size() == 1);
Mike Stump0d76d072009-07-20 23:24:15 +00001047 } else {
1048 // If we have no LHS expression, add the ConfluenceBlock as a direct
1049 // successor for the block containing the condition. Moreover, we need to
1050 // reverse the order of the predecessors in the ConfluenceBlock because
1051 // the RHSBlock will have been added to the succcessors already, and we
1052 // want the first predecessor to the the block containing the expression
1053 // for the case when the ternary expression evaluates to true.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001054 AddSuccessor(Block, ConfluenceBlock);
Ted Kremenek30754282009-07-24 04:47:11 +00001055 assert(ConfluenceBlock->pred_size() == 2);
Mike Stump0d76d072009-07-20 23:24:15 +00001056 std::reverse(ConfluenceBlock->pred_begin(),
1057 ConfluenceBlock->pred_end());
1058 }
Ted Kremenek51d40b02009-07-17 18:15:54 +00001059 }
Mike Stump11289f42009-09-09 15:08:12 +00001060
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001061 AddSuccessor(Block, KnownVal.isTrue() ? NULL : RHSBlock);
Ted Kremenek51d40b02009-07-17 18:15:54 +00001062 Block->setTerminator(C);
1063 return addStmt(C->getCond());
1064}
1065
Ted Kremenek93668002009-07-17 22:18:43 +00001066CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
1067 autoCreateBlock();
Mike Stump31feda52009-07-17 01:31:16 +00001068
Ted Kremenek93668002009-07-17 22:18:43 +00001069 if (DS->isSingleDecl()) {
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001070 AppendStmt(Block, DS);
Ted Kremenek93668002009-07-17 22:18:43 +00001071 return VisitDeclSubExpr(DS->getSingleDecl());
Ted Kremenekf6998822008-02-26 00:22:58 +00001072 }
Mike Stump11289f42009-09-09 15:08:12 +00001073
Ted Kremenek93668002009-07-17 22:18:43 +00001074 CFGBlock *B = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001075
Ted Kremenek93668002009-07-17 22:18:43 +00001076 // FIXME: Add a reverse iterator for DeclStmt to avoid this extra copy.
1077 typedef llvm::SmallVector<Decl*,10> BufTy;
1078 BufTy Buf(DS->decl_begin(), DS->decl_end());
Mike Stump11289f42009-09-09 15:08:12 +00001079
Ted Kremenek93668002009-07-17 22:18:43 +00001080 for (BufTy::reverse_iterator I = Buf.rbegin(), E = Buf.rend(); I != E; ++I) {
1081 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
1082 unsigned A = llvm::AlignOf<DeclStmt>::Alignment < 8
1083 ? 8 : llvm::AlignOf<DeclStmt>::Alignment;
Mike Stump11289f42009-09-09 15:08:12 +00001084
Ted Kremenek93668002009-07-17 22:18:43 +00001085 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
1086 // automatically freed with the CFG.
1087 DeclGroupRef DG(*I);
1088 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00001089 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00001090 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Mike Stump11289f42009-09-09 15:08:12 +00001091
Ted Kremenek93668002009-07-17 22:18:43 +00001092 // Append the fake DeclStmt to block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001093 AppendStmt(Block, DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00001094 B = VisitDeclSubExpr(D);
1095 }
Mike Stump11289f42009-09-09 15:08:12 +00001096
1097 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00001098}
Mike Stump11289f42009-09-09 15:08:12 +00001099
Ted Kremenek93668002009-07-17 22:18:43 +00001100/// VisitDeclSubExpr - Utility method to add block-level expressions for
1101/// initializers in Decls.
1102CFGBlock *CFGBuilder::VisitDeclSubExpr(Decl* D) {
1103 assert(Block);
Ted Kremenekf6998822008-02-26 00:22:58 +00001104
Ted Kremenek93668002009-07-17 22:18:43 +00001105 VarDecl *VD = dyn_cast<VarDecl>(D);
Mike Stump11289f42009-09-09 15:08:12 +00001106
Ted Kremenek93668002009-07-17 22:18:43 +00001107 if (!VD)
1108 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00001109
Ted Kremenek93668002009-07-17 22:18:43 +00001110 Expr *Init = VD->getInit();
Mike Stump11289f42009-09-09 15:08:12 +00001111
Ted Kremenek93668002009-07-17 22:18:43 +00001112 if (Init) {
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +00001113 AddStmtChoice::Kind k =
1114 VD->getType()->isReferenceType() ? AddStmtChoice::AsLValueNotAlwaysAdd
1115 : AddStmtChoice::NotAlwaysAdd;
1116 Visit(Init, AddStmtChoice(k));
Ted Kremenek93668002009-07-17 22:18:43 +00001117 }
Mike Stump11289f42009-09-09 15:08:12 +00001118
Ted Kremenek93668002009-07-17 22:18:43 +00001119 // If the type of VD is a VLA, then we must process its size expressions.
1120 for (VariableArrayType* VA = FindVA(VD->getType().getTypePtr()); VA != 0;
1121 VA = FindVA(VA->getElementType().getTypePtr()))
1122 Block = addStmt(VA->getSizeExpr());
Mike Stump11289f42009-09-09 15:08:12 +00001123
Marcin Swiderski667ffec2010-10-01 00:23:17 +00001124 // Remove variable from local scope.
1125 if (ScopePos && VD == *ScopePos)
1126 ++ScopePos;
1127
Ted Kremenek93668002009-07-17 22:18:43 +00001128 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001129}
1130
1131CFGBlock* CFGBuilder::VisitIfStmt(IfStmt* I) {
Mike Stump31feda52009-07-17 01:31:16 +00001132 // We may see an if statement in the middle of a basic block, or it may be the
1133 // first statement we are processing. In either case, we create a new basic
1134 // block. First, we create the blocks for the then...else statements, and
1135 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00001136 // middle of a block, we stop processing that block. That block is then the
1137 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00001138
Marcin Swiderskif883ade2010-10-01 00:52:17 +00001139 // Save local scope position because in case of condition variable ScopePos
1140 // won't be restored when traversing AST.
1141 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
1142
1143 // Create local scope for possible condition variable.
1144 // Store scope position. Add implicit destructor.
1145 if (VarDecl* VD = I->getConditionVariable()) {
1146 LocalScope::const_iterator BeginScopePos = ScopePos;
1147 addLocalScopeForVarDecl(VD);
1148 addAutomaticObjDtors(ScopePos, BeginScopePos, I);
1149 }
1150
Mike Stump31feda52009-07-17 01:31:16 +00001151 // The block we were proccessing is now finished. Make it the successor
1152 // block.
1153 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00001154 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001155 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001156 return 0;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001157 }
Mike Stump31feda52009-07-17 01:31:16 +00001158
Ted Kremenek0bcdc982009-07-17 18:04:55 +00001159 // Process the false branch.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001160 CFGBlock* ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00001161
Ted Kremenek9aae5132007-08-23 21:42:29 +00001162 if (Stmt* Else = I->getElse()) {
1163 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00001164
Ted Kremenek9aae5132007-08-23 21:42:29 +00001165 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00001166 // create a new basic block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001167 Block = NULL;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00001168
1169 // If branch is not a compound statement create implicit scope
1170 // and add destructors.
1171 if (!isa<CompoundStmt>(Else))
1172 addLocalScopeAndDtors(Else);
1173
Ted Kremenek93668002009-07-17 22:18:43 +00001174 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00001175
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00001176 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
1177 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00001178 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001179 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001180 return 0;
1181 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00001182 }
Mike Stump31feda52009-07-17 01:31:16 +00001183
Ted Kremenek0bcdc982009-07-17 18:04:55 +00001184 // Process the true branch.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001185 CFGBlock* ThenBlock;
1186 {
1187 Stmt* Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00001188 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001189 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00001190 Block = NULL;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00001191
1192 // If branch is not a compound statement create implicit scope
1193 // and add destructors.
1194 if (!isa<CompoundStmt>(Then))
1195 addLocalScopeAndDtors(Then);
1196
Ted Kremenek93668002009-07-17 22:18:43 +00001197 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00001198
Ted Kremenek1b379512009-04-01 03:52:47 +00001199 if (!ThenBlock) {
1200 // We can reach here if the "then" body has all NullStmts.
1201 // Create an empty block so we can distinguish between true and false
1202 // branches in path-sensitive analyses.
1203 ThenBlock = createBlock(false);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001204 AddSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00001205 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001206 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001207 return 0;
Mike Stump31feda52009-07-17 01:31:16 +00001208 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00001209 }
1210
Mike Stump31feda52009-07-17 01:31:16 +00001211 // Now create a new block containing the if statement.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001212 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00001213
Ted Kremenek9aae5132007-08-23 21:42:29 +00001214 // Set the terminator of the new block to the If statement.
1215 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00001216
Mike Stump773582d2009-07-23 23:25:26 +00001217 // See if this is a known constant.
Ted Kremenek30754282009-07-24 04:47:11 +00001218 const TryResult &KnownVal = TryEvaluateBool(I->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00001219
Ted Kremenek9aae5132007-08-23 21:42:29 +00001220 // Now add the successors.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001221 AddSuccessor(Block, KnownVal.isFalse() ? NULL : ThenBlock);
1222 AddSuccessor(Block, KnownVal.isTrue()? NULL : ElseBlock);
Mike Stump31feda52009-07-17 01:31:16 +00001223
1224 // Add the condition as the last statement in the new block. This may create
1225 // new blocks as the condition may contain control-flow. Any newly created
1226 // blocks will be pointed to be "Block".
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00001227 Block = addStmt(I->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001228
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00001229 // Finally, if the IfStmt contains a condition variable, add both the IfStmt
1230 // and the condition variable initialization to the CFG.
1231 if (VarDecl *VD = I->getConditionVariable()) {
1232 if (Expr *Init = VD->getInit()) {
1233 autoCreateBlock();
1234 AppendStmt(Block, I, AddStmtChoice::AlwaysAdd);
1235 addStmt(Init);
1236 }
1237 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001238
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00001239 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001240}
Mike Stump31feda52009-07-17 01:31:16 +00001241
1242
Ted Kremenek9aae5132007-08-23 21:42:29 +00001243CFGBlock* CFGBuilder::VisitReturnStmt(ReturnStmt* R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00001244 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001245 //
Mike Stump31feda52009-07-17 01:31:16 +00001246 // NOTE: If a "return" appears in the middle of a block, this means that the
1247 // code afterwards is DEAD (unreachable). We still keep a basic block
1248 // for that code; a simple "mark-and-sweep" from the entry block will be
1249 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001250
1251 // Create the new block.
1252 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00001253
Ted Kremenek9aae5132007-08-23 21:42:29 +00001254 // The Exit block is the only successor.
Marcin Swiderski667ffec2010-10-01 00:23:17 +00001255 addAutomaticObjDtors(ScopePos, LocalScope::const_iterator(), R);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001256 AddSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00001257
1258 // Add the return statement to the block. This may create new blocks if R
1259 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001260 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001261}
1262
1263CFGBlock* CFGBuilder::VisitLabelStmt(LabelStmt* L) {
1264 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00001265 addStmt(L->getSubStmt());
Ted Kremenekcab47bd2008-03-15 07:45:02 +00001266 CFGBlock* LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00001267
Ted Kremenek93668002009-07-17 22:18:43 +00001268 if (!LabelBlock) // This can happen when the body is empty, i.e.
1269 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00001270
Ted Kremenek93668002009-07-17 22:18:43 +00001271 assert(LabelMap.find(L) == LabelMap.end() && "label already in map");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001272 LabelMap[ L ] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00001273
1274 // Labels partition blocks, so this is the end of the basic block we were
1275 // processing (L is the block's label). Because this is label (and we have
1276 // already processed the substatement) there is no extra control-flow to worry
1277 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00001278 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001279 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001280 return 0;
Mike Stump31feda52009-07-17 01:31:16 +00001281
1282 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001283 Block = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001284
Ted Kremenek9aae5132007-08-23 21:42:29 +00001285 // This block is now the implicit successor of other blocks.
1286 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001287
Ted Kremenek9aae5132007-08-23 21:42:29 +00001288 return LabelBlock;
1289}
1290
1291CFGBlock* CFGBuilder::VisitGotoStmt(GotoStmt* G) {
Mike Stump31feda52009-07-17 01:31:16 +00001292 // Goto is a control-flow statement. Thus we stop processing the current
1293 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00001294
Ted Kremenek9aae5132007-08-23 21:42:29 +00001295 Block = createBlock(false);
1296 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00001297
1298 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001299 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001300
Ted Kremenek9aae5132007-08-23 21:42:29 +00001301 if (I == LabelMap.end())
1302 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001303 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
1304 else {
1305 JumpTarget JT = I->second;
Marcin Swiderski667ffec2010-10-01 00:23:17 +00001306 addAutomaticObjDtors(ScopePos, JT.ScopePos, G);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001307 AddSuccessor(Block, JT.Block);
1308 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00001309
Mike Stump31feda52009-07-17 01:31:16 +00001310 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001311}
1312
1313CFGBlock* CFGBuilder::VisitForStmt(ForStmt* F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00001314 CFGBlock* LoopSuccessor = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001315
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00001316 // Save local scope position because in case of condition variable ScopePos
1317 // won't be restored when traversing AST.
1318 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
1319
1320 // Create local scope for init statement and possible condition variable.
1321 // Add destructor for init statement and condition variable.
1322 // Store scope position for continue statement.
1323 if (Stmt* Init = F->getInit())
1324 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001325 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
1326
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00001327 if (VarDecl* VD = F->getConditionVariable())
1328 addLocalScopeForVarDecl(VD);
1329 LocalScope::const_iterator ContinueScopePos = ScopePos;
1330
1331 addAutomaticObjDtors(ScopePos, save_scope_pos.get(), F);
1332
Mike Stump014b3ea2009-07-21 01:12:51 +00001333 // "for" is a control-flow statement. Thus we stop processing the current
1334 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001335 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001336 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001337 return 0;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001338 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001339 } else
1340 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00001341
Ted Kremenek304a9532010-05-21 20:30:15 +00001342 // Save the current value for the break targets.
1343 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001344 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00001345 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00001346
Mike Stump31feda52009-07-17 01:31:16 +00001347 // Because of short-circuit evaluation, the condition of the loop can span
1348 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
1349 // evaluate the condition.
Ted Kremenek81e14852007-08-27 19:46:09 +00001350 CFGBlock* ExitConditionBlock = createBlock(false);
1351 CFGBlock* EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001352
Ted Kremenek81e14852007-08-27 19:46:09 +00001353 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00001354 ExitConditionBlock->setTerminator(F);
1355
1356 // Now add the actual condition to the condition block. Because the condition
1357 // itself may contain control-flow, new blocks may be created.
Ted Kremenek81e14852007-08-27 19:46:09 +00001358 if (Stmt* C = F->getCond()) {
1359 Block = ExitConditionBlock;
1360 EntryConditionBlock = addStmt(C);
Ted Kremenek7b31a612010-09-15 07:01:20 +00001361 assert(Block == EntryConditionBlock ||
1362 (Block == 0 && EntryConditionBlock == Succ));
Ted Kremenekec92f942009-12-24 01:49:06 +00001363
1364 // If this block contains a condition variable, add both the condition
1365 // variable and initializer to the CFG.
1366 if (VarDecl *VD = F->getConditionVariable()) {
1367 if (Expr *Init = VD->getInit()) {
1368 autoCreateBlock();
1369 AppendStmt(Block, F, AddStmtChoice::AlwaysAdd);
1370 EntryConditionBlock = addStmt(Init);
1371 assert(Block == EntryConditionBlock);
1372 }
1373 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001374
Ted Kremenek55957a82009-05-02 00:13:27 +00001375 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001376 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001377 return 0;
1378 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001379 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00001380
Mike Stump31feda52009-07-17 01:31:16 +00001381 // The condition block is the implicit successor for the loop body as well as
1382 // any code above the loop.
Ted Kremenek81e14852007-08-27 19:46:09 +00001383 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001384
Mike Stump773582d2009-07-23 23:25:26 +00001385 // See if this is a known constant.
Ted Kremenek30754282009-07-24 04:47:11 +00001386 TryResult KnownVal(true);
Mike Stump11289f42009-09-09 15:08:12 +00001387
Mike Stump773582d2009-07-23 23:25:26 +00001388 if (F->getCond())
1389 KnownVal = TryEvaluateBool(F->getCond());
1390
Ted Kremenek9aae5132007-08-23 21:42:29 +00001391 // Now create the loop body.
1392 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00001393 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00001394
Ted Kremenek304a9532010-05-21 20:30:15 +00001395 // Save the current values for Block, Succ, and continue targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001396 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
1397 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00001398
Ted Kremeneke9610502007-08-30 18:39:40 +00001399 // Create a new block to contain the (bottom) of the loop body.
1400 Block = NULL;
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00001401
1402 // Loop body should end with destructor of Condition variable (if any).
1403 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, F);
Mike Stump31feda52009-07-17 01:31:16 +00001404
Ted Kremenekb0746ca2008-09-04 21:48:47 +00001405 if (Stmt* I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00001406 // Generate increment code in its own basic block. This is the target of
1407 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00001408 Succ = addStmt(I);
Mike Stump31feda52009-07-17 01:31:16 +00001409 } else {
1410 // No increment code. Create a special, empty, block that is used as the
1411 // target block for "looping back" to the start of the loop.
Ted Kremenek902393b2009-04-28 00:51:56 +00001412 assert(Succ == EntryConditionBlock);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00001413 Succ = Block ? Block : createBlock();
Ted Kremenekb0746ca2008-09-04 21:48:47 +00001414 }
Mike Stump31feda52009-07-17 01:31:16 +00001415
Ted Kremenek902393b2009-04-28 00:51:56 +00001416 // Finish up the increment (or empty) block if it hasn't been already.
1417 if (Block) {
1418 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001419 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001420 return 0;
Ted Kremenek902393b2009-04-28 00:51:56 +00001421 Block = 0;
1422 }
Mike Stump31feda52009-07-17 01:31:16 +00001423
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00001424 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00001425
Ted Kremenek902393b2009-04-28 00:51:56 +00001426 // The starting block for the loop increment is the block that should
1427 // represent the 'loop target' for looping back to the start of the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001428 ContinueJumpTarget.Block->setLoopTarget(F);
Ted Kremenek902393b2009-04-28 00:51:56 +00001429
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00001430 // If body is not a compound statement create implicit scope
1431 // and add destructors.
1432 if (!isa<CompoundStmt>(F->getBody()))
1433 addLocalScopeAndDtors(F->getBody());
1434
Mike Stump31feda52009-07-17 01:31:16 +00001435 // Now populate the body block, and in the process create new blocks as we
1436 // walk the body of the loop.
Ted Kremenek93668002009-07-17 22:18:43 +00001437 CFGBlock* BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00001438
1439 if (!BodyBlock)
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001440 BodyBlock = ContinueJumpTarget.Block;//can happen for "for (...;...;...);"
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001441 else if (badCFG)
Ted Kremenek30754282009-07-24 04:47:11 +00001442 return 0;
Mike Stump31feda52009-07-17 01:31:16 +00001443
Ted Kremenek30754282009-07-24 04:47:11 +00001444 // This new body block is a successor to our "exit" condition block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001445 AddSuccessor(ExitConditionBlock, KnownVal.isFalse() ? NULL : BodyBlock);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001446 }
Mike Stump31feda52009-07-17 01:31:16 +00001447
Ted Kremenek30754282009-07-24 04:47:11 +00001448 // Link up the condition block with the code that follows the loop. (the
1449 // false branch).
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001450 AddSuccessor(ExitConditionBlock, KnownVal.isTrue() ? NULL : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00001451
Ted Kremenek9aae5132007-08-23 21:42:29 +00001452 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00001453 // statements. This block can also contain statements that precede the loop.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001454 if (Stmt* I = F->getInit()) {
1455 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00001456 return addStmt(I);
Mike Stump31feda52009-07-17 01:31:16 +00001457 } else {
1458 // There is no loop initialization. We are thus basically a while loop.
1459 // NULL out Block to force lazy block construction.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001460 Block = NULL;
Ted Kremeneka1523a32008-02-27 07:20:00 +00001461 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00001462 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001463 }
1464}
1465
Ted Kremenek5868ec62010-04-11 17:02:10 +00001466CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
1467 if (asc.alwaysAdd()) {
1468 autoCreateBlock();
1469 AppendStmt(Block, M, asc);
1470 }
1471 return Visit(M->getBase(),
1472 M->isArrow() ? AddStmtChoice::NotAlwaysAdd
1473 : AddStmtChoice::AsLValueNotAlwaysAdd);
1474}
1475
Ted Kremenek9d56e642008-11-11 17:10:00 +00001476CFGBlock* CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt* S) {
1477 // Objective-C fast enumeration 'for' statements:
1478 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
1479 //
1480 // for ( Type newVariable in collection_expression ) { statements }
1481 //
1482 // becomes:
1483 //
1484 // prologue:
1485 // 1. collection_expression
1486 // T. jump to loop_entry
1487 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001488 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00001489 // 1. ObjCForCollectionStmt [performs binding to newVariable]
1490 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
1491 // TB:
1492 // statements
1493 // T. jump to loop_entry
1494 // FB:
1495 // what comes after
1496 //
1497 // and
1498 //
1499 // Type existingItem;
1500 // for ( existingItem in expression ) { statements }
1501 //
1502 // becomes:
1503 //
Mike Stump31feda52009-07-17 01:31:16 +00001504 // the same with newVariable replaced with existingItem; the binding works
1505 // the same except that for one ObjCForCollectionStmt::getElement() returns
1506 // a DeclStmt and the other returns a DeclRefExpr.
Ted Kremenek9d56e642008-11-11 17:10:00 +00001507 //
Mike Stump31feda52009-07-17 01:31:16 +00001508
Ted Kremenek9d56e642008-11-11 17:10:00 +00001509 CFGBlock* LoopSuccessor = 0;
Mike Stump31feda52009-07-17 01:31:16 +00001510
Ted Kremenek9d56e642008-11-11 17:10:00 +00001511 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001512 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001513 return 0;
Ted Kremenek9d56e642008-11-11 17:10:00 +00001514 LoopSuccessor = Block;
1515 Block = 0;
Ted Kremenek93668002009-07-17 22:18:43 +00001516 } else
1517 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00001518
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001519 // Build the condition blocks.
1520 CFGBlock* ExitConditionBlock = createBlock(false);
1521 CFGBlock* EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001522
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001523 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00001524 ExitConditionBlock->setTerminator(S);
1525
1526 // The last statement in the block should be the ObjCForCollectionStmt, which
1527 // performs the actual binding to 'element' and determines if there are any
1528 // more items in the collection.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001529 AppendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001530 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001531
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001532 // Walk the 'element' expression to see if there are any side-effects. We
Mike Stump31feda52009-07-17 01:31:16 +00001533 // generate new blocks as necesary. We DON'T add the statement by default to
1534 // the CFG unless it contains control-flow.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001535 EntryConditionBlock = Visit(S->getElement(), AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00001536 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001537 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001538 return 0;
1539 Block = 0;
1540 }
Mike Stump31feda52009-07-17 01:31:16 +00001541
1542 // The condition block is the implicit successor for the loop body as well as
1543 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001544 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001545
Ted Kremenek9d56e642008-11-11 17:10:00 +00001546 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00001547 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001548 // Save the current values for Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001549 SaveAndRestore<CFGBlock*> save_Succ(Succ);
1550 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
1551 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00001552
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001553 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
1554 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00001555
Ted Kremenek93668002009-07-17 22:18:43 +00001556 CFGBlock* BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00001557
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001558 if (!BodyBlock)
1559 BodyBlock = EntryConditionBlock; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00001560 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001561 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001562 return 0;
1563 }
Mike Stump31feda52009-07-17 01:31:16 +00001564
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001565 // This new body block is a successor to our "exit" condition block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001566 AddSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001567 }
Mike Stump31feda52009-07-17 01:31:16 +00001568
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001569 // Link up the condition block with the code that follows the loop.
1570 // (the false branch).
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001571 AddSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001572
Ted Kremenek9d56e642008-11-11 17:10:00 +00001573 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00001574 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00001575 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00001576}
1577
Ted Kremenek49805452009-05-02 01:49:13 +00001578CFGBlock* CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt* S) {
1579 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00001580
Ted Kremenek49805452009-05-02 01:49:13 +00001581 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00001582 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00001583
Ted Kremenekb3c657b2009-05-05 23:11:51 +00001584 // The sync body starts its own basic block. This makes it a little easier
1585 // for diagnostic clients.
1586 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001587 if (badCFG)
Ted Kremenekb3c657b2009-05-05 23:11:51 +00001588 return 0;
Mike Stump31feda52009-07-17 01:31:16 +00001589
Ted Kremenekb3c657b2009-05-05 23:11:51 +00001590 Block = 0;
Ted Kremenekecc31c92010-05-13 16:38:08 +00001591 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00001592 }
Mike Stump31feda52009-07-17 01:31:16 +00001593
Ted Kremeneked12f1b2010-09-10 03:05:33 +00001594 // Add the @synchronized to the CFG.
1595 autoCreateBlock();
1596 AppendStmt(Block, S, AddStmtChoice::AlwaysAdd);
1597
Ted Kremenek49805452009-05-02 01:49:13 +00001598 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00001599 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00001600}
Mike Stump31feda52009-07-17 01:31:16 +00001601
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00001602CFGBlock* CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt* S) {
Ted Kremenek93668002009-07-17 22:18:43 +00001603 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00001604 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00001605}
Ted Kremenek9d56e642008-11-11 17:10:00 +00001606
Ted Kremenek9aae5132007-08-23 21:42:29 +00001607CFGBlock* CFGBuilder::VisitWhileStmt(WhileStmt* W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00001608 CFGBlock* LoopSuccessor = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001609
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00001610 // Save local scope position because in case of condition variable ScopePos
1611 // won't be restored when traversing AST.
1612 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
1613
1614 // Create local scope for possible condition variable.
1615 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001616 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00001617 if (VarDecl* VD = W->getConditionVariable()) {
1618 addLocalScopeForVarDecl(VD);
1619 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W);
1620 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001621
Mike Stump014b3ea2009-07-21 01:12:51 +00001622 // "while" is a control-flow statement. Thus we stop processing the current
1623 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001624 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001625 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001626 return 0;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001627 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001628 } else
1629 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00001630
1631 // Because of short-circuit evaluation, the condition of the loop can span
1632 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
1633 // evaluate the condition.
Ted Kremenek81e14852007-08-27 19:46:09 +00001634 CFGBlock* ExitConditionBlock = createBlock(false);
1635 CFGBlock* EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001636
Ted Kremenek81e14852007-08-27 19:46:09 +00001637 // Set the terminator for the "exit" condition block.
1638 ExitConditionBlock->setTerminator(W);
Mike Stump31feda52009-07-17 01:31:16 +00001639
1640 // Now add the actual condition to the condition block. Because the condition
1641 // itself may contain control-flow, new blocks may be created. Thus we update
1642 // "Succ" after adding the condition.
Ted Kremenek81e14852007-08-27 19:46:09 +00001643 if (Stmt* C = W->getCond()) {
1644 Block = ExitConditionBlock;
1645 EntryConditionBlock = addStmt(C);
Ted Kremenek49936f72009-04-28 03:09:44 +00001646 assert(Block == EntryConditionBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001647
Ted Kremenek1ce53c42009-12-24 01:34:10 +00001648 // If this block contains a condition variable, add both the condition
1649 // variable and initializer to the CFG.
1650 if (VarDecl *VD = W->getConditionVariable()) {
1651 if (Expr *Init = VD->getInit()) {
1652 autoCreateBlock();
1653 AppendStmt(Block, W, AddStmtChoice::AlwaysAdd);
1654 EntryConditionBlock = addStmt(Init);
1655 assert(Block == EntryConditionBlock);
1656 }
1657 }
1658
Ted Kremenek55957a82009-05-02 00:13:27 +00001659 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001660 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001661 return 0;
1662 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001663 }
Mike Stump31feda52009-07-17 01:31:16 +00001664
1665 // The condition block is the implicit successor for the loop body as well as
1666 // any code above the loop.
Ted Kremenek81e14852007-08-27 19:46:09 +00001667 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001668
Mike Stump773582d2009-07-23 23:25:26 +00001669 // See if this is a known constant.
Ted Kremenek30754282009-07-24 04:47:11 +00001670 const TryResult& KnownVal = TryEvaluateBool(W->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00001671
Ted Kremenek9aae5132007-08-23 21:42:29 +00001672 // Process the loop body.
1673 {
Ted Kremenek49936f72009-04-28 03:09:44 +00001674 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00001675
1676 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001677 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
1678 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
1679 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00001680
Mike Stump31feda52009-07-17 01:31:16 +00001681 // Create an empty block to represent the transition block for looping back
1682 // to the head of the loop.
Ted Kremenek49936f72009-04-28 03:09:44 +00001683 Block = 0;
1684 assert(Succ == EntryConditionBlock);
1685 Succ = createBlock();
1686 Succ->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001687 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00001688
Ted Kremenek9aae5132007-08-23 21:42:29 +00001689 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00001690 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00001691
Ted Kremenek9aae5132007-08-23 21:42:29 +00001692 // NULL out Block to force lazy instantiation of blocks for the body.
1693 Block = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001694
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00001695 // Loop body should end with destructor of Condition variable (if any).
1696 addAutomaticObjDtors(ScopePos, LoopBeginScopePos, W);
1697
1698 // If body is not a compound statement create implicit scope
1699 // and add destructors.
1700 if (!isa<CompoundStmt>(W->getBody()))
1701 addLocalScopeAndDtors(W->getBody());
1702
Ted Kremenek9aae5132007-08-23 21:42:29 +00001703 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00001704 CFGBlock* BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00001705
Ted Kremeneke9610502007-08-30 18:39:40 +00001706 if (!BodyBlock)
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001707 BodyBlock = ContinueJumpTarget.Block; // can happen for "while(...) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00001708 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001709 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001710 return 0;
1711 }
Mike Stump31feda52009-07-17 01:31:16 +00001712
Ted Kremenek30754282009-07-24 04:47:11 +00001713 // Add the loop body entry as a successor to the condition.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001714 AddSuccessor(ExitConditionBlock, KnownVal.isFalse() ? NULL : BodyBlock);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001715 }
Mike Stump31feda52009-07-17 01:31:16 +00001716
Ted Kremenek30754282009-07-24 04:47:11 +00001717 // Link up the condition block with the code that follows the loop. (the
1718 // false branch).
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001719 AddSuccessor(ExitConditionBlock, KnownVal.isTrue() ? NULL : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00001720
1721 // There can be no more statements in the condition block since we loop back
1722 // to this block. NULL out Block to force lazy creation of another block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001723 Block = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001724
Ted Kremenek1ce53c42009-12-24 01:34:10 +00001725 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00001726 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00001727 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001728}
Mike Stump11289f42009-09-09 15:08:12 +00001729
1730
Ted Kremenek93668002009-07-17 22:18:43 +00001731CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt* S) {
1732 // FIXME: For now we pretend that @catch and the code it contains does not
1733 // exit.
1734 return Block;
1735}
Mike Stump31feda52009-07-17 01:31:16 +00001736
Ted Kremenek93041ba2008-12-09 20:20:09 +00001737CFGBlock* CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt* S) {
1738 // FIXME: This isn't complete. We basically treat @throw like a return
1739 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00001740
Ted Kremenek0868eea2009-09-24 18:45:41 +00001741 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001742 if (badCFG)
Ted Kremenek93668002009-07-17 22:18:43 +00001743 return 0;
Mike Stump31feda52009-07-17 01:31:16 +00001744
Ted Kremenek93041ba2008-12-09 20:20:09 +00001745 // Create the new block.
1746 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00001747
Ted Kremenek93041ba2008-12-09 20:20:09 +00001748 // The Exit block is the only successor.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001749 AddSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00001750
1751 // Add the statement to the block. This may create new blocks if S contains
1752 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001753 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00001754}
Ted Kremenek9aae5132007-08-23 21:42:29 +00001755
Mike Stump8dd1b6b2009-07-22 22:56:04 +00001756CFGBlock* CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr* T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00001757 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001758 if (badCFG)
Mike Stump8dd1b6b2009-07-22 22:56:04 +00001759 return 0;
1760
1761 // Create the new block.
1762 Block = createBlock(false);
1763
Mike Stumpbbf5ba62010-01-19 02:20:09 +00001764 if (TryTerminatedBlock)
1765 // The current try statement is the only successor.
1766 AddSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001767 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00001768 // otherwise the Exit block is the only successor.
1769 AddSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00001770
1771 // Add the statement to the block. This may create new blocks if S contains
1772 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001773 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00001774}
1775
Ted Kremenek93668002009-07-17 22:18:43 +00001776CFGBlock *CFGBuilder::VisitDoStmt(DoStmt* D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00001777 CFGBlock* LoopSuccessor = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001778
Mike Stump8d50b6a2009-07-21 01:27:50 +00001779 // "do...while" is a control-flow statement. Thus we stop processing the
1780 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001781 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001782 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001783 return 0;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001784 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00001785 } else
1786 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00001787
1788 // Because of short-circuit evaluation, the condition of the loop can span
1789 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
1790 // evaluate the condition.
Ted Kremenek81e14852007-08-27 19:46:09 +00001791 CFGBlock* ExitConditionBlock = createBlock(false);
1792 CFGBlock* EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00001793
Ted Kremenek81e14852007-08-27 19:46:09 +00001794 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00001795 ExitConditionBlock->setTerminator(D);
1796
1797 // Now add the actual condition to the condition block. Because the condition
1798 // itself may contain control-flow, new blocks may be created.
Ted Kremenek81e14852007-08-27 19:46:09 +00001799 if (Stmt* C = D->getCond()) {
1800 Block = ExitConditionBlock;
1801 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00001802 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001803 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001804 return 0;
1805 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001806 }
Mike Stump31feda52009-07-17 01:31:16 +00001807
Ted Kremeneka1523a32008-02-27 07:20:00 +00001808 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00001809 Succ = EntryConditionBlock;
1810
Mike Stump773582d2009-07-23 23:25:26 +00001811 // See if this is a known constant.
Ted Kremenek30754282009-07-24 04:47:11 +00001812 const TryResult &KnownVal = TryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00001813
Ted Kremenek9aae5132007-08-23 21:42:29 +00001814 // Process the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00001815 CFGBlock* BodyBlock = NULL;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001816 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00001817 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00001818
Ted Kremenek9aae5132007-08-23 21:42:29 +00001819 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001820 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
1821 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
1822 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00001823
Ted Kremenek9aae5132007-08-23 21:42:29 +00001824 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001825 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00001826
Ted Kremenek9aae5132007-08-23 21:42:29 +00001827 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001828 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00001829
Ted Kremenek9aae5132007-08-23 21:42:29 +00001830 // NULL out Block to force lazy instantiation of blocks for the body.
1831 Block = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001832
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00001833 // If body is not a compound statement create implicit scope
1834 // and add destructors.
1835 if (!isa<CompoundStmt>(D->getBody()))
1836 addLocalScopeAndDtors(D->getBody());
1837
Ted Kremenek9aae5132007-08-23 21:42:29 +00001838 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00001839 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00001840
Ted Kremeneke9610502007-08-30 18:39:40 +00001841 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00001842 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00001843 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001844 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001845 return 0;
1846 }
Mike Stump31feda52009-07-17 01:31:16 +00001847
Ted Kremenek110974d2010-08-17 20:59:56 +00001848 if (!KnownVal.isFalse()) {
1849 // Add an intermediate block between the BodyBlock and the
1850 // ExitConditionBlock to represent the "loop back" transition. Create an
1851 // empty block to represent the transition block for looping back to the
1852 // head of the loop.
1853 // FIXME: Can we do this more efficiently without adding another block?
1854 Block = NULL;
1855 Succ = BodyBlock;
1856 CFGBlock *LoopBackBlock = createBlock();
1857 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00001858
Ted Kremenek110974d2010-08-17 20:59:56 +00001859 // Add the loop body entry as a successor to the condition.
1860 AddSuccessor(ExitConditionBlock, LoopBackBlock);
1861 }
1862 else
1863 AddSuccessor(ExitConditionBlock, NULL);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001864 }
Mike Stump31feda52009-07-17 01:31:16 +00001865
Ted Kremenek30754282009-07-24 04:47:11 +00001866 // Link up the condition block with the code that follows the loop.
1867 // (the false branch).
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001868 AddSuccessor(ExitConditionBlock, KnownVal.isTrue() ? NULL : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00001869
1870 // There can be no more statements in the body block(s) since we loop back to
1871 // the body. NULL out Block to force lazy creation of another block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001872 Block = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001873
Ted Kremenek9aae5132007-08-23 21:42:29 +00001874 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00001875 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001876 return BodyBlock;
1877}
1878
1879CFGBlock* CFGBuilder::VisitContinueStmt(ContinueStmt* C) {
1880 // "continue" is a control-flow statement. Thus we stop processing the
1881 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001882 if (badCFG)
1883 return 0;
Mike Stump31feda52009-07-17 01:31:16 +00001884
Ted Kremenek9aae5132007-08-23 21:42:29 +00001885 // Now create a new block that ends with the continue statement.
1886 Block = createBlock(false);
1887 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00001888
Ted Kremenek9aae5132007-08-23 21:42:29 +00001889 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00001890 // incomplete AST. This means the CFG cannot be constructed.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001891 if (ContinueJumpTarget.Block) {
Marcin Swiderski667ffec2010-10-01 00:23:17 +00001892 addAutomaticObjDtors(ScopePos, ContinueJumpTarget.ScopePos, C);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001893 AddSuccessor(Block, ContinueJumpTarget.Block);
1894 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00001895 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00001896
Ted Kremenek9aae5132007-08-23 21:42:29 +00001897 return Block;
1898}
Mike Stump11289f42009-09-09 15:08:12 +00001899
Ted Kremenek0747de62009-07-18 00:47:21 +00001900CFGBlock *CFGBuilder::VisitSizeOfAlignOfExpr(SizeOfAlignOfExpr *E,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001901 AddStmtChoice asc) {
Ted Kremenek0747de62009-07-18 00:47:21 +00001902
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001903 if (asc.alwaysAdd()) {
Ted Kremenek0747de62009-07-18 00:47:21 +00001904 autoCreateBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001905 AppendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00001906 }
Mike Stump11289f42009-09-09 15:08:12 +00001907
Ted Kremenek93668002009-07-17 22:18:43 +00001908 // VLA types have expressions that must be evaluated.
1909 if (E->isArgumentType()) {
1910 for (VariableArrayType* VA = FindVA(E->getArgumentType().getTypePtr());
1911 VA != 0; VA = FindVA(VA->getElementType().getTypePtr()))
1912 addStmt(VA->getSizeExpr());
Ted Kremenek55957a82009-05-02 00:13:27 +00001913 }
Mike Stump11289f42009-09-09 15:08:12 +00001914
Mike Stump31feda52009-07-17 01:31:16 +00001915 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001916}
Mike Stump11289f42009-09-09 15:08:12 +00001917
Ted Kremenek93668002009-07-17 22:18:43 +00001918/// VisitStmtExpr - Utility method to handle (nested) statement
1919/// expressions (a GCC extension).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001920CFGBlock* CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
1921 if (asc.alwaysAdd()) {
Ted Kremenek0747de62009-07-18 00:47:21 +00001922 autoCreateBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001923 AppendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00001924 }
Ted Kremenek93668002009-07-17 22:18:43 +00001925 return VisitCompoundStmt(SE->getSubStmt());
1926}
Ted Kremenek9aae5132007-08-23 21:42:29 +00001927
Ted Kremenekc1f9a282008-04-16 21:10:48 +00001928CFGBlock* CFGBuilder::VisitSwitchStmt(SwitchStmt* Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00001929 // "switch" is a control-flow statement. Thus we stop processing the current
1930 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001931 CFGBlock* SwitchSuccessor = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00001932
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00001933 // Save local scope position because in case of condition variable ScopePos
1934 // won't be restored when traversing AST.
1935 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
1936
1937 // Create local scope for possible condition variable.
1938 // Store scope position. Add implicit destructor.
1939 if (VarDecl* VD = Terminator->getConditionVariable()) {
1940 LocalScope::const_iterator SwitchBeginScopePos = ScopePos;
1941 addLocalScopeForVarDecl(VD);
1942 addAutomaticObjDtors(ScopePos, SwitchBeginScopePos, Terminator);
1943 }
1944
Ted Kremenek9aae5132007-08-23 21:42:29 +00001945 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001946 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001947 return 0;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001948 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00001949 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001950
1951 // Save the current "switch" context.
1952 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00001953 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001954 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00001955
Mike Stump31feda52009-07-17 01:31:16 +00001956 // Set the "default" case to be the block after the switch statement. If the
1957 // switch statement contains a "default:", this value will be overwritten with
1958 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00001959 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00001960
Ted Kremenek9aae5132007-08-23 21:42:29 +00001961 // Create a new block that will contain the switch statement.
1962 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00001963
Ted Kremenek9aae5132007-08-23 21:42:29 +00001964 // Now process the switch body. The code after the switch is the implicit
1965 // successor.
1966 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001967 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00001968
1969 // When visiting the body, the case statements should automatically get linked
1970 // up to the switch. We also don't keep a pointer to the body, since all
1971 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00001972 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Ted Kremenek81e14852007-08-27 19:46:09 +00001973 Block = NULL;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00001974
1975 // If body is not a compound statement create implicit scope
1976 // and add destructors.
1977 if (!isa<CompoundStmt>(Terminator->getBody()))
1978 addLocalScopeAndDtors(Terminator->getBody());
1979
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001980 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00001981 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00001982 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00001983 return 0;
1984 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001985
Mike Stump31feda52009-07-17 01:31:16 +00001986 // If we have no "default:" case, the default transition is to the code
1987 // following the switch body.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001988 AddSuccessor(SwitchTerminatedBlock, DefaultCaseBlock);
Mike Stump31feda52009-07-17 01:31:16 +00001989
Ted Kremenek81e14852007-08-27 19:46:09 +00001990 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00001991 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek1362b8b2010-01-19 20:46:35 +00001992 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenek9aae5132007-08-23 21:42:29 +00001993 Block = SwitchTerminatedBlock;
Ted Kremenek8b5dc122009-12-24 00:39:26 +00001994 Block = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001995
Ted Kremenek8b5dc122009-12-24 00:39:26 +00001996 // Finally, if the SwitchStmt contains a condition variable, add both the
1997 // SwitchStmt and the condition variable initialization to the CFG.
1998 if (VarDecl *VD = Terminator->getConditionVariable()) {
1999 if (Expr *Init = VD->getInit()) {
2000 autoCreateBlock();
2001 AppendStmt(Block, Terminator, AddStmtChoice::AlwaysAdd);
2002 addStmt(Init);
2003 }
2004 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002005
Ted Kremenek8b5dc122009-12-24 00:39:26 +00002006 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002007}
2008
Ted Kremenek93668002009-07-17 22:18:43 +00002009CFGBlock* CFGBuilder::VisitCaseStmt(CaseStmt* CS) {
Mike Stump31feda52009-07-17 01:31:16 +00002010 // CaseStmts are essentially labels, so they are the first statement in a
2011 // block.
Ted Kremenek60fa6572010-08-04 23:54:30 +00002012 CFGBlock *TopBlock = 0, *LastBlock = 0;
2013
2014 if (Stmt *Sub = CS->getSubStmt()) {
2015 // For deeply nested chains of CaseStmts, instead of doing a recursion
2016 // (which can blow out the stack), manually unroll and create blocks
2017 // along the way.
2018 while (isa<CaseStmt>(Sub)) {
2019 CFGBlock *CurrentBlock = createBlock(false);
2020 CurrentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00002021
Ted Kremenek60fa6572010-08-04 23:54:30 +00002022 if (TopBlock)
2023 AddSuccessor(LastBlock, CurrentBlock);
2024 else
2025 TopBlock = CurrentBlock;
2026
2027 AddSuccessor(SwitchTerminatedBlock, CurrentBlock);
2028 LastBlock = CurrentBlock;
2029
2030 CS = cast<CaseStmt>(Sub);
2031 Sub = CS->getSubStmt();
2032 }
2033
2034 addStmt(Sub);
2035 }
Mike Stump11289f42009-09-09 15:08:12 +00002036
Ted Kremenek55e91e82007-08-30 18:48:11 +00002037 CFGBlock* CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002038 if (!CaseBlock)
2039 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00002040
2041 // Cases statements partition blocks, so this is the top of the basic block we
2042 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00002043 CaseBlock->setLabel(CS);
2044
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002045 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00002046 return 0;
Mike Stump31feda52009-07-17 01:31:16 +00002047
2048 // Add this block to the list of successors for the block with the switch
2049 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00002050 assert(SwitchTerminatedBlock);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002051 AddSuccessor(SwitchTerminatedBlock, CaseBlock);
Mike Stump31feda52009-07-17 01:31:16 +00002052
Ted Kremenek9aae5132007-08-23 21:42:29 +00002053 // We set Block to NULL to allow lazy creation of a new block (if necessary)
2054 Block = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00002055
Ted Kremenek60fa6572010-08-04 23:54:30 +00002056 if (TopBlock) {
2057 AddSuccessor(LastBlock, CaseBlock);
2058 Succ = TopBlock;
2059 }
2060 else {
2061 // This block is now the implicit successor of other blocks.
2062 Succ = CaseBlock;
2063 }
Mike Stump31feda52009-07-17 01:31:16 +00002064
Ted Kremenek60fa6572010-08-04 23:54:30 +00002065 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002066}
Mike Stump31feda52009-07-17 01:31:16 +00002067
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002068CFGBlock* CFGBuilder::VisitDefaultStmt(DefaultStmt* Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00002069 if (Terminator->getSubStmt())
2070 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00002071
Ted Kremenek654c78f2008-02-13 22:05:39 +00002072 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002073
2074 if (!DefaultCaseBlock)
2075 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00002076
2077 // Default statements partition blocks, so this is the top of the basic block
2078 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002079 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00002080
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002081 if (badCFG)
Ted Kremenek55957a82009-05-02 00:13:27 +00002082 return 0;
Ted Kremenek654c78f2008-02-13 22:05:39 +00002083
Mike Stump31feda52009-07-17 01:31:16 +00002084 // Unlike case statements, we don't add the default block to the successors
2085 // for the switch statement immediately. This is done when we finish
2086 // processing the switch statement. This allows for the default case
2087 // (including a fall-through to the code after the switch statement) to always
2088 // be the last successor of a switch-terminated block.
2089
Ted Kremenek654c78f2008-02-13 22:05:39 +00002090 // We set Block to NULL to allow lazy creation of a new block (if necessary)
2091 Block = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00002092
Ted Kremenek654c78f2008-02-13 22:05:39 +00002093 // This block is now the implicit successor of other blocks.
2094 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002095
2096 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00002097}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002098
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002099CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
2100 // "try"/"catch" is a control-flow statement. Thus we stop processing the
2101 // current block.
2102 CFGBlock* TrySuccessor = NULL;
2103
2104 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002105 if (badCFG)
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002106 return 0;
2107 TrySuccessor = Block;
2108 } else TrySuccessor = Succ;
2109
Mike Stump0bdba6c2010-01-20 01:15:34 +00002110 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002111
2112 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00002113 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002114 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00002115 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002116
Mike Stump0bdba6c2010-01-20 01:15:34 +00002117 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002118 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
2119 // The code after the try is the implicit successor.
2120 Succ = TrySuccessor;
2121 CXXCatchStmt *CS = Terminator->getHandler(h);
Mike Stump0bdba6c2010-01-20 01:15:34 +00002122 if (CS->getExceptionDecl() == 0) {
2123 HasCatchAll = true;
2124 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002125 Block = NULL;
2126 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
2127 if (CatchBlock == 0)
2128 return 0;
2129 // Add this block to the list of successors for the block with the try
2130 // statement.
Mike Stump845384a2010-01-20 01:30:58 +00002131 AddSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002132 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00002133 if (!HasCatchAll) {
2134 if (PrevTryTerminatedBlock)
Mike Stump845384a2010-01-20 01:30:58 +00002135 AddSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00002136 else
Mike Stump845384a2010-01-20 01:30:58 +00002137 AddSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00002138 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002139
2140 // The code after the try is the implicit successor.
2141 Succ = TrySuccessor;
2142
Mike Stump845384a2010-01-20 01:30:58 +00002143 // Save the current "try" context.
2144 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock);
2145 TryTerminatedBlock = NewTryTerminatedBlock;
2146
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002147 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002148 Block = NULL;
Ted Kremenek60983dc2010-01-19 20:52:05 +00002149 Block = addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002150 return Block;
2151}
2152
2153CFGBlock* CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt* CS) {
2154 // CXXCatchStmt are treated like labels, so they are the first statement in a
2155 // block.
2156
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00002157 // Save local scope position because in case of exception variable ScopePos
2158 // won't be restored when traversing AST.
2159 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2160
2161 // Create local scope for possible exception variable.
2162 // Store scope position. Add implicit destructor.
2163 if (VarDecl* VD = CS->getExceptionDecl()) {
2164 LocalScope::const_iterator BeginScopePos = ScopePos;
2165 addLocalScopeForVarDecl(VD);
2166 addAutomaticObjDtors(ScopePos, BeginScopePos, CS);
2167 }
2168
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002169 if (CS->getHandlerBlock())
2170 addStmt(CS->getHandlerBlock());
2171
2172 CFGBlock* CatchBlock = Block;
2173 if (!CatchBlock)
2174 CatchBlock = createBlock();
2175
2176 CatchBlock->setLabel(CS);
2177
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002178 if (badCFG)
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002179 return 0;
2180
2181 // We set Block to NULL to allow lazy creation of a new block (if necessary)
2182 Block = NULL;
2183
2184 return CatchBlock;
2185}
2186
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002187CFGBlock *CFGBuilder::VisitCXXMemberCallExpr(CXXMemberCallExpr *C,
Zhongxing Xu7e612172010-04-13 09:38:01 +00002188 AddStmtChoice asc) {
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002189 AddStmtChoice::Kind K = asc.asLValue() ? AddStmtChoice::AlwaysAddAsLValue
Zhongxing Xub5e94ac2010-04-14 05:50:04 +00002190 : AddStmtChoice::AlwaysAdd;
Zhongxing Xu7e612172010-04-13 09:38:01 +00002191 autoCreateBlock();
Zhongxing Xub5e94ac2010-04-14 05:50:04 +00002192 AppendStmt(Block, C, AddStmtChoice(K));
Zhongxing Xu7e612172010-04-13 09:38:01 +00002193 return VisitChildren(C);
2194}
2195
Ted Kremenekeda180e22007-08-28 19:26:49 +00002196CFGBlock* CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt* I) {
Mike Stump31feda52009-07-17 01:31:16 +00002197 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenekeda180e22007-08-28 19:26:49 +00002198 CFGBlock* IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00002199
Ted Kremenekeda180e22007-08-28 19:26:49 +00002200 if (!IBlock) {
2201 IBlock = createBlock(false);
2202 cfg->setIndirectGotoBlock(IBlock);
2203 }
Mike Stump31feda52009-07-17 01:31:16 +00002204
Ted Kremenekeda180e22007-08-28 19:26:49 +00002205 // IndirectGoto is a control-flow statement. Thus we stop processing the
2206 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002207 if (badCFG)
Ted Kremenek93668002009-07-17 22:18:43 +00002208 return 0;
2209
Ted Kremenekeda180e22007-08-28 19:26:49 +00002210 Block = createBlock(false);
2211 Block->setTerminator(I);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002212 AddSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00002213 return addStmt(I->getTarget());
2214}
2215
Ted Kremenek04cca642007-08-23 21:26:19 +00002216} // end anonymous namespace
Ted Kremenek889073f2007-08-23 16:51:22 +00002217
Mike Stump31feda52009-07-17 01:31:16 +00002218/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
2219/// no successors or predecessors. If this is the first block created in the
2220/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek813dd672007-09-05 20:02:05 +00002221CFGBlock* CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00002222 bool first_block = begin() == end();
2223
2224 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002225 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
2226 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC);
2227 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00002228
2229 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002230 if (first_block)
2231 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00002232
2233 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002234 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002235}
2236
Ted Kremenek889073f2007-08-23 16:51:22 +00002237/// buildCFG - Constructs a CFG from an AST. Ownership of the returned
2238/// CFG is returned to the caller.
Mike Stump6bf1c082010-01-21 02:21:40 +00002239CFG* CFG::buildCFG(const Decl *D, Stmt* Statement, ASTContext *C,
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002240 BuildOptions BO) {
Ted Kremenek889073f2007-08-23 16:51:22 +00002241 CFGBuilder Builder;
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002242 return Builder.buildCFG(D, Statement, C, BO);
Ted Kremenek889073f2007-08-23 16:51:22 +00002243}
2244
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002245//===----------------------------------------------------------------------===//
2246// CFG: Queries for BlkExprs.
2247//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002248
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002249namespace {
Ted Kremenek85be7cf2008-01-17 20:48:37 +00002250 typedef llvm::DenseMap<const Stmt*,unsigned> BlkExprMapTy;
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002251}
2252
Ted Kremenekbff98442009-12-23 23:37:10 +00002253static void FindSubExprAssignments(Stmt *S,
2254 llvm::SmallPtrSet<Expr*,50>& Set) {
2255 if (!S)
Ted Kremenek95a123c2008-01-26 00:03:27 +00002256 return;
Mike Stump31feda52009-07-17 01:31:16 +00002257
Ted Kremenekbff98442009-12-23 23:37:10 +00002258 for (Stmt::child_iterator I=S->child_begin(), E=S->child_end(); I!=E; ++I) {
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002259 Stmt *child = *I;
Ted Kremenekbff98442009-12-23 23:37:10 +00002260 if (!child)
2261 continue;
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002262
Ted Kremenekbff98442009-12-23 23:37:10 +00002263 if (BinaryOperator* B = dyn_cast<BinaryOperator>(child))
Ted Kremenek95a123c2008-01-26 00:03:27 +00002264 if (B->isAssignmentOp()) Set.insert(B);
Mike Stump31feda52009-07-17 01:31:16 +00002265
Ted Kremenekbff98442009-12-23 23:37:10 +00002266 FindSubExprAssignments(child, Set);
Ted Kremenek95a123c2008-01-26 00:03:27 +00002267 }
2268}
2269
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002270static BlkExprMapTy* PopulateBlkExprMap(CFG& cfg) {
2271 BlkExprMapTy* M = new BlkExprMapTy();
Mike Stump31feda52009-07-17 01:31:16 +00002272
2273 // Look for assignments that are used as subexpressions. These are the only
2274 // assignments that we want to *possibly* register as a block-level
2275 // expression. Basically, if an assignment occurs both in a subexpression and
2276 // at the block-level, it is a block-level expression.
Ted Kremenek95a123c2008-01-26 00:03:27 +00002277 llvm::SmallPtrSet<Expr*,50> SubExprAssignments;
Mike Stump31feda52009-07-17 01:31:16 +00002278
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002279 for (CFG::iterator I=cfg.begin(), E=cfg.end(); I != E; ++I)
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002280 for (CFGBlock::iterator BI=(*I)->begin(), EI=(*I)->end(); BI != EI; ++BI)
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00002281 if (CFGStmt S = BI->getAs<CFGStmt>())
2282 FindSubExprAssignments(S, SubExprAssignments);
Ted Kremenek85be7cf2008-01-17 20:48:37 +00002283
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002284 for (CFG::iterator I=cfg.begin(), E=cfg.end(); I != E; ++I) {
Mike Stump31feda52009-07-17 01:31:16 +00002285
2286 // Iterate over the statements again on identify the Expr* and Stmt* at the
2287 // block-level that are block-level expressions.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002288
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00002289 for (CFGBlock::iterator BI=(*I)->begin(), EI=(*I)->end(); BI != EI; ++BI) {
2290 CFGStmt CS = BI->getAs<CFGStmt>();
2291 if (!CS.isValid())
2292 continue;
2293 if (Expr* Exp = dyn_cast<Expr>(CS.getStmt())) {
Mike Stump31feda52009-07-17 01:31:16 +00002294
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002295 if (BinaryOperator* B = dyn_cast<BinaryOperator>(Exp)) {
Ted Kremenek95a123c2008-01-26 00:03:27 +00002296 // Assignment expressions that are not nested within another
Mike Stump31feda52009-07-17 01:31:16 +00002297 // expression are really "statements" whose value is never used by
2298 // another expression.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002299 if (B->isAssignmentOp() && !SubExprAssignments.count(Exp))
Ted Kremenek95a123c2008-01-26 00:03:27 +00002300 continue;
Mike Stump31feda52009-07-17 01:31:16 +00002301 } else if (const StmtExpr* Terminator = dyn_cast<StmtExpr>(Exp)) {
2302 // Special handling for statement expressions. The last statement in
2303 // the statement expression is also a block-level expr.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002304 const CompoundStmt* C = Terminator->getSubStmt();
Ted Kremenek85be7cf2008-01-17 20:48:37 +00002305 if (!C->body_empty()) {
Ted Kremenek95a123c2008-01-26 00:03:27 +00002306 unsigned x = M->size();
Ted Kremenek85be7cf2008-01-17 20:48:37 +00002307 (*M)[C->body_back()] = x;
2308 }
2309 }
Ted Kremenek0cb1ba22008-01-25 23:22:27 +00002310
Ted Kremenek95a123c2008-01-26 00:03:27 +00002311 unsigned x = M->size();
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002312 (*M)[Exp] = x;
Ted Kremenek95a123c2008-01-26 00:03:27 +00002313 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00002314 }
Mike Stump31feda52009-07-17 01:31:16 +00002315
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002316 // Look at terminators. The condition is a block-level expression.
Mike Stump31feda52009-07-17 01:31:16 +00002317
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002318 Stmt* S = (*I)->getTerminatorCondition();
Mike Stump31feda52009-07-17 01:31:16 +00002319
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00002320 if (S && M->find(S) == M->end()) {
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002321 unsigned x = M->size();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00002322 (*M)[S] = x;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002323 }
2324 }
Mike Stump31feda52009-07-17 01:31:16 +00002325
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002326 return M;
2327}
2328
Ted Kremenek85be7cf2008-01-17 20:48:37 +00002329CFG::BlkExprNumTy CFG::getBlkExprNum(const Stmt* S) {
2330 assert(S != NULL);
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002331 if (!BlkExprMap) { BlkExprMap = (void*) PopulateBlkExprMap(*this); }
Mike Stump31feda52009-07-17 01:31:16 +00002332
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002333 BlkExprMapTy* M = reinterpret_cast<BlkExprMapTy*>(BlkExprMap);
Ted Kremenek85be7cf2008-01-17 20:48:37 +00002334 BlkExprMapTy::iterator I = M->find(S);
Ted Kremenek60983dc2010-01-19 20:52:05 +00002335 return (I == M->end()) ? CFG::BlkExprNumTy() : CFG::BlkExprNumTy(I->second);
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002336}
2337
2338unsigned CFG::getNumBlkExprs() {
2339 if (const BlkExprMapTy* M = reinterpret_cast<const BlkExprMapTy*>(BlkExprMap))
2340 return M->size();
2341 else {
2342 // We assume callers interested in the number of BlkExprs will want
2343 // the map constructed if it doesn't already exist.
2344 BlkExprMap = (void*) PopulateBlkExprMap(*this);
2345 return reinterpret_cast<BlkExprMapTy*>(BlkExprMap)->size();
2346 }
2347}
2348
Ted Kremenek6065ef62008-04-28 18:00:46 +00002349//===----------------------------------------------------------------------===//
Ted Kremenekb0371852010-09-09 00:06:04 +00002350// Filtered walking of the CFG.
2351//===----------------------------------------------------------------------===//
2352
2353bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00002354 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenekb0371852010-09-09 00:06:04 +00002355
2356 if (F.IgnoreDefaultsWithCoveredEnums) {
2357 // If the 'To' has no label or is labeled but the label isn't a
2358 // CaseStmt then filter this edge.
2359 if (const SwitchStmt *S =
Ted Kremenekf146cd12010-09-09 02:57:48 +00002360 dyn_cast_or_null<SwitchStmt>(From->getTerminator())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00002361 if (S->isAllEnumCasesCovered()) {
Ted Kremenekf146cd12010-09-09 02:57:48 +00002362 const Stmt *L = To->getLabel();
2363 if (!L || !isa<CaseStmt>(L))
2364 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00002365 }
2366 }
2367 }
2368
2369 return false;
2370}
2371
2372//===----------------------------------------------------------------------===//
Ted Kremenek6065ef62008-04-28 18:00:46 +00002373// Cleanup: CFG dstor.
2374//===----------------------------------------------------------------------===//
2375
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00002376CFG::~CFG() {
2377 delete reinterpret_cast<const BlkExprMapTy*>(BlkExprMap);
2378}
Mike Stump31feda52009-07-17 01:31:16 +00002379
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002380//===----------------------------------------------------------------------===//
2381// CFG pretty printing
2382//===----------------------------------------------------------------------===//
2383
Ted Kremenek7e776b12007-08-22 18:22:34 +00002384namespace {
2385
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00002386class StmtPrinterHelper : public PrinterHelper {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002387 typedef llvm::DenseMap<Stmt*,std::pair<unsigned,unsigned> > StmtMapTy;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002388 typedef llvm::DenseMap<Decl*,std::pair<unsigned,unsigned> > DeclMapTy;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002389 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002390 DeclMapTy DeclMap;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002391 signed CurrentBlock;
2392 unsigned CurrentStmt;
Chris Lattnerc61089a2009-06-30 01:26:17 +00002393 const LangOptions &LangOpts;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002394public:
Ted Kremenekf8b50e92007-08-31 22:26:13 +00002395
Chris Lattnerc61089a2009-06-30 01:26:17 +00002396 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
2397 : CurrentBlock(0), CurrentStmt(0), LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002398 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
2399 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002400 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002401 BI != BEnd; ++BI, ++j ) {
2402 if (CFGStmt SE = BI->getAs<CFGStmt>()) {
2403 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
2404 StmtMap[SE] = P;
2405
2406 if (DeclStmt* DS = dyn_cast<DeclStmt>(SE.getStmt())) {
2407 DeclMap[DS->getSingleDecl()] = P;
2408
2409 } else if (IfStmt* IS = dyn_cast<IfStmt>(SE.getStmt())) {
2410 if (VarDecl* VD = IS->getConditionVariable())
2411 DeclMap[VD] = P;
2412
2413 } else if (ForStmt* FS = dyn_cast<ForStmt>(SE.getStmt())) {
2414 if (VarDecl* VD = FS->getConditionVariable())
2415 DeclMap[VD] = P;
2416
2417 } else if (WhileStmt* WS = dyn_cast<WhileStmt>(SE.getStmt())) {
2418 if (VarDecl* VD = WS->getConditionVariable())
2419 DeclMap[VD] = P;
2420
2421 } else if (SwitchStmt* SS = dyn_cast<SwitchStmt>(SE.getStmt())) {
2422 if (VarDecl* VD = SS->getConditionVariable())
2423 DeclMap[VD] = P;
2424
2425 } else if (CXXCatchStmt* CS = dyn_cast<CXXCatchStmt>(SE.getStmt())) {
2426 if (VarDecl* VD = CS->getExceptionDecl())
2427 DeclMap[VD] = P;
2428 }
2429 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002430 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00002431 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002432 }
Mike Stump31feda52009-07-17 01:31:16 +00002433
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002434 virtual ~StmtPrinterHelper() {}
Mike Stump31feda52009-07-17 01:31:16 +00002435
Chris Lattnerc61089a2009-06-30 01:26:17 +00002436 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002437 void setBlockID(signed i) { CurrentBlock = i; }
2438 void setStmtID(unsigned i) { CurrentStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00002439
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002440 virtual bool handledStmt(Stmt* S, llvm::raw_ostream& OS) {
2441 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002442
2443 if (I == StmtMap.end())
2444 return false;
Mike Stump31feda52009-07-17 01:31:16 +00002445
2446 if (CurrentBlock >= 0 && I->second.first == (unsigned) CurrentBlock
Ted Kremenek60983dc2010-01-19 20:52:05 +00002447 && I->second.second == CurrentStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002448 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00002449 }
Mike Stump31feda52009-07-17 01:31:16 +00002450
Ted Kremenek60983dc2010-01-19 20:52:05 +00002451 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00002452 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002453 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002454
2455 bool handleDecl(Decl* D, llvm::raw_ostream& OS) {
2456 DeclMapTy::iterator I = DeclMap.find(D);
2457
2458 if (I == DeclMap.end())
2459 return false;
2460
2461 if (CurrentBlock >= 0 && I->second.first == (unsigned) CurrentBlock
2462 && I->second.second == CurrentStmt) {
2463 return false;
2464 }
2465
2466 OS << "[B" << I->second.first << "." << I->second.second << "]";
2467 return true;
2468 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002469};
Chris Lattnerc61089a2009-06-30 01:26:17 +00002470} // end anonymous namespace
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002471
Chris Lattnerc61089a2009-06-30 01:26:17 +00002472
2473namespace {
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00002474class CFGBlockTerminatorPrint
Ted Kremenek83ebcef2008-01-08 18:15:10 +00002475 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Mike Stump31feda52009-07-17 01:31:16 +00002476
Ted Kremenek2d470fc2008-09-13 05:16:45 +00002477 llvm::raw_ostream& OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002478 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00002479 PrintingPolicy Policy;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002480public:
Douglas Gregor7de59662009-05-29 20:38:28 +00002481 CFGBlockTerminatorPrint(llvm::raw_ostream& os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00002482 const PrintingPolicy &Policy)
Douglas Gregor7de59662009-05-29 20:38:28 +00002483 : OS(os), Helper(helper), Policy(Policy) {}
Mike Stump31feda52009-07-17 01:31:16 +00002484
Ted Kremenek9aae5132007-08-23 21:42:29 +00002485 void VisitIfStmt(IfStmt* I) {
2486 OS << "if ";
Douglas Gregor7de59662009-05-29 20:38:28 +00002487 I->getCond()->printPretty(OS,Helper,Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002488 }
Mike Stump31feda52009-07-17 01:31:16 +00002489
Ted Kremenek9aae5132007-08-23 21:42:29 +00002490 // Default case.
Mike Stump31feda52009-07-17 01:31:16 +00002491 void VisitStmt(Stmt* Terminator) {
2492 Terminator->printPretty(OS, Helper, Policy);
2493 }
2494
Ted Kremenek9aae5132007-08-23 21:42:29 +00002495 void VisitForStmt(ForStmt* F) {
2496 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00002497 if (F->getInit())
2498 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00002499 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00002500 if (Stmt* C = F->getCond())
2501 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00002502 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00002503 if (F->getInc())
2504 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00002505 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00002506 }
Mike Stump31feda52009-07-17 01:31:16 +00002507
Ted Kremenek9aae5132007-08-23 21:42:29 +00002508 void VisitWhileStmt(WhileStmt* W) {
2509 OS << "while " ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00002510 if (Stmt* C = W->getCond())
2511 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002512 }
Mike Stump31feda52009-07-17 01:31:16 +00002513
Ted Kremenek9aae5132007-08-23 21:42:29 +00002514 void VisitDoStmt(DoStmt* D) {
2515 OS << "do ... while ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00002516 if (Stmt* C = D->getCond())
2517 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00002518 }
Mike Stump31feda52009-07-17 01:31:16 +00002519
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002520 void VisitSwitchStmt(SwitchStmt* Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00002521 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00002522 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00002523 }
Mike Stump31feda52009-07-17 01:31:16 +00002524
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002525 void VisitCXXTryStmt(CXXTryStmt* CS) {
2526 OS << "try ...";
2527 }
2528
Ted Kremenek7f7dd762007-08-31 21:49:40 +00002529 void VisitConditionalOperator(ConditionalOperator* C) {
Douglas Gregor7de59662009-05-29 20:38:28 +00002530 C->getCond()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00002531 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00002532 }
Mike Stump31feda52009-07-17 01:31:16 +00002533
Ted Kremenek391f94a2007-08-31 22:29:13 +00002534 void VisitChooseExpr(ChooseExpr* C) {
2535 OS << "__builtin_choose_expr( ";
Douglas Gregor7de59662009-05-29 20:38:28 +00002536 C->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00002537 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00002538 }
Mike Stump31feda52009-07-17 01:31:16 +00002539
Ted Kremenekf8b50e92007-08-31 22:26:13 +00002540 void VisitIndirectGotoStmt(IndirectGotoStmt* I) {
2541 OS << "goto *";
Douglas Gregor7de59662009-05-29 20:38:28 +00002542 I->getTarget()->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00002543 }
Mike Stump31feda52009-07-17 01:31:16 +00002544
Ted Kremenek7f7dd762007-08-31 21:49:40 +00002545 void VisitBinaryOperator(BinaryOperator* B) {
2546 if (!B->isLogicalOp()) {
2547 VisitExpr(B);
2548 return;
2549 }
Mike Stump31feda52009-07-17 01:31:16 +00002550
Douglas Gregor7de59662009-05-29 20:38:28 +00002551 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00002552
Ted Kremenek7f7dd762007-08-31 21:49:40 +00002553 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00002554 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00002555 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00002556 return;
John McCalle3027922010-08-25 11:45:40 +00002557 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00002558 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00002559 return;
2560 default:
2561 assert(false && "Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00002562 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00002563 }
Mike Stump31feda52009-07-17 01:31:16 +00002564
Ted Kremenek12687ff2007-08-27 21:54:41 +00002565 void VisitExpr(Expr* E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00002566 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00002567 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002568};
Chris Lattnerc61089a2009-06-30 01:26:17 +00002569} // end anonymous namespace
2570
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002571static void print_elem(llvm::raw_ostream &OS, StmtPrinterHelper* Helper,
Mike Stump92244b02010-01-19 22:00:14 +00002572 const CFGElement &E) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002573 if (CFGStmt CS = E.getAs<CFGStmt>()) {
2574 Stmt *S = CS;
2575
2576 if (Helper) {
Mike Stump31feda52009-07-17 01:31:16 +00002577
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002578 // special printing for statement-expressions.
2579 if (StmtExpr* SE = dyn_cast<StmtExpr>(S)) {
2580 CompoundStmt* Sub = SE->getSubStmt();
2581
2582 if (Sub->child_begin() != Sub->child_end()) {
2583 OS << "({ ... ; ";
2584 Helper->handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
2585 OS << " })\n";
2586 return;
2587 }
2588 }
2589 // special printing for comma expressions.
2590 if (BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
2591 if (B->getOpcode() == BO_Comma) {
2592 OS << "... , ";
2593 Helper->handledStmt(B->getRHS(),OS);
2594 OS << '\n';
2595 return;
2596 }
Ted Kremenekf8b50e92007-08-31 22:26:13 +00002597 }
2598 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002599 S->printPretty(OS, Helper, PrintingPolicy(Helper->getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00002600
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002601 if (isa<CXXOperatorCallExpr>(S)) {
2602 OS << " (OperatorCall)";
Mike Stump31feda52009-07-17 01:31:16 +00002603 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002604 else if (isa<CXXBindTemporaryExpr>(S)) {
2605 OS << " (BindTemporary)";
2606 }
Mike Stump31feda52009-07-17 01:31:16 +00002607
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002608 // Expressions need a newline.
2609 if (isa<Expr>(S))
2610 OS << '\n';
Ted Kremenek0f5d8bc2010-08-31 18:47:37 +00002611
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002612 } else if (CFGInitializer IE = E.getAs<CFGInitializer>()) {
2613 CXXBaseOrMemberInitializer* I = IE;
2614 if (I->isBaseInitializer())
2615 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
2616 else OS << I->getMember()->getName();
Mike Stump31feda52009-07-17 01:31:16 +00002617
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002618 OS << "(";
2619 if (Expr* IE = I->getInit())
2620 IE->printPretty(OS, Helper, PrintingPolicy(Helper->getLangOpts()));
2621 OS << ")";
2622
2623 if (I->isBaseInitializer())
2624 OS << " (Base initializer)\n";
2625 else OS << " (Member initializer)\n";
2626
2627 } else if (CFGAutomaticObjDtor DE = E.getAs<CFGAutomaticObjDtor>()){
2628 VarDecl* VD = DE.getVarDecl();
2629 Helper->handleDecl(VD, OS);
2630
2631 Type* T = VD->getType().getTypePtr();
2632 if (const ReferenceType* RT = T->getAs<ReferenceType>())
2633 T = RT->getPointeeType().getTypePtr();
2634
2635 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
2636 OS << " (Implicit destructor)\n";
2637 }
2638 }
Mike Stump31feda52009-07-17 01:31:16 +00002639
Chris Lattnerc61089a2009-06-30 01:26:17 +00002640static void print_block(llvm::raw_ostream& OS, const CFG* cfg,
2641 const CFGBlock& B,
2642 StmtPrinterHelper* Helper, bool print_edges) {
Mike Stump31feda52009-07-17 01:31:16 +00002643
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002644 if (Helper) Helper->setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00002645
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002646 // Print the header.
Mike Stump31feda52009-07-17 01:31:16 +00002647 OS << "\n [ B" << B.getBlockID();
2648
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002649 if (&B == &cfg->getEntry())
2650 OS << " (ENTRY) ]\n";
2651 else if (&B == &cfg->getExit())
2652 OS << " (EXIT) ]\n";
2653 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002654 OS << " (INDIRECT GOTO DISPATCH) ]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002655 else
2656 OS << " ]\n";
Mike Stump31feda52009-07-17 01:31:16 +00002657
Ted Kremenek71eca012007-08-29 23:20:49 +00002658 // Print the label of this block.
Mike Stump92244b02010-01-19 22:00:14 +00002659 if (Stmt* Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002660
2661 if (print_edges)
2662 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00002663
Mike Stump92244b02010-01-19 22:00:14 +00002664 if (LabelStmt* L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00002665 OS << L->getName();
Mike Stump92244b02010-01-19 22:00:14 +00002666 else if (CaseStmt* C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00002667 OS << "case ";
Chris Lattnerc61089a2009-06-30 01:26:17 +00002668 C->getLHS()->printPretty(OS, Helper,
2669 PrintingPolicy(Helper->getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00002670 if (C->getRHS()) {
2671 OS << " ... ";
Chris Lattnerc61089a2009-06-30 01:26:17 +00002672 C->getRHS()->printPretty(OS, Helper,
2673 PrintingPolicy(Helper->getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00002674 }
Mike Stump92244b02010-01-19 22:00:14 +00002675 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00002676 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00002677 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002678 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00002679 if (CS->getExceptionDecl())
2680 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper->getLangOpts()),
2681 0);
2682 else
2683 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00002684 OS << ")";
2685
2686 } else
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002687 assert(false && "Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00002688
Ted Kremenek71eca012007-08-29 23:20:49 +00002689 OS << ":\n";
2690 }
Mike Stump31feda52009-07-17 01:31:16 +00002691
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002692 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002693 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00002694
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002695 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
2696 I != E ; ++I, ++j ) {
Mike Stump31feda52009-07-17 01:31:16 +00002697
Ted Kremenek71eca012007-08-29 23:20:49 +00002698 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002699 if (print_edges)
2700 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00002701
Ted Kremenek2d470fc2008-09-13 05:16:45 +00002702 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00002703
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002704 if (Helper)
2705 Helper->setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00002706
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00002707 print_elem(OS,Helper,*I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002708 }
Mike Stump31feda52009-07-17 01:31:16 +00002709
Ted Kremenek71eca012007-08-29 23:20:49 +00002710 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002711 if (B.getTerminator()) {
2712 if (print_edges)
2713 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00002714
Ted Kremenek71eca012007-08-29 23:20:49 +00002715 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00002716
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002717 if (Helper) Helper->setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00002718
Chris Lattnerc61089a2009-06-30 01:26:17 +00002719 CFGBlockTerminatorPrint TPrinter(OS, Helper,
2720 PrintingPolicy(Helper->getLangOpts()));
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002721 TPrinter.Visit(const_cast<Stmt*>(B.getTerminator()));
Ted Kremenek15647632008-01-30 23:02:42 +00002722 OS << '\n';
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002723 }
Mike Stump31feda52009-07-17 01:31:16 +00002724
Ted Kremenek71eca012007-08-29 23:20:49 +00002725 if (print_edges) {
2726 // Print the predecessors of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002727 OS << " Predecessors (" << B.pred_size() << "):";
Ted Kremenek71eca012007-08-29 23:20:49 +00002728 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00002729
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002730 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
2731 I != E; ++I, ++i) {
Mike Stump31feda52009-07-17 01:31:16 +00002732
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002733 if (i == 8 || (i-8) == 0)
2734 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00002735
Ted Kremenek71eca012007-08-29 23:20:49 +00002736 OS << " B" << (*I)->getBlockID();
2737 }
Mike Stump31feda52009-07-17 01:31:16 +00002738
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002739 OS << '\n';
Mike Stump31feda52009-07-17 01:31:16 +00002740
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002741 // Print the successors of this block.
2742 OS << " Successors (" << B.succ_size() << "):";
2743 i = 0;
2744
2745 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
2746 I != E; ++I, ++i) {
Mike Stump31feda52009-07-17 01:31:16 +00002747
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002748 if (i == 8 || (i-8) % 10 == 0)
2749 OS << "\n ";
2750
Mike Stump0d76d072009-07-20 23:24:15 +00002751 if (*I)
2752 OS << " B" << (*I)->getBlockID();
2753 else
2754 OS << " NULL";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002755 }
Mike Stump31feda52009-07-17 01:31:16 +00002756
Ted Kremenek71eca012007-08-29 23:20:49 +00002757 OS << '\n';
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002758 }
Mike Stump31feda52009-07-17 01:31:16 +00002759}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002760
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002761
2762/// dump - A simple pretty printer of a CFG that outputs to stderr.
Chris Lattnerc61089a2009-06-30 01:26:17 +00002763void CFG::dump(const LangOptions &LO) const { print(llvm::errs(), LO); }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002764
2765/// print - A simple pretty printer of a CFG that outputs to an ostream.
Chris Lattnerc61089a2009-06-30 01:26:17 +00002766void CFG::print(llvm::raw_ostream &OS, const LangOptions &LO) const {
2767 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00002768
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002769 // Print the entry block.
2770 print_block(OS, this, getEntry(), &Helper, true);
Mike Stump31feda52009-07-17 01:31:16 +00002771
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002772 // Iterate through the CFGBlocks and print them one by one.
2773 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
2774 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002775 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002776 continue;
Mike Stump31feda52009-07-17 01:31:16 +00002777
Ted Kremenek289ae4f2009-10-12 20:55:07 +00002778 print_block(OS, this, **I, &Helper, true);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002779 }
Mike Stump31feda52009-07-17 01:31:16 +00002780
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002781 // Print the exit block.
2782 print_block(OS, this, getExit(), &Helper, true);
Ted Kremeneke03879b2008-11-24 20:50:24 +00002783 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00002784}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002785
2786/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Chris Lattnerc61089a2009-06-30 01:26:17 +00002787void CFGBlock::dump(const CFG* cfg, const LangOptions &LO) const {
2788 print(llvm::errs(), cfg, LO);
2789}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002790
2791/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
2792/// Generally this will only be called from CFG::print.
Chris Lattnerc61089a2009-06-30 01:26:17 +00002793void CFGBlock::print(llvm::raw_ostream& OS, const CFG* cfg,
2794 const LangOptions &LO) const {
2795 StmtPrinterHelper Helper(cfg, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002796 print_block(OS, cfg, *this, &Helper, true);
Ted Kremenek889073f2007-08-23 16:51:22 +00002797}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002798
Ted Kremenek15647632008-01-30 23:02:42 +00002799/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattnerc61089a2009-06-30 01:26:17 +00002800void CFGBlock::printTerminator(llvm::raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00002801 const LangOptions &LO) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00002802 CFGBlockTerminatorPrint TPrinter(OS, NULL, PrintingPolicy(LO));
Ted Kremenek15647632008-01-30 23:02:42 +00002803 TPrinter.Visit(const_cast<Stmt*>(getTerminator()));
2804}
2805
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00002806Stmt* CFGBlock::getTerminatorCondition() {
Mike Stump31feda52009-07-17 01:31:16 +00002807
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002808 if (!Terminator)
2809 return NULL;
Mike Stump31feda52009-07-17 01:31:16 +00002810
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002811 Expr* E = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00002812
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002813 switch (Terminator->getStmtClass()) {
2814 default:
2815 break;
Mike Stump31feda52009-07-17 01:31:16 +00002816
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002817 case Stmt::ForStmtClass:
2818 E = cast<ForStmt>(Terminator)->getCond();
2819 break;
Mike Stump31feda52009-07-17 01:31:16 +00002820
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002821 case Stmt::WhileStmtClass:
2822 E = cast<WhileStmt>(Terminator)->getCond();
2823 break;
Mike Stump31feda52009-07-17 01:31:16 +00002824
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002825 case Stmt::DoStmtClass:
2826 E = cast<DoStmt>(Terminator)->getCond();
2827 break;
Mike Stump31feda52009-07-17 01:31:16 +00002828
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002829 case Stmt::IfStmtClass:
2830 E = cast<IfStmt>(Terminator)->getCond();
2831 break;
Mike Stump31feda52009-07-17 01:31:16 +00002832
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002833 case Stmt::ChooseExprClass:
2834 E = cast<ChooseExpr>(Terminator)->getCond();
2835 break;
Mike Stump31feda52009-07-17 01:31:16 +00002836
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002837 case Stmt::IndirectGotoStmtClass:
2838 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
2839 break;
Mike Stump31feda52009-07-17 01:31:16 +00002840
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002841 case Stmt::SwitchStmtClass:
2842 E = cast<SwitchStmt>(Terminator)->getCond();
2843 break;
Mike Stump31feda52009-07-17 01:31:16 +00002844
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002845 case Stmt::ConditionalOperatorClass:
2846 E = cast<ConditionalOperator>(Terminator)->getCond();
2847 break;
Mike Stump31feda52009-07-17 01:31:16 +00002848
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002849 case Stmt::BinaryOperatorClass: // '&&' and '||'
2850 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00002851 break;
Mike Stump31feda52009-07-17 01:31:16 +00002852
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00002853 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00002854 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002855 }
Mike Stump31feda52009-07-17 01:31:16 +00002856
Ted Kremenekc1f9a282008-04-16 21:10:48 +00002857 return E ? E->IgnoreParens() : NULL;
2858}
2859
Ted Kremenek92137a32008-05-16 16:06:00 +00002860bool CFGBlock::hasBinaryBranchTerminator() const {
Mike Stump31feda52009-07-17 01:31:16 +00002861
Ted Kremenek92137a32008-05-16 16:06:00 +00002862 if (!Terminator)
2863 return false;
Mike Stump31feda52009-07-17 01:31:16 +00002864
Ted Kremenek92137a32008-05-16 16:06:00 +00002865 Expr* E = NULL;
Mike Stump31feda52009-07-17 01:31:16 +00002866
Ted Kremenek92137a32008-05-16 16:06:00 +00002867 switch (Terminator->getStmtClass()) {
2868 default:
2869 return false;
Mike Stump31feda52009-07-17 01:31:16 +00002870
2871 case Stmt::ForStmtClass:
Ted Kremenek92137a32008-05-16 16:06:00 +00002872 case Stmt::WhileStmtClass:
2873 case Stmt::DoStmtClass:
2874 case Stmt::IfStmtClass:
2875 case Stmt::ChooseExprClass:
2876 case Stmt::ConditionalOperatorClass:
2877 case Stmt::BinaryOperatorClass:
Mike Stump31feda52009-07-17 01:31:16 +00002878 return true;
Ted Kremenek92137a32008-05-16 16:06:00 +00002879 }
Mike Stump31feda52009-07-17 01:31:16 +00002880
Ted Kremenek92137a32008-05-16 16:06:00 +00002881 return E ? E->IgnoreParens() : NULL;
2882}
2883
Ted Kremenek15647632008-01-30 23:02:42 +00002884
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002885//===----------------------------------------------------------------------===//
2886// CFG Graphviz Visualization
2887//===----------------------------------------------------------------------===//
2888
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002889
2890#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00002891static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002892#endif
2893
Chris Lattnerc61089a2009-06-30 01:26:17 +00002894void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002895#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00002896 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002897 GraphHelper = &H;
2898 llvm::ViewGraph(this,"CFG");
2899 GraphHelper = NULL;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002900#endif
2901}
2902
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002903namespace llvm {
2904template<>
2905struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Tobias Grosser9fc223a2009-11-30 14:16:05 +00002906
2907 DOTGraphTraits (bool isSimple=false) : DefaultDOTGraphTraits(isSimple) {}
2908
2909 static std::string getNodeLabel(const CFGBlock* Node, const CFG* Graph) {
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002910
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00002911#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00002912 std::string OutSStr;
2913 llvm::raw_string_ostream Out(OutSStr);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00002914 print_block(Out,Graph, *Node, GraphHelper, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00002915 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002916
2917 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
2918
2919 // Process string output to make it nicer...
2920 for (unsigned i = 0; i != OutStr.length(); ++i)
2921 if (OutStr[i] == '\n') { // Left justify
2922 OutStr[i] = '\\';
2923 OutStr.insert(OutStr.begin()+i+1, 'l');
2924 }
Mike Stump31feda52009-07-17 01:31:16 +00002925
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002926 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00002927#else
2928 return "";
2929#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00002930 }
2931};
2932} // end namespace llvm