blob: fc0b904c83cd3b57b037341df869b9eb8155f87b [file] [log] [blame]
Ted Kremenek6f342132011-03-15 03:17:07 +00001//==- UninitializedValues.cpp - Find Uninitialized Values -------*- C++ --*-==//
Ted Kremenek610068c2011-01-15 02:58:47 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements uninitialized values analysis for source-level CFGs.
11//
12//===----------------------------------------------------------------------===//
13
Ted Kremenek13bd4232011-01-20 17:37:17 +000014#include <utility>
Ted Kremenek610068c2011-01-15 02:58:47 +000015#include "llvm/ADT/Optional.h"
16#include "llvm/ADT/SmallVector.h"
17#include "llvm/ADT/BitVector.h"
18#include "llvm/ADT/DenseMap.h"
19#include "clang/AST/Decl.h"
20#include "clang/Analysis/CFG.h"
Ted Kremeneka8c17a52011-01-25 19:13:48 +000021#include "clang/Analysis/AnalysisContext.h"
Ted Kremenek610068c2011-01-15 02:58:47 +000022#include "clang/Analysis/Visitors/CFGRecStmtDeclVisitor.h"
Ted Kremenek6f342132011-03-15 03:17:07 +000023#include "clang/Analysis/Analyses/UninitializedValues.h"
Ted Kremenekc21fed32011-01-18 21:18:58 +000024#include "clang/Analysis/Support/SaveAndRestore.h"
Ted Kremenek610068c2011-01-15 02:58:47 +000025
26using namespace clang;
27
Ted Kremenek40900ee2011-01-27 02:29:34 +000028static bool isTrackedVar(const VarDecl *vd, const DeclContext *dc) {
Ted Kremenek1cbc3152011-03-17 03:06:11 +000029 if (vd->isLocalVarDecl() && !vd->hasGlobalStorage() &&
Ted Kremeneka21612f2011-04-07 20:02:56 +000030 !vd->isExceptionVariable() &&
Ted Kremenek1cbc3152011-03-17 03:06:11 +000031 vd->getDeclContext() == dc) {
32 QualType ty = vd->getType();
33 return ty->isScalarType() || ty->isVectorType();
34 }
35 return false;
Ted Kremenekc104e532011-01-18 04:53:25 +000036}
37
Ted Kremenek610068c2011-01-15 02:58:47 +000038//------------------------------------------------------------------------====//
Ted Kremenek136f8f22011-03-15 04:57:27 +000039// DeclToIndex: a mapping from Decls we track to value indices.
Ted Kremenek610068c2011-01-15 02:58:47 +000040//====------------------------------------------------------------------------//
41
42namespace {
Ted Kremenek136f8f22011-03-15 04:57:27 +000043class DeclToIndex {
Ted Kremenek610068c2011-01-15 02:58:47 +000044 llvm::DenseMap<const VarDecl *, unsigned> map;
45public:
Ted Kremenek136f8f22011-03-15 04:57:27 +000046 DeclToIndex() {}
Ted Kremenek610068c2011-01-15 02:58:47 +000047
48 /// Compute the actual mapping from declarations to bits.
49 void computeMap(const DeclContext &dc);
50
51 /// Return the number of declarations in the map.
52 unsigned size() const { return map.size(); }
53
54 /// Returns the bit vector index for a given declaration.
Ted Kremenekb831c672011-03-29 01:40:00 +000055 llvm::Optional<unsigned> getValueIndex(const VarDecl *d) const;
Ted Kremenek610068c2011-01-15 02:58:47 +000056};
57}
58
Ted Kremenek136f8f22011-03-15 04:57:27 +000059void DeclToIndex::computeMap(const DeclContext &dc) {
Ted Kremenek610068c2011-01-15 02:58:47 +000060 unsigned count = 0;
61 DeclContext::specific_decl_iterator<VarDecl> I(dc.decls_begin()),
62 E(dc.decls_end());
63 for ( ; I != E; ++I) {
64 const VarDecl *vd = *I;
Ted Kremenek40900ee2011-01-27 02:29:34 +000065 if (isTrackedVar(vd, &dc))
Ted Kremenek610068c2011-01-15 02:58:47 +000066 map[vd] = count++;
67 }
68}
69
Ted Kremenekb831c672011-03-29 01:40:00 +000070llvm::Optional<unsigned> DeclToIndex::getValueIndex(const VarDecl *d) const {
71 llvm::DenseMap<const VarDecl *, unsigned>::const_iterator I = map.find(d);
Ted Kremenek610068c2011-01-15 02:58:47 +000072 if (I == map.end())
73 return llvm::Optional<unsigned>();
74 return I->second;
75}
76
77//------------------------------------------------------------------------====//
78// CFGBlockValues: dataflow values for CFG blocks.
79//====------------------------------------------------------------------------//
80
Ted Kremenekf7bafc72011-03-15 04:57:38 +000081// These values are defined in such a way that a merge can be done using
82// a bitwise OR.
83enum Value { Unknown = 0x0, /* 00 */
84 Initialized = 0x1, /* 01 */
85 Uninitialized = 0x2, /* 10 */
86 MayUninitialized = 0x3 /* 11 */ };
87
88static bool isUninitialized(const Value v) {
89 return v >= Uninitialized;
90}
91static bool isAlwaysUninit(const Value v) {
92 return v == Uninitialized;
93}
Ted Kremenekafb10c42011-03-15 04:57:29 +000094
Benjamin Kramerda57f3e2011-03-26 12:38:21 +000095namespace {
Ted Kremenekafb10c42011-03-15 04:57:29 +000096class ValueVector {
97 llvm::BitVector vec;
98public:
99 ValueVector() {}
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000100 ValueVector(unsigned size) : vec(size << 1) {}
101 void resize(unsigned n) { vec.resize(n << 1); }
Ted Kremenekafb10c42011-03-15 04:57:29 +0000102 void merge(const ValueVector &rhs) { vec |= rhs.vec; }
103 bool operator!=(const ValueVector &rhs) const { return vec != rhs.vec; }
Ted Kremenekafb10c42011-03-15 04:57:29 +0000104 void reset() { vec.reset(); }
Ted Kremenek496398d2011-03-15 04:57:32 +0000105
106 class reference {
107 ValueVector &vv;
108 const unsigned idx;
109
110 reference(); // Undefined
111 public:
112 reference(ValueVector &vv, unsigned idx) : vv(vv), idx(idx) {}
113 ~reference() {}
114
115 reference &operator=(Value v) {
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000116 vv.vec[idx << 1] = (((unsigned) v) & 0x1) ? true : false;
117 vv.vec[(idx << 1) | 1] = (((unsigned) v) & 0x2) ? true : false;
Ted Kremenek496398d2011-03-15 04:57:32 +0000118 return *this;
119 }
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000120 operator Value() {
121 unsigned x = (vv.vec[idx << 1] ? 1 : 0) | (vv.vec[(idx << 1) | 1] ? 2 :0);
122 return (Value) x;
123 }
Ted Kremenek496398d2011-03-15 04:57:32 +0000124 };
125
126 reference operator[](unsigned idx) { return reference(*this, idx); }
Ted Kremenekafb10c42011-03-15 04:57:29 +0000127};
128
Ted Kremenek136f8f22011-03-15 04:57:27 +0000129typedef std::pair<ValueVector *, ValueVector *> BVPair;
Ted Kremenek13bd4232011-01-20 17:37:17 +0000130
Ted Kremenek610068c2011-01-15 02:58:47 +0000131class CFGBlockValues {
132 const CFG &cfg;
Ted Kremenek13bd4232011-01-20 17:37:17 +0000133 BVPair *vals;
Ted Kremenek136f8f22011-03-15 04:57:27 +0000134 ValueVector scratch;
Ted Kremenek4ddb3872011-03-15 05:30:12 +0000135 DeclToIndex declToIndex;
Ted Kremenek13bd4232011-01-20 17:37:17 +0000136
Ted Kremenek136f8f22011-03-15 04:57:27 +0000137 ValueVector &lazyCreate(ValueVector *&bv);
Ted Kremenek610068c2011-01-15 02:58:47 +0000138public:
139 CFGBlockValues(const CFG &cfg);
140 ~CFGBlockValues();
141
Ted Kremenekd40066b2011-04-04 23:29:12 +0000142 unsigned getNumEntries() const { return declToIndex.size(); }
143
Ted Kremenek610068c2011-01-15 02:58:47 +0000144 void computeSetOfDeclarations(const DeclContext &dc);
Ted Kremenek136f8f22011-03-15 04:57:27 +0000145 ValueVector &getValueVector(const CFGBlock *block,
Ted Kremenek13bd4232011-01-20 17:37:17 +0000146 const CFGBlock *dstBlock);
147
Ted Kremenek136f8f22011-03-15 04:57:27 +0000148 BVPair &getValueVectors(const CFGBlock *block, bool shouldLazyCreate);
Ted Kremenek13bd4232011-01-20 17:37:17 +0000149
Ted Kremenek136f8f22011-03-15 04:57:27 +0000150 void mergeIntoScratch(ValueVector const &source, bool isFirst);
151 bool updateValueVectorWithScratch(const CFGBlock *block);
152 bool updateValueVectors(const CFGBlock *block, const BVPair &newVals);
Ted Kremenek610068c2011-01-15 02:58:47 +0000153
154 bool hasNoDeclarations() const {
Ted Kremenek4ddb3872011-03-15 05:30:12 +0000155 return declToIndex.size() == 0;
Ted Kremenek610068c2011-01-15 02:58:47 +0000156 }
157
Ted Kremenekb831c672011-03-29 01:40:00 +0000158 bool hasEntry(const VarDecl *vd) const {
159 return declToIndex.getValueIndex(vd).hasValue();
160 }
161
Ted Kremenekf8adeef2011-04-04 20:30:58 +0000162 bool hasValues(const CFGBlock *block);
163
Ted Kremenek610068c2011-01-15 02:58:47 +0000164 void resetScratch();
Ted Kremenek136f8f22011-03-15 04:57:27 +0000165 ValueVector &getScratch() { return scratch; }
Ted Kremenek13bd4232011-01-20 17:37:17 +0000166
Ted Kremenek136f8f22011-03-15 04:57:27 +0000167 ValueVector::reference operator[](const VarDecl *vd);
Ted Kremenek610068c2011-01-15 02:58:47 +0000168};
Benjamin Kramerda57f3e2011-03-26 12:38:21 +0000169} // end anonymous namespace
Ted Kremenek610068c2011-01-15 02:58:47 +0000170
171CFGBlockValues::CFGBlockValues(const CFG &c) : cfg(c), vals(0) {
172 unsigned n = cfg.getNumBlockIDs();
173 if (!n)
174 return;
Ted Kremenek136f8f22011-03-15 04:57:27 +0000175 vals = new std::pair<ValueVector*, ValueVector*>[n];
Chandler Carruth75c40642011-04-28 08:19:45 +0000176 memset((void*)vals, 0, sizeof(*vals) * n);
Ted Kremenek610068c2011-01-15 02:58:47 +0000177}
178
179CFGBlockValues::~CFGBlockValues() {
180 unsigned n = cfg.getNumBlockIDs();
181 if (n == 0)
182 return;
Ted Kremenek13bd4232011-01-20 17:37:17 +0000183 for (unsigned i = 0; i < n; ++i) {
184 delete vals[i].first;
185 delete vals[i].second;
186 }
Ted Kremenek610068c2011-01-15 02:58:47 +0000187 delete [] vals;
188}
189
190void CFGBlockValues::computeSetOfDeclarations(const DeclContext &dc) {
Ted Kremenek4ddb3872011-03-15 05:30:12 +0000191 declToIndex.computeMap(dc);
192 scratch.resize(declToIndex.size());
Ted Kremenek610068c2011-01-15 02:58:47 +0000193}
194
Ted Kremenek136f8f22011-03-15 04:57:27 +0000195ValueVector &CFGBlockValues::lazyCreate(ValueVector *&bv) {
Ted Kremenek13bd4232011-01-20 17:37:17 +0000196 if (!bv)
Ted Kremenek4ddb3872011-03-15 05:30:12 +0000197 bv = new ValueVector(declToIndex.size());
Ted Kremenek610068c2011-01-15 02:58:47 +0000198 return *bv;
199}
200
Ted Kremenek13bd4232011-01-20 17:37:17 +0000201/// This function pattern matches for a '&&' or '||' that appears at
202/// the beginning of a CFGBlock that also (1) has a terminator and
203/// (2) has no other elements. If such an expression is found, it is returned.
204static BinaryOperator *getLogicalOperatorInChain(const CFGBlock *block) {
205 if (block->empty())
206 return 0;
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000207
Ted Kremenek3c0349e2011-03-01 03:15:10 +0000208 const CFGStmt *cstmt = block->front().getAs<CFGStmt>();
Ted Kremenek76709bf2011-03-15 05:22:28 +0000209 if (!cstmt)
210 return 0;
211
Ted Kremenek3c0349e2011-03-01 03:15:10 +0000212 BinaryOperator *b = llvm::dyn_cast_or_null<BinaryOperator>(cstmt->getStmt());
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000213
214 if (!b || !b->isLogicalOp())
Ted Kremenek13bd4232011-01-20 17:37:17 +0000215 return 0;
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000216
Ted Kremeneke6c28032011-05-10 22:10:35 +0000217 if (block->pred_size() == 2) {
218 if (block->getTerminatorCondition() == b) {
219 if (block->succ_size() == 2)
220 return b;
221 }
222 else if (block->size() == 1)
223 return b;
224 }
225
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000226 return 0;
Ted Kremenek13bd4232011-01-20 17:37:17 +0000227}
228
Ted Kremenek136f8f22011-03-15 04:57:27 +0000229ValueVector &CFGBlockValues::getValueVector(const CFGBlock *block,
230 const CFGBlock *dstBlock) {
Ted Kremenek13bd4232011-01-20 17:37:17 +0000231 unsigned idx = block->getBlockID();
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000232 if (dstBlock && getLogicalOperatorInChain(block)) {
233 if (*block->succ_begin() == dstBlock)
234 return lazyCreate(vals[idx].first);
235 assert(*(block->succ_begin()+1) == dstBlock);
236 return lazyCreate(vals[idx].second);
Ted Kremenek13bd4232011-01-20 17:37:17 +0000237 }
238
239 assert(vals[idx].second == 0);
240 return lazyCreate(vals[idx].first);
241}
242
Ted Kremenekf8adeef2011-04-04 20:30:58 +0000243bool CFGBlockValues::hasValues(const CFGBlock *block) {
244 unsigned idx = block->getBlockID();
245 return vals[idx].second != 0;
246}
247
Ted Kremenek136f8f22011-03-15 04:57:27 +0000248BVPair &CFGBlockValues::getValueVectors(const clang::CFGBlock *block,
249 bool shouldLazyCreate) {
Ted Kremenek13bd4232011-01-20 17:37:17 +0000250 unsigned idx = block->getBlockID();
251 lazyCreate(vals[idx].first);
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000252 if (shouldLazyCreate)
253 lazyCreate(vals[idx].second);
Ted Kremenek13bd4232011-01-20 17:37:17 +0000254 return vals[idx];
255}
256
Ted Kremenek136f8f22011-03-15 04:57:27 +0000257void CFGBlockValues::mergeIntoScratch(ValueVector const &source,
Ted Kremenek610068c2011-01-15 02:58:47 +0000258 bool isFirst) {
259 if (isFirst)
260 scratch = source;
261 else
Ted Kremenekafb10c42011-03-15 04:57:29 +0000262 scratch.merge(source);
Ted Kremenek610068c2011-01-15 02:58:47 +0000263}
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000264#if 0
Ted Kremenek136f8f22011-03-15 04:57:27 +0000265static void printVector(const CFGBlock *block, ValueVector &bv,
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000266 unsigned num) {
267
268 llvm::errs() << block->getBlockID() << " :";
269 for (unsigned i = 0; i < bv.size(); ++i) {
270 llvm::errs() << ' ' << bv[i];
271 }
272 llvm::errs() << " : " << num << '\n';
273}
274#endif
Ted Kremenek610068c2011-01-15 02:58:47 +0000275
Ted Kremenek136f8f22011-03-15 04:57:27 +0000276bool CFGBlockValues::updateValueVectorWithScratch(const CFGBlock *block) {
277 ValueVector &dst = getValueVector(block, 0);
Ted Kremenek610068c2011-01-15 02:58:47 +0000278 bool changed = (dst != scratch);
279 if (changed)
280 dst = scratch;
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000281#if 0
282 printVector(block, scratch, 0);
283#endif
Ted Kremenek13bd4232011-01-20 17:37:17 +0000284 return changed;
285}
286
Ted Kremenek136f8f22011-03-15 04:57:27 +0000287bool CFGBlockValues::updateValueVectors(const CFGBlock *block,
Ted Kremenek13bd4232011-01-20 17:37:17 +0000288 const BVPair &newVals) {
Ted Kremenek136f8f22011-03-15 04:57:27 +0000289 BVPair &vals = getValueVectors(block, true);
Ted Kremenek13bd4232011-01-20 17:37:17 +0000290 bool changed = *newVals.first != *vals.first ||
291 *newVals.second != *vals.second;
292 *vals.first = *newVals.first;
293 *vals.second = *newVals.second;
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000294#if 0
295 printVector(block, *vals.first, 1);
296 printVector(block, *vals.second, 2);
297#endif
Ted Kremenek610068c2011-01-15 02:58:47 +0000298 return changed;
299}
300
301void CFGBlockValues::resetScratch() {
302 scratch.reset();
303}
304
Ted Kremenek136f8f22011-03-15 04:57:27 +0000305ValueVector::reference CFGBlockValues::operator[](const VarDecl *vd) {
Ted Kremenek4ddb3872011-03-15 05:30:12 +0000306 const llvm::Optional<unsigned> &idx = declToIndex.getValueIndex(vd);
Ted Kremenek610068c2011-01-15 02:58:47 +0000307 assert(idx.hasValue());
308 return scratch[idx.getValue()];
309}
310
311//------------------------------------------------------------------------====//
312// Worklist: worklist for dataflow analysis.
313//====------------------------------------------------------------------------//
314
315namespace {
316class DataflowWorklist {
317 llvm::SmallVector<const CFGBlock *, 20> worklist;
Ted Kremenek496398d2011-03-15 04:57:32 +0000318 llvm::BitVector enqueuedBlocks;
Ted Kremenek610068c2011-01-15 02:58:47 +0000319public:
320 DataflowWorklist(const CFG &cfg) : enqueuedBlocks(cfg.getNumBlockIDs()) {}
321
322 void enqueue(const CFGBlock *block);
323 void enqueueSuccessors(const CFGBlock *block);
324 const CFGBlock *dequeue();
325
326};
327}
328
329void DataflowWorklist::enqueue(const CFGBlock *block) {
Ted Kremenekc104e532011-01-18 04:53:25 +0000330 if (!block)
331 return;
Ted Kremenek610068c2011-01-15 02:58:47 +0000332 unsigned idx = block->getBlockID();
333 if (enqueuedBlocks[idx])
334 return;
335 worklist.push_back(block);
336 enqueuedBlocks[idx] = true;
337}
338
339void DataflowWorklist::enqueueSuccessors(const clang::CFGBlock *block) {
340 for (CFGBlock::const_succ_iterator I = block->succ_begin(),
341 E = block->succ_end(); I != E; ++I) {
342 enqueue(*I);
343 }
344}
345
346const CFGBlock *DataflowWorklist::dequeue() {
347 if (worklist.empty())
348 return 0;
349 const CFGBlock *b = worklist.back();
350 worklist.pop_back();
351 enqueuedBlocks[b->getBlockID()] = false;
352 return b;
353}
354
355//------------------------------------------------------------------------====//
356// Transfer function for uninitialized values analysis.
357//====------------------------------------------------------------------------//
358
Ted Kremenek610068c2011-01-15 02:58:47 +0000359namespace {
360class FindVarResult {
361 const VarDecl *vd;
362 const DeclRefExpr *dr;
363public:
364 FindVarResult(VarDecl *vd, DeclRefExpr *dr) : vd(vd), dr(dr) {}
365
366 const DeclRefExpr *getDeclRefExpr() const { return dr; }
367 const VarDecl *getDecl() const { return vd; }
368};
369
370class TransferFunctions : public CFGRecStmtVisitor<TransferFunctions> {
371 CFGBlockValues &vals;
372 const CFG &cfg;
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000373 AnalysisContext &ac;
Ted Kremenek610068c2011-01-15 02:58:47 +0000374 UninitVariablesHandler *handler;
Ted Kremenekc21fed32011-01-18 21:18:58 +0000375 const DeclRefExpr *currentDR;
Ted Kremenekdd0f7942011-01-26 04:49:43 +0000376 const Expr *currentVoidCast;
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000377 const bool flagBlockUses;
Ted Kremenek610068c2011-01-15 02:58:47 +0000378public:
379 TransferFunctions(CFGBlockValues &vals, const CFG &cfg,
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000380 AnalysisContext &ac,
381 UninitVariablesHandler *handler,
382 bool flagBlockUses)
383 : vals(vals), cfg(cfg), ac(ac), handler(handler), currentDR(0),
Ted Kremenekdd0f7942011-01-26 04:49:43 +0000384 currentVoidCast(0), flagBlockUses(flagBlockUses) {}
Ted Kremenek610068c2011-01-15 02:58:47 +0000385
386 const CFG &getCFG() { return cfg; }
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000387 void reportUninit(const DeclRefExpr *ex, const VarDecl *vd,
388 bool isAlwaysUninit);
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000389
390 void VisitBlockExpr(BlockExpr *be);
Ted Kremenek610068c2011-01-15 02:58:47 +0000391 void VisitDeclStmt(DeclStmt *ds);
Ted Kremenekc21fed32011-01-18 21:18:58 +0000392 void VisitDeclRefExpr(DeclRefExpr *dr);
Ted Kremenek610068c2011-01-15 02:58:47 +0000393 void VisitUnaryOperator(UnaryOperator *uo);
394 void VisitBinaryOperator(BinaryOperator *bo);
395 void VisitCastExpr(CastExpr *ce);
Peter Collingbournef4e3cfb2011-03-11 19:24:49 +0000396 void VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *se);
Chandler Carruth86684942011-04-13 08:18:42 +0000397 void VisitCXXTypeidExpr(CXXTypeidExpr *E);
Ted Kremenek1ea800c2011-01-27 02:01:31 +0000398 void BlockStmt_VisitObjCForCollectionStmt(ObjCForCollectionStmt *fs);
Ted Kremenek40900ee2011-01-27 02:29:34 +0000399
400 bool isTrackedVar(const VarDecl *vd) {
401 return ::isTrackedVar(vd, cast<DeclContext>(ac.getDecl()));
402 }
403
404 FindVarResult findBlockVarDecl(Expr *ex);
Ted Kremenek610068c2011-01-15 02:58:47 +0000405};
406}
407
408void TransferFunctions::reportUninit(const DeclRefExpr *ex,
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000409 const VarDecl *vd, bool isAlwaysUnit) {
410 if (handler) handler->handleUseOfUninitVariable(ex, vd, isAlwaysUnit);
Ted Kremenek610068c2011-01-15 02:58:47 +0000411}
412
Ted Kremenek40900ee2011-01-27 02:29:34 +0000413FindVarResult TransferFunctions::findBlockVarDecl(Expr* ex) {
Ted Kremenek1ea800c2011-01-27 02:01:31 +0000414 if (DeclRefExpr* dr = dyn_cast<DeclRefExpr>(ex->IgnoreParenCasts()))
415 if (VarDecl *vd = dyn_cast<VarDecl>(dr->getDecl()))
416 if (isTrackedVar(vd))
Ted Kremenek40900ee2011-01-27 02:29:34 +0000417 return FindVarResult(vd, dr);
Ted Kremenek1ea800c2011-01-27 02:01:31 +0000418 return FindVarResult(0, 0);
419}
420
421void TransferFunctions::BlockStmt_VisitObjCForCollectionStmt(
422 ObjCForCollectionStmt *fs) {
423
424 Visit(fs->getCollection());
425
426 // This represents an initialization of the 'element' value.
427 Stmt *element = fs->getElement();
428 const VarDecl* vd = 0;
429
430 if (DeclStmt* ds = dyn_cast<DeclStmt>(element)) {
431 vd = cast<VarDecl>(ds->getSingleDecl());
432 if (!isTrackedVar(vd))
433 vd = 0;
434 }
435 else {
436 // Initialize the value of the reference variable.
437 const FindVarResult &res = findBlockVarDecl(cast<Expr>(element));
438 vd = res.getDecl();
439 if (!vd) {
440 Visit(element);
441 return;
442 }
443 }
444
445 if (vd)
446 vals[vd] = Initialized;
447}
448
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000449void TransferFunctions::VisitBlockExpr(BlockExpr *be) {
450 if (!flagBlockUses || !handler)
451 return;
Ted Kremenekbc8b44c2011-03-31 22:32:41 +0000452 const BlockDecl *bd = be->getBlockDecl();
453 for (BlockDecl::capture_const_iterator i = bd->capture_begin(),
454 e = bd->capture_end() ; i != e; ++i) {
455 const VarDecl *vd = i->getVariable();
456 if (!vd->hasLocalStorage())
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000457 continue;
Ted Kremenekbc8b44c2011-03-31 22:32:41 +0000458 if (!isTrackedVar(vd))
459 continue;
460 if (i->isByRef()) {
461 vals[vd] = Initialized;
462 continue;
463 }
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000464 Value v = vals[vd];
465 if (isUninitialized(v))
466 handler->handleUseOfUninitVariable(be, vd, isAlwaysUninit(v));
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000467 }
468}
469
Ted Kremenek610068c2011-01-15 02:58:47 +0000470void TransferFunctions::VisitDeclStmt(DeclStmt *ds) {
471 for (DeclStmt::decl_iterator DI = ds->decl_begin(), DE = ds->decl_end();
472 DI != DE; ++DI) {
473 if (VarDecl *vd = dyn_cast<VarDecl>(*DI)) {
Ted Kremenek4dccb902011-01-18 05:00:42 +0000474 if (isTrackedVar(vd)) {
Chandler Carruthb88fb022011-04-05 21:36:30 +0000475 if (Expr *init = vd->getInit()) {
Ted Kremenek610068c2011-01-15 02:58:47 +0000476 Visit(init);
Chandler Carruthb88fb022011-04-05 21:36:30 +0000477
478 // If the initializer consists solely of a reference to itself, we
479 // explicitly mark the variable as uninitialized. This allows code
480 // like the following:
481 //
482 // int x = x;
483 //
484 // to deliberately leave a variable uninitialized. Different analysis
485 // clients can detect this pattern and adjust their reporting
486 // appropriately, but we need to continue to analyze subsequent uses
487 // of the variable.
488 DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(init->IgnoreParenImpCasts());
489 vals[vd] = (DRE && DRE->getDecl() == vd) ? Uninitialized
490 : Initialized;
Ted Kremenek610068c2011-01-15 02:58:47 +0000491 }
Chandler Carruthb88fb022011-04-05 21:36:30 +0000492 } else if (Stmt *init = vd->getInit()) {
Ted Kremenekc21fed32011-01-18 21:18:58 +0000493 Visit(init);
494 }
Ted Kremenek610068c2011-01-15 02:58:47 +0000495 }
496 }
497}
498
Ted Kremenekc21fed32011-01-18 21:18:58 +0000499void TransferFunctions::VisitDeclRefExpr(DeclRefExpr *dr) {
500 // We assume that DeclRefExprs wrapped in an lvalue-to-rvalue cast
501 // cannot be block-level expressions. Therefore, we determine if
502 // a DeclRefExpr is involved in a "load" by comparing it to the current
503 // DeclRefExpr found when analyzing the last lvalue-to-rvalue CastExpr.
504 // If a DeclRefExpr is not involved in a load, we are essentially computing
505 // its address, either for assignment to a reference or via the '&' operator.
506 // In such cases, treat the variable as being initialized, since this
507 // analysis isn't powerful enough to do alias tracking.
508 if (dr != currentDR)
509 if (const VarDecl *vd = dyn_cast<VarDecl>(dr->getDecl()))
510 if (isTrackedVar(vd))
511 vals[vd] = Initialized;
512}
513
Ted Kremenek610068c2011-01-15 02:58:47 +0000514void TransferFunctions::VisitBinaryOperator(clang::BinaryOperator *bo) {
Ted Kremenek610068c2011-01-15 02:58:47 +0000515 if (bo->isAssignmentOp()) {
516 const FindVarResult &res = findBlockVarDecl(bo->getLHS());
517 if (const VarDecl* vd = res.getDecl()) {
Ted Kremenekc21fed32011-01-18 21:18:58 +0000518 // We assume that DeclRefExprs wrapped in a BinaryOperator "assignment"
519 // cannot be block-level expressions. Therefore, we determine if
520 // a DeclRefExpr is involved in a "load" by comparing it to the current
521 // DeclRefExpr found when analyzing the last lvalue-to-rvalue CastExpr.
522 SaveAndRestore<const DeclRefExpr*> lastDR(currentDR,
523 res.getDeclRefExpr());
524 Visit(bo->getRHS());
525 Visit(bo->getLHS());
526
Ted Kremenek496398d2011-03-15 04:57:32 +0000527 ValueVector::reference val = vals[vd];
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000528 if (isUninitialized(val)) {
Ted Kremenek610068c2011-01-15 02:58:47 +0000529 if (bo->getOpcode() != BO_Assign)
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000530 reportUninit(res.getDeclRefExpr(), vd, isAlwaysUninit(val));
Ted Kremenek496398d2011-03-15 04:57:32 +0000531 val = Initialized;
Ted Kremenek610068c2011-01-15 02:58:47 +0000532 }
Ted Kremenekc21fed32011-01-18 21:18:58 +0000533 return;
Ted Kremenek610068c2011-01-15 02:58:47 +0000534 }
535 }
Ted Kremenekc21fed32011-01-18 21:18:58 +0000536 Visit(bo->getRHS());
537 Visit(bo->getLHS());
Ted Kremenek610068c2011-01-15 02:58:47 +0000538}
539
540void TransferFunctions::VisitUnaryOperator(clang::UnaryOperator *uo) {
Ted Kremenek610068c2011-01-15 02:58:47 +0000541 switch (uo->getOpcode()) {
Ted Kremenek610068c2011-01-15 02:58:47 +0000542 case clang::UO_PostDec:
543 case clang::UO_PostInc:
544 case clang::UO_PreDec:
545 case clang::UO_PreInc: {
546 const FindVarResult &res = findBlockVarDecl(uo->getSubExpr());
547 if (const VarDecl *vd = res.getDecl()) {
Ted Kremenekc21fed32011-01-18 21:18:58 +0000548 // We assume that DeclRefExprs wrapped in a unary operator ++/--
549 // cannot be block-level expressions. Therefore, we determine if
550 // a DeclRefExpr is involved in a "load" by comparing it to the current
551 // DeclRefExpr found when analyzing the last lvalue-to-rvalue CastExpr.
552 SaveAndRestore<const DeclRefExpr*> lastDR(currentDR,
553 res.getDeclRefExpr());
554 Visit(uo->getSubExpr());
555
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000556 ValueVector::reference val = vals[vd];
557 if (isUninitialized(val)) {
558 reportUninit(res.getDeclRefExpr(), vd, isAlwaysUninit(val));
559 // Don't cascade warnings.
560 val = Initialized;
Ted Kremenek610068c2011-01-15 02:58:47 +0000561 }
Ted Kremenekc21fed32011-01-18 21:18:58 +0000562 return;
Ted Kremenek610068c2011-01-15 02:58:47 +0000563 }
564 break;
565 }
566 default:
567 break;
568 }
Ted Kremenekc21fed32011-01-18 21:18:58 +0000569 Visit(uo->getSubExpr());
Ted Kremenek610068c2011-01-15 02:58:47 +0000570}
571
572void TransferFunctions::VisitCastExpr(clang::CastExpr *ce) {
Ted Kremenek610068c2011-01-15 02:58:47 +0000573 if (ce->getCastKind() == CK_LValueToRValue) {
574 const FindVarResult &res = findBlockVarDecl(ce->getSubExpr());
Ted Kremenekc21fed32011-01-18 21:18:58 +0000575 if (const VarDecl *vd = res.getDecl()) {
576 // We assume that DeclRefExprs wrapped in an lvalue-to-rvalue cast
577 // cannot be block-level expressions. Therefore, we determine if
578 // a DeclRefExpr is involved in a "load" by comparing it to the current
579 // DeclRefExpr found when analyzing the last lvalue-to-rvalue CastExpr.
580 // Here we update 'currentDR' to be the one associated with this
581 // lvalue-to-rvalue cast. Then, when we analyze the DeclRefExpr, we
582 // will know that we are not computing its lvalue for other purposes
583 // than to perform a load.
584 SaveAndRestore<const DeclRefExpr*> lastDR(currentDR,
585 res.getDeclRefExpr());
586 Visit(ce->getSubExpr());
Ted Kremenekf7bafc72011-03-15 04:57:38 +0000587 if (currentVoidCast != ce) {
588 Value val = vals[vd];
589 if (isUninitialized(val)) {
590 reportUninit(res.getDeclRefExpr(), vd, isAlwaysUninit(val));
591 // Don't cascade warnings.
592 vals[vd] = Initialized;
593 }
Ted Kremenekc21fed32011-01-18 21:18:58 +0000594 }
595 return;
596 }
Ted Kremenekdd0f7942011-01-26 04:49:43 +0000597 }
598 else if (CStyleCastExpr *cse = dyn_cast<CStyleCastExpr>(ce)) {
599 if (cse->getType()->isVoidType()) {
600 // e.g. (void) x;
601 SaveAndRestore<const Expr *>
602 lastVoidCast(currentVoidCast, cse->getSubExpr()->IgnoreParens());
603 Visit(cse->getSubExpr());
604 return;
605 }
606 }
Ted Kremenekc21fed32011-01-18 21:18:58 +0000607 Visit(ce->getSubExpr());
Ted Kremenek610068c2011-01-15 02:58:47 +0000608}
609
Peter Collingbournef4e3cfb2011-03-11 19:24:49 +0000610void TransferFunctions::VisitUnaryExprOrTypeTraitExpr(
611 UnaryExprOrTypeTraitExpr *se) {
612 if (se->getKind() == UETT_SizeOf) {
Ted Kremenek96608032011-01-23 17:53:04 +0000613 if (se->getType()->isConstantSizeType())
614 return;
615 // Handle VLAs.
616 Visit(se->getArgumentExpr());
617 }
618}
619
Chandler Carruth86684942011-04-13 08:18:42 +0000620void TransferFunctions::VisitCXXTypeidExpr(CXXTypeidExpr *E) {
621 // typeid(expression) is potentially evaluated when the argument is
622 // a glvalue of polymorphic type. (C++ 5.2.8p2-3)
623 if (!E->isTypeOperand() && E->Classify(ac.getASTContext()).isGLValue()) {
624 QualType SubExprTy = E->getExprOperand()->getType();
625 if (const RecordType *Record = SubExprTy->getAs<RecordType>())
626 if (cast<CXXRecordDecl>(Record->getDecl())->isPolymorphic())
627 Visit(E->getExprOperand());
628 }
629}
630
Ted Kremenek610068c2011-01-15 02:58:47 +0000631//------------------------------------------------------------------------====//
632// High-level "driver" logic for uninitialized values analysis.
633//====------------------------------------------------------------------------//
634
Ted Kremenek13bd4232011-01-20 17:37:17 +0000635static bool runOnBlock(const CFGBlock *block, const CFG &cfg,
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000636 AnalysisContext &ac, CFGBlockValues &vals,
Ted Kremenekf8adeef2011-04-04 20:30:58 +0000637 llvm::BitVector &wasAnalyzed,
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000638 UninitVariablesHandler *handler = 0,
639 bool flagBlockUses = false) {
Ted Kremenek13bd4232011-01-20 17:37:17 +0000640
Ted Kremenekf8adeef2011-04-04 20:30:58 +0000641 wasAnalyzed[block->getBlockID()] = true;
642
Ted Kremenek13bd4232011-01-20 17:37:17 +0000643 if (const BinaryOperator *b = getLogicalOperatorInChain(block)) {
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000644 CFGBlock::const_pred_iterator itr = block->pred_begin();
Ted Kremenek136f8f22011-03-15 04:57:27 +0000645 BVPair vA = vals.getValueVectors(*itr, false);
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000646 ++itr;
Ted Kremenek136f8f22011-03-15 04:57:27 +0000647 BVPair vB = vals.getValueVectors(*itr, false);
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000648
649 BVPair valsAB;
650
651 if (b->getOpcode() == BO_LAnd) {
652 // Merge the 'F' bits from the first and second.
653 vals.mergeIntoScratch(*(vA.second ? vA.second : vA.first), true);
654 vals.mergeIntoScratch(*(vB.second ? vB.second : vB.first), false);
655 valsAB.first = vA.first;
Ted Kremenek2d4bed12011-01-20 21:25:31 +0000656 valsAB.second = &vals.getScratch();
Ted Kremenek13bd4232011-01-20 17:37:17 +0000657 }
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000658 else {
659 // Merge the 'T' bits from the first and second.
660 assert(b->getOpcode() == BO_LOr);
661 vals.mergeIntoScratch(*vA.first, true);
662 vals.mergeIntoScratch(*vB.first, false);
663 valsAB.first = &vals.getScratch();
664 valsAB.second = vA.second ? vA.second : vA.first;
665 }
Ted Kremenek136f8f22011-03-15 04:57:27 +0000666 return vals.updateValueVectors(block, valsAB);
Ted Kremenek13bd4232011-01-20 17:37:17 +0000667 }
668
Ted Kremenek9fcbcee2011-02-01 17:43:18 +0000669 // Default behavior: merge in values of predecessor blocks.
Ted Kremenek610068c2011-01-15 02:58:47 +0000670 vals.resetScratch();
671 bool isFirst = true;
672 for (CFGBlock::const_pred_iterator I = block->pred_begin(),
673 E = block->pred_end(); I != E; ++I) {
Ted Kremenek136f8f22011-03-15 04:57:27 +0000674 vals.mergeIntoScratch(vals.getValueVector(*I, block), isFirst);
Ted Kremenek610068c2011-01-15 02:58:47 +0000675 isFirst = false;
676 }
677 // Apply the transfer function.
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000678 TransferFunctions tf(vals, cfg, ac, handler, flagBlockUses);
Ted Kremenek610068c2011-01-15 02:58:47 +0000679 for (CFGBlock::const_iterator I = block->begin(), E = block->end();
680 I != E; ++I) {
681 if (const CFGStmt *cs = dyn_cast<CFGStmt>(&*I)) {
682 tf.BlockStmt_Visit(cs->getStmt());
683 }
684 }
Ted Kremenek136f8f22011-03-15 04:57:27 +0000685 return vals.updateValueVectorWithScratch(block);
Ted Kremenek610068c2011-01-15 02:58:47 +0000686}
687
688void clang::runUninitializedVariablesAnalysis(const DeclContext &dc,
689 const CFG &cfg,
Ted Kremeneka8c17a52011-01-25 19:13:48 +0000690 AnalysisContext &ac,
Ted Kremenek610068c2011-01-15 02:58:47 +0000691 UninitVariablesHandler &handler) {
692 CFGBlockValues vals(cfg);
693 vals.computeSetOfDeclarations(dc);
694 if (vals.hasNoDeclarations())
695 return;
Ted Kremenekd40066b2011-04-04 23:29:12 +0000696
697 // Mark all variables uninitialized at the entry.
698 const CFGBlock &entry = cfg.getEntry();
699 for (CFGBlock::const_succ_iterator i = entry.succ_begin(),
700 e = entry.succ_end(); i != e; ++i) {
701 if (const CFGBlock *succ = *i) {
702 ValueVector &vec = vals.getValueVector(&entry, succ);
703 const unsigned n = vals.getNumEntries();
704 for (unsigned j = 0; j < n ; ++j) {
705 vec[j] = Uninitialized;
706 }
707 }
708 }
709
710 // Proceed with the workist.
Ted Kremenek610068c2011-01-15 02:58:47 +0000711 DataflowWorklist worklist(cfg);
Ted Kremenek496398d2011-03-15 04:57:32 +0000712 llvm::BitVector previouslyVisited(cfg.getNumBlockIDs());
Ted Kremenek610068c2011-01-15 02:58:47 +0000713 worklist.enqueueSuccessors(&cfg.getEntry());
Ted Kremenekf8adeef2011-04-04 20:30:58 +0000714 llvm::BitVector wasAnalyzed(cfg.getNumBlockIDs(), false);
Ted Kremenek610068c2011-01-15 02:58:47 +0000715
716 while (const CFGBlock *block = worklist.dequeue()) {
Ted Kremenek610068c2011-01-15 02:58:47 +0000717 // Did the block change?
Ted Kremenekf8adeef2011-04-04 20:30:58 +0000718 bool changed = runOnBlock(block, cfg, ac, vals, wasAnalyzed);
Ted Kremenek610068c2011-01-15 02:58:47 +0000719 if (changed || !previouslyVisited[block->getBlockID()])
720 worklist.enqueueSuccessors(block);
721 previouslyVisited[block->getBlockID()] = true;
722 }
723
724 // Run through the blocks one more time, and report uninitialized variabes.
725 for (CFG::const_iterator BI = cfg.begin(), BE = cfg.end(); BI != BE; ++BI) {
Ted Kremenekf8adeef2011-04-04 20:30:58 +0000726 if (wasAnalyzed[(*BI)->getBlockID()])
727 runOnBlock(*BI, cfg, ac, vals, wasAnalyzed, &handler,
728 /* flagBlockUses */ true);
Ted Kremenek610068c2011-01-15 02:58:47 +0000729 }
730}
731
732UninitVariablesHandler::~UninitVariablesHandler() {}
733