blob: ad72d27a82f8e2dc44f2333f9adeefe1b170a39e [file] [log] [blame]
Chris Lattnerbda0b622008-03-15 23:59:48 +00001// CFRefCount.cpp - Transfer functions for tracking simple values -*- C++ -*--//
Ted Kremenek2fff37e2008-03-06 00:08:09 +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//
Gabor Greif843e9342008-03-06 10:40:09 +000010// This file defines the methods for CFRefCount, which implements
Ted Kremenek2fff37e2008-03-06 00:08:09 +000011// a reference count checker for Core Foundation (Mac OS X).
12//
13//===----------------------------------------------------------------------===//
14
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000015#include "GRSimpleVals.h"
Ted Kremenek2fff37e2008-03-06 00:08:09 +000016#include "clang/Analysis/PathSensitive/ValueState.h"
Ted Kremenek4dc41cc2008-03-31 18:26:32 +000017#include "clang/Analysis/PathDiagnostic.h"
Ted Kremenek2fff37e2008-03-06 00:08:09 +000018#include "clang/Analysis/LocalCheckers.h"
Ted Kremenekfa34b332008-04-09 01:10:13 +000019#include "clang/Analysis/PathDiagnostic.h"
20#include "clang/Analysis/PathSensitive/BugReporter.h"
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000021#include "llvm/ADT/DenseMap.h"
22#include "llvm/ADT/FoldingSet.h"
23#include "llvm/ADT/ImmutableMap.h"
Ted Kremenekfa34b332008-04-09 01:10:13 +000024#include "llvm/Support/Compiler.h"
Ted Kremenekf3948042008-03-11 19:44:10 +000025#include <ostream>
Ted Kremenek2cf943a2008-04-18 04:55:01 +000026#include <sstream>
Ted Kremenek2fff37e2008-03-06 00:08:09 +000027
28using namespace clang;
29
Ted Kremenek05cbe1a2008-04-09 23:49:11 +000030//===----------------------------------------------------------------------===//
Ted Kremenek4fd88972008-04-17 18:12:53 +000031// Utility functions.
32//===----------------------------------------------------------------------===//
33
34static inline Selector GetUnarySelector(const char* name, ASTContext& Ctx) {
35 IdentifierInfo* II = &Ctx.Idents.get(name);
36 return Ctx.Selectors.getSelector(0, &II);
37}
38
39//===----------------------------------------------------------------------===//
Ted Kremenek05cbe1a2008-04-09 23:49:11 +000040// Symbolic Evaluation of Reference Counting Logic
41//===----------------------------------------------------------------------===//
42
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000043namespace {
44 enum ArgEffect { IncRef, DecRef, DoNothing };
Ted Kremenek891d5cc2008-04-24 17:22:33 +000045 typedef std::vector<std::pair<unsigned,ArgEffect> > ArgEffects;
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000046}
Ted Kremenek2fff37e2008-03-06 00:08:09 +000047
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000048namespace llvm {
49 template <> struct FoldingSetTrait<ArgEffects> {
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +000050 static void Profile(const ArgEffects& X, FoldingSetNodeID& ID) {
Ted Kremenek891d5cc2008-04-24 17:22:33 +000051 for (ArgEffects::const_iterator I = X.begin(), E = X.end(); I!= E; ++I) {
52 ID.AddInteger(I->first);
53 ID.AddInteger((unsigned) I->second);
54 }
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +000055 }
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000056 };
57} // end llvm namespace
58
59namespace {
Ted Kremenek2fff37e2008-03-06 00:08:09 +000060
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000061class RetEffect {
62public:
Ted Kremenek940b1d82008-04-10 23:44:06 +000063 enum Kind { NoRet = 0x0, Alias = 0x1, OwnedSymbol = 0x2,
64 NotOwnedSymbol = 0x3 };
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000065
66private:
67 unsigned Data;
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +000068 RetEffect(Kind k, unsigned D) { Data = (D << 2) | (unsigned) k; }
Ted Kremenek2fff37e2008-03-06 00:08:09 +000069
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000070public:
71
72 Kind getKind() const { return (Kind) (Data & 0x3); }
73
74 unsigned getValue() const {
75 assert(getKind() == Alias);
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +000076 return Data >> 2;
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000077 }
Ted Kremeneke7bd9c22008-04-11 22:25:11 +000078
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000079 static RetEffect MakeAlias(unsigned Idx) { return RetEffect(Alias, Idx); }
Ted Kremenek2fff37e2008-03-06 00:08:09 +000080
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000081 static RetEffect MakeOwned() { return RetEffect(OwnedSymbol, 0); }
Ted Kremenek2fff37e2008-03-06 00:08:09 +000082
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000083 static RetEffect MakeNotOwned() { return RetEffect(NotOwnedSymbol, 0); }
84
Ted Kremenek940b1d82008-04-10 23:44:06 +000085 static RetEffect MakeNoRet() { return RetEffect(NoRet, 0); }
86
Ted Kremenek6b3a0f72008-03-11 06:39:11 +000087 operator Kind() const { return getKind(); }
88
89 void Profile(llvm::FoldingSetNodeID& ID) const { ID.AddInteger(Data); }
90};
91
92
93class CFRefSummary : public llvm::FoldingSetNode {
94 ArgEffects* Args;
95 RetEffect Ret;
96public:
97
98 CFRefSummary(ArgEffects* A, RetEffect R) : Args(A), Ret(R) {}
99
100 unsigned getNumArgs() const { return Args->size(); }
101
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000102 ArgEffect getArg(unsigned idx) const {
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000103 if (!Args)
104 return DoNothing;
105
106 // If Args is present, it is likely to contain only 1 element.
107 // Just do a linear search. Do it from the back because functions with
108 // large numbers of arguments will be tail heavy with respect to which
109 // argument they actually modify with respect to the reference count.
110
111 for (ArgEffects::reverse_iterator I=Args->rbegin(), E=Args->rend();
112 I!=E; ++I) {
113
114 if (idx > I->first)
115 return DoNothing;
116
117 if (idx == I->first)
118 return I->second;
119 }
120
121 return DoNothing;
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000122 }
123
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000124 RetEffect getRet() const {
125 return Ret;
126 }
127
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000128 typedef ArgEffects::const_iterator arg_iterator;
129
130 arg_iterator begin_args() const { return Args->begin(); }
131 arg_iterator end_args() const { return Args->end(); }
132
133 static void Profile(llvm::FoldingSetNodeID& ID, ArgEffects* A, RetEffect R) {
134 ID.AddPointer(A);
135 ID.Add(R);
136 }
137
138 void Profile(llvm::FoldingSetNodeID& ID) const {
139 Profile(ID, Args, Ret);
140 }
141};
142
143
144class CFRefSummaryManager {
145 typedef llvm::FoldingSet<llvm::FoldingSetNodeWrapper<ArgEffects> > AESetTy;
146 typedef llvm::FoldingSet<CFRefSummary> SummarySetTy;
147 typedef llvm::DenseMap<FunctionDecl*, CFRefSummary*> SummaryMapTy;
148
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +0000149 ASTContext& Ctx;
150 SummarySetTy SummarySet;
151 SummaryMapTy SummaryMap;
152 AESetTy AESet;
153 llvm::BumpPtrAllocator BPAlloc;
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000154 ArgEffects ScratchArgs;
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000155
156 ArgEffects* getArgEffects();
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000157
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000158 CFRefSummary* getCannedCFSummary(FunctionTypeProto* FT, bool isRetain);
159
160 CFRefSummary* getCFSummary(FunctionDecl* FD, const char* FName);
161
162 CFRefSummary* getCFSummaryCreateRule(FunctionTypeProto* FT);
163 CFRefSummary* getCFSummaryGetRule(FunctionTypeProto* FT);
164
165 CFRefSummary* getPersistentSummary(ArgEffects* AE, RetEffect RE);
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000166
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000167public:
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +0000168 CFRefSummaryManager(ASTContext& ctx) : Ctx(ctx) {}
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000169 ~CFRefSummaryManager();
170
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000171 CFRefSummary* getSummary(FunctionDecl* FD, ASTContext& Ctx);
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000172};
173
174} // end anonymous namespace
175
176//===----------------------------------------------------------------------===//
177// Implementation of checker data structures.
178//===----------------------------------------------------------------------===//
179
180CFRefSummaryManager::~CFRefSummaryManager() {
181
182 // FIXME: The ArgEffects could eventually be allocated from BPAlloc,
183 // mitigating the need to do explicit cleanup of the
184 // Argument-Effect summaries.
185
186 for (AESetTy::iterator I = AESet.begin(), E = AESet.end(); I!=E; ++I)
187 I->getValue().~ArgEffects();
Ted Kremenek2fff37e2008-03-06 00:08:09 +0000188}
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000189
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000190ArgEffects* CFRefSummaryManager::getArgEffects() {
191
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000192 if (ScratchArgs.empty())
193 return NULL;
194
195 // Compute a profile for a non-empty ScratchArgs.
196
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000197 llvm::FoldingSetNodeID profile;
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000198
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000199 profile.Add(ScratchArgs);
200 void* InsertPos;
201
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000202 // Look up the uniqued copy, or create a new one.
203
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000204 llvm::FoldingSetNodeWrapper<ArgEffects>* E =
205 AESet.FindNodeOrInsertPos(profile, InsertPos);
206
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000207 if (E) {
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000208 ScratchArgs.clear();
209 return &E->getValue();
210 }
211
212 E = (llvm::FoldingSetNodeWrapper<ArgEffects>*)
213 BPAlloc.Allocate<llvm::FoldingSetNodeWrapper<ArgEffects> >();
214
215 new (E) llvm::FoldingSetNodeWrapper<ArgEffects>(ScratchArgs);
216 AESet.InsertNode(E, InsertPos);
217
218 ScratchArgs.clear();
219 return &E->getValue();
220}
221
222CFRefSummary* CFRefSummaryManager::getPersistentSummary(ArgEffects* AE,
223 RetEffect RE) {
224
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000225 // Generate a profile for the summary.
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000226 llvm::FoldingSetNodeID profile;
227 CFRefSummary::Profile(profile, AE, RE);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000228
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000229 // Look up the uniqued summary, or create one if it doesn't exist.
230 void* InsertPos;
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000231 CFRefSummary* Summ = SummarySet.FindNodeOrInsertPos(profile, InsertPos);
232
233 if (Summ)
234 return Summ;
235
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000236 // Create the summary and return it.
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000237 Summ = (CFRefSummary*) BPAlloc.Allocate<CFRefSummary>();
238 new (Summ) CFRefSummary(AE, RE);
239 SummarySet.InsertNode(Summ, InsertPos);
240
241 return Summ;
242}
243
244
245CFRefSummary* CFRefSummaryManager::getSummary(FunctionDecl* FD,
246 ASTContext& Ctx) {
247
248 SourceLocation Loc = FD->getLocation();
249
250 if (!Loc.isFileID())
251 return NULL;
Ted Kremenek2fff37e2008-03-06 00:08:09 +0000252
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000253
254 // Look up a summary in our cache of FunctionDecls -> Summaries.
255 SummaryMapTy::iterator I = SummaryMap.find(FD);
256
257 if (I != SummaryMap.end())
258 return I->second;
259
260 // No summary. Generate one.
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000261 const char* FName = FD->getIdentifier()->getName();
262
263 if (FName[0] == 'C' && FName[1] == 'F') {
264 CFRefSummary* S = getCFSummary(FD, FName);
265 SummaryMap[FD] = S;
266 return S;
267 }
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000268
269 // Function has no ref-count effects. Return the NULL summary.
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000270 return NULL;
Ted Kremenek2fff37e2008-03-06 00:08:09 +0000271}
272
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000273CFRefSummary* CFRefSummaryManager::getCFSummary(FunctionDecl* FD,
274 const char* FName) {
275
276 // For now, only generate summaries for functions that have a prototype.
277
278 FunctionTypeProto* FT =
279 dyn_cast<FunctionTypeProto>(FD->getType().getTypePtr());
280
281 if (!FT)
282 return NULL;
283
284 FName += 2;
285
286 if (strcmp(FName, "Retain") == 0)
287 return getCannedCFSummary(FT, true);
288
289 if (strcmp(FName, "Release") == 0)
290 return getCannedCFSummary(FT, false);
291
292 assert (ScratchArgs.empty());
293 bool usesCreateRule = false;
294
295 if (strstr(FName, "Create"))
296 usesCreateRule = true;
297
298 if (!usesCreateRule && strstr(FName, "Copy"))
299 usesCreateRule = true;
300
301 if (usesCreateRule)
302 return getCFSummaryCreateRule(FT);
303
304 if (strstr(FName, "Get"))
305 return getCFSummaryGetRule(FT);
306
307 return NULL;
308}
309
310CFRefSummary* CFRefSummaryManager::getCannedCFSummary(FunctionTypeProto* FT,
311 bool isRetain) {
312
313 if (FT->getNumArgs() != 1)
314 return NULL;
315
316 TypedefType* ArgT = dyn_cast<TypedefType>(FT->getArgType(0).getTypePtr());
317
318 if (!ArgT)
319 return NULL;
320
321 // For CFRetain/CFRelease, the first (and only) argument is of type
322 // "CFTypeRef".
323
324 const char* TDName = ArgT->getDecl()->getIdentifier()->getName();
325 assert (TDName);
326
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +0000327 if (strcmp("CFTypeRef", TDName) != 0)
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000328 return NULL;
329
330 if (!ArgT->isPointerType())
331 return NULL;
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +0000332
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000333 QualType RetTy = FT->getResultType();
334
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +0000335 if (isRetain) {
336 // CFRetain: the return type should also be "CFTypeRef".
337 if (RetTy.getTypePtr() != ArgT)
338 return NULL;
Ted Kremenek940b1d82008-04-10 23:44:06 +0000339
340 // The function's interface checks out. Generate a canned summary.
341 assert (ScratchArgs.empty());
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000342 ScratchArgs.push_back(std::make_pair(0, IncRef));
Ted Kremenek940b1d82008-04-10 23:44:06 +0000343 return getPersistentSummary(getArgEffects(), RetEffect::MakeAlias(0));
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +0000344 }
345 else {
346 // CFRelease: the return type should be void.
347
348 if (RetTy != Ctx.VoidTy)
349 return NULL;
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +0000350
Ted Kremenek940b1d82008-04-10 23:44:06 +0000351 assert (ScratchArgs.empty());
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000352 ScratchArgs.push_back(std::make_pair(0, DecRef));
Ted Kremenek940b1d82008-04-10 23:44:06 +0000353 return getPersistentSummary(getArgEffects(), RetEffect::MakeNoRet());
354 }
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000355}
356
357static bool isCFRefType(QualType T) {
358
359 if (!T->isPointerType())
360 return false;
361
362 // Check the typedef for the name "CF" and the substring "Ref".
363
364 TypedefType* TD = dyn_cast<TypedefType>(T.getTypePtr());
365
366 if (!TD)
367 return false;
368
369 const char* TDName = TD->getDecl()->getIdentifier()->getName();
370 assert (TDName);
371
372 if (TDName[0] != 'C' || TDName[1] != 'F')
373 return false;
374
375 if (strstr(TDName, "Ref") == 0)
376 return false;
377
378 return true;
379}
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000380
381CFRefSummary*
382CFRefSummaryManager::getCFSummaryCreateRule(FunctionTypeProto* FT) {
383
384 if (!isCFRefType(FT->getResultType()))
Ted Kremeneka0df99f2008-04-11 20:11:19 +0000385 return NULL;
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000386
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000387 // FIXME: Add special-cases for functions that retain/release. For now
388 // just handle the default case.
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000389
390 assert (ScratchArgs.empty());
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000391 return getPersistentSummary(getArgEffects(), RetEffect::MakeOwned());
392}
393
394CFRefSummary*
395CFRefSummaryManager::getCFSummaryGetRule(FunctionTypeProto* FT) {
396
Ted Kremeneka0df99f2008-04-11 20:11:19 +0000397 QualType RetTy = FT->getResultType();
398
399 // FIXME: For now we assume that all pointer types returned are referenced
400 // counted. Since this is the "Get" rule, we assume non-ownership, which
401 // works fine for things that are not reference counted. We do this because
402 // some generic data structures return "void*". We need something better
403 // in the future.
404
405 if (!isCFRefType(RetTy) && !RetTy->isPointerType())
406 return NULL;
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000407
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000408 // FIXME: Add special-cases for functions that retain/release. For now
409 // just handle the default case.
410
Ted Kremenek891d5cc2008-04-24 17:22:33 +0000411 assert (ScratchArgs.empty());
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000412 return getPersistentSummary(getArgEffects(), RetEffect::MakeNotOwned());
413}
414
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000415//===----------------------------------------------------------------------===//
Ted Kremenek13922612008-04-16 20:40:59 +0000416// Reference-counting logic (typestate + counts).
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000417//===----------------------------------------------------------------------===//
418
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000419namespace {
420
Ted Kremenek05cbe1a2008-04-09 23:49:11 +0000421class VISIBILITY_HIDDEN RefVal {
Ted Kremenek4fd88972008-04-17 18:12:53 +0000422public:
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000423
Ted Kremenek4fd88972008-04-17 18:12:53 +0000424 enum Kind {
425 Owned = 0, // Owning reference.
426 NotOwned, // Reference is not owned by still valid (not freed).
427 Released, // Object has been released.
428 ReturnedOwned, // Returned object passes ownership to caller.
429 ReturnedNotOwned, // Return object does not pass ownership to caller.
430 ErrorUseAfterRelease, // Object used after released.
431 ErrorReleaseNotOwned, // Release of an object that was not owned.
432 ErrorLeak // A memory leak due to excessive reference counts.
433 };
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000434
Ted Kremenek4fd88972008-04-17 18:12:53 +0000435private:
436
437 Kind kind;
438 unsigned Cnt;
439
440 RefVal(Kind k, unsigned cnt) : kind(k), Cnt(cnt) {}
441
442 RefVal(Kind k) : kind(k), Cnt(0) {}
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000443
444public:
Ted Kremenekdb863712008-04-16 22:32:20 +0000445
Ted Kremenek4fd88972008-04-17 18:12:53 +0000446 Kind getKind() const { return kind; }
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000447
Ted Kremenek4fd88972008-04-17 18:12:53 +0000448 unsigned getCount() const { return Cnt; }
449
450 // Useful predicates.
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000451
Ted Kremenek73c750b2008-03-11 18:14:09 +0000452 static bool isError(Kind k) { return k >= ErrorUseAfterRelease; }
453
Ted Kremenekdb863712008-04-16 22:32:20 +0000454 static bool isLeak(Kind k) { return k == ErrorLeak; }
455
Ted Kremeneke7bd9c22008-04-11 22:25:11 +0000456 bool isOwned() const {
457 return getKind() == Owned;
458 }
459
Ted Kremenekdb863712008-04-16 22:32:20 +0000460 bool isNotOwned() const {
461 return getKind() == NotOwned;
462 }
463
Ted Kremenek4fd88972008-04-17 18:12:53 +0000464 bool isReturnedOwned() const {
465 return getKind() == ReturnedOwned;
466 }
467
468 bool isReturnedNotOwned() const {
469 return getKind() == ReturnedNotOwned;
470 }
471
472 bool isNonLeakError() const {
473 Kind k = getKind();
474 return isError(k) && !isLeak(k);
475 }
476
477 // State creation: normal state.
478
Ted Kremenek61b9f872008-04-10 23:09:18 +0000479 static RefVal makeOwned(unsigned Count = 0) {
480 return RefVal(Owned, Count);
481 }
482
483 static RefVal makeNotOwned(unsigned Count = 0) {
484 return RefVal(NotOwned, Count);
485 }
Ted Kremenek4fd88972008-04-17 18:12:53 +0000486
487 static RefVal makeReturnedOwned(unsigned Count) {
488 return RefVal(ReturnedOwned, Count);
489 }
490
491 static RefVal makeReturnedNotOwned() {
492 return RefVal(ReturnedNotOwned);
493 }
494
495 // State creation: errors.
Ted Kremenek61b9f872008-04-10 23:09:18 +0000496
Ted Kremenekdb863712008-04-16 22:32:20 +0000497 static RefVal makeLeak() { return RefVal(ErrorLeak); }
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000498 static RefVal makeReleased() { return RefVal(Released); }
499 static RefVal makeUseAfterRelease() { return RefVal(ErrorUseAfterRelease); }
500 static RefVal makeReleaseNotOwned() { return RefVal(ErrorReleaseNotOwned); }
Ted Kremenek4fd88972008-04-17 18:12:53 +0000501
502 // Comparison, profiling, and pretty-printing.
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000503
Ted Kremenek4fd88972008-04-17 18:12:53 +0000504 bool operator==(const RefVal& X) const {
505 return kind == X.kind && Cnt == X.Cnt;
506 }
Ted Kremenekf3948042008-03-11 19:44:10 +0000507
Ted Kremenek4fd88972008-04-17 18:12:53 +0000508 void Profile(llvm::FoldingSetNodeID& ID) const {
509 ID.AddInteger((unsigned) kind);
510 ID.AddInteger(Cnt);
511 }
512
Ted Kremenekf3948042008-03-11 19:44:10 +0000513 void print(std::ostream& Out) const;
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000514};
Ted Kremenekf3948042008-03-11 19:44:10 +0000515
516void RefVal::print(std::ostream& Out) const {
517 switch (getKind()) {
518 default: assert(false);
Ted Kremenek61b9f872008-04-10 23:09:18 +0000519 case Owned: {
520 Out << "Owned";
521 unsigned cnt = getCount();
522 if (cnt) Out << " (+ " << cnt << ")";
Ted Kremenekf3948042008-03-11 19:44:10 +0000523 break;
Ted Kremenek61b9f872008-04-10 23:09:18 +0000524 }
Ted Kremenekf3948042008-03-11 19:44:10 +0000525
Ted Kremenek61b9f872008-04-10 23:09:18 +0000526 case NotOwned: {
Ted Kremenek4fd88972008-04-17 18:12:53 +0000527 Out << "NotOwned";
Ted Kremenek61b9f872008-04-10 23:09:18 +0000528 unsigned cnt = getCount();
529 if (cnt) Out << " (+ " << cnt << ")";
Ted Kremenekf3948042008-03-11 19:44:10 +0000530 break;
Ted Kremenek61b9f872008-04-10 23:09:18 +0000531 }
Ted Kremenekf3948042008-03-11 19:44:10 +0000532
Ted Kremenek4fd88972008-04-17 18:12:53 +0000533 case ReturnedOwned: {
534 Out << "ReturnedOwned";
535 unsigned cnt = getCount();
536 if (cnt) Out << " (+ " << cnt << ")";
537 break;
538 }
539
540 case ReturnedNotOwned: {
541 Out << "ReturnedNotOwned";
542 unsigned cnt = getCount();
543 if (cnt) Out << " (+ " << cnt << ")";
544 break;
545 }
546
Ted Kremenekf3948042008-03-11 19:44:10 +0000547 case Released:
548 Out << "Released";
549 break;
550
Ted Kremenekdb863712008-04-16 22:32:20 +0000551 case ErrorLeak:
552 Out << "Leaked";
553 break;
554
Ted Kremenekf3948042008-03-11 19:44:10 +0000555 case ErrorUseAfterRelease:
556 Out << "Use-After-Release [ERROR]";
557 break;
558
559 case ErrorReleaseNotOwned:
560 Out << "Release of Not-Owned [ERROR]";
561 break;
562 }
563}
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000564
Ted Kremenek13922612008-04-16 20:40:59 +0000565//===----------------------------------------------------------------------===//
566// Transfer functions.
567//===----------------------------------------------------------------------===//
568
Ted Kremenek05cbe1a2008-04-09 23:49:11 +0000569class VISIBILITY_HIDDEN CFRefCount : public GRSimpleVals {
Ted Kremenek8dd56462008-04-18 03:39:05 +0000570public:
Ted Kremenekf3948042008-03-11 19:44:10 +0000571 // Type definitions.
572
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000573 typedef llvm::ImmutableMap<SymbolID, RefVal> RefBindings;
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000574 typedef RefBindings::Factory RefBFactoryTy;
Ted Kremenek73c750b2008-03-11 18:14:09 +0000575
Ted Kremenek8dd56462008-04-18 03:39:05 +0000576 typedef llvm::DenseMap<GRExprEngine::NodeTy*,std::pair<Expr*, SymbolID> >
577 ReleasesNotOwnedTy;
578
579 typedef ReleasesNotOwnedTy UseAfterReleasesTy;
580
581 typedef llvm::DenseMap<GRExprEngine::NodeTy*, std::vector<SymbolID>*>
Ted Kremenekdb863712008-04-16 22:32:20 +0000582 LeaksTy;
Ted Kremenek8dd56462008-04-18 03:39:05 +0000583
Ted Kremenekf3948042008-03-11 19:44:10 +0000584 class BindingsPrinter : public ValueState::CheckerStatePrinter {
585 public:
586 virtual void PrintCheckerState(std::ostream& Out, void* State,
587 const char* nl, const char* sep);
588 };
Ted Kremenek8dd56462008-04-18 03:39:05 +0000589
590private:
Ted Kremenekf3948042008-03-11 19:44:10 +0000591 // Instance variables.
592
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000593 CFRefSummaryManager Summaries;
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000594 RefBFactoryTy RefBFactory;
595
Ted Kremenek73c750b2008-03-11 18:14:09 +0000596 UseAfterReleasesTy UseAfterReleases;
597 ReleasesNotOwnedTy ReleasesNotOwned;
Ted Kremenekdb863712008-04-16 22:32:20 +0000598 LeaksTy Leaks;
Ted Kremenek73c750b2008-03-11 18:14:09 +0000599
Ted Kremenekf3948042008-03-11 19:44:10 +0000600 BindingsPrinter Printer;
601
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000602 Selector RetainSelector;
603 Selector ReleaseSelector;
604
Ted Kremenek8dd56462008-04-18 03:39:05 +0000605public:
606
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000607 static RefBindings GetRefBindings(ValueState& StImpl) {
608 return RefBindings((RefBindings::TreeTy*) StImpl.CheckerState);
609 }
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000610
Ted Kremenek8dd56462008-04-18 03:39:05 +0000611private:
612
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000613 static void SetRefBindings(ValueState& StImpl, RefBindings B) {
614 StImpl.CheckerState = B.getRoot();
615 }
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000616
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000617 RefBindings Remove(RefBindings B, SymbolID sym) {
618 return RefBFactory.Remove(B, sym);
619 }
620
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000621 RefBindings Update(RefBindings B, SymbolID sym, RefVal V, ArgEffect E,
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000622 RefVal::Kind& hasErr);
623
Ted Kremenekdb863712008-04-16 22:32:20 +0000624 void ProcessNonLeakError(ExplodedNodeSet<ValueState>& Dst,
625 GRStmtNodeBuilder<ValueState>& Builder,
626 Expr* NodeExpr, Expr* ErrorExpr,
627 ExplodedNode<ValueState>* Pred,
628 ValueState* St,
Ted Kremenek8dd56462008-04-18 03:39:05 +0000629 RefVal::Kind hasErr, SymbolID Sym);
Ted Kremenekdb863712008-04-16 22:32:20 +0000630
631 ValueState* HandleSymbolDeath(ValueStateManager& VMgr, ValueState* St,
632 SymbolID sid, RefVal V, bool& hasLeak);
633
634 ValueState* NukeBinding(ValueStateManager& VMgr, ValueState* St,
635 SymbolID sid);
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000636
637public:
Ted Kremenek13922612008-04-16 20:40:59 +0000638
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000639 CFRefCount(ASTContext& Ctx)
640 : Summaries(Ctx),
641 RetainSelector(GetUnarySelector("retain", Ctx)),
642 ReleaseSelector(GetUnarySelector("release", Ctx)) {}
643
Ted Kremenek8dd56462008-04-18 03:39:05 +0000644 virtual ~CFRefCount() {
645 for (LeaksTy::iterator I = Leaks.begin(), E = Leaks.end(); I!=E; ++I)
646 delete I->second;
647 }
Ted Kremenek05cbe1a2008-04-09 23:49:11 +0000648
649 virtual void RegisterChecks(GRExprEngine& Eng);
Ted Kremenekf3948042008-03-11 19:44:10 +0000650
651 virtual ValueState::CheckerStatePrinter* getCheckerStatePrinter() {
652 return &Printer;
653 }
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000654
655 // Calls.
656
657 virtual void EvalCall(ExplodedNodeSet<ValueState>& Dst,
Ted Kremenek199e1a02008-03-12 21:06:49 +0000658 GRExprEngine& Eng,
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000659 GRStmtNodeBuilder<ValueState>& Builder,
Ted Kremenek186350f2008-04-23 20:12:28 +0000660 CallExpr* CE, RVal L,
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000661 ExplodedNode<ValueState>* Pred);
Ted Kremenekfa34b332008-04-09 01:10:13 +0000662
Ted Kremenek85348202008-04-15 23:44:31 +0000663 virtual void EvalObjCMessageExpr(ExplodedNodeSet<ValueState>& Dst,
664 GRExprEngine& Engine,
665 GRStmtNodeBuilder<ValueState>& Builder,
666 ObjCMessageExpr* ME,
667 ExplodedNode<ValueState>* Pred);
668
669 bool EvalObjCMessageExprAux(ExplodedNodeSet<ValueState>& Dst,
670 GRExprEngine& Engine,
671 GRStmtNodeBuilder<ValueState>& Builder,
672 ObjCMessageExpr* ME,
673 ExplodedNode<ValueState>* Pred);
674
Ted Kremenek13922612008-04-16 20:40:59 +0000675 // Stores.
676
677 virtual void EvalStore(ExplodedNodeSet<ValueState>& Dst,
678 GRExprEngine& Engine,
679 GRStmtNodeBuilder<ValueState>& Builder,
680 Expr* E, ExplodedNode<ValueState>* Pred,
681 ValueState* St, RVal TargetLV, RVal Val);
Ted Kremeneke7bd9c22008-04-11 22:25:11 +0000682 // End-of-path.
683
684 virtual void EvalEndPath(GRExprEngine& Engine,
685 GREndPathNodeBuilder<ValueState>& Builder);
686
Ted Kremenek652adc62008-04-24 23:57:27 +0000687 virtual void EvalDeadSymbols(ExplodedNodeSet<ValueState>& Dst,
688 GRExprEngine& Engine,
689 GRStmtNodeBuilder<ValueState>& Builder,
Ted Kremenek910e9992008-04-25 01:25:15 +0000690 ExplodedNode<ValueState>* Pred,
691 Stmt* S,
Ted Kremenek652adc62008-04-24 23:57:27 +0000692 ValueState* St,
693 const ValueStateManager::DeadSymbolsTy& Dead);
Ted Kremenek4fd88972008-04-17 18:12:53 +0000694 // Return statements.
695
696 virtual void EvalReturn(ExplodedNodeSet<ValueState>& Dst,
697 GRExprEngine& Engine,
698 GRStmtNodeBuilder<ValueState>& Builder,
699 ReturnStmt* S,
700 ExplodedNode<ValueState>* Pred);
Ted Kremenekcb612922008-04-18 19:23:43 +0000701
702 // Assumptions.
703
704 virtual ValueState* EvalAssume(GRExprEngine& Engine, ValueState* St,
705 RVal Cond, bool Assumption, bool& isFeasible);
706
Ted Kremenekfa34b332008-04-09 01:10:13 +0000707 // Error iterators.
708
709 typedef UseAfterReleasesTy::iterator use_after_iterator;
710 typedef ReleasesNotOwnedTy::iterator bad_release_iterator;
Ted Kremenek989d5192008-04-17 23:43:50 +0000711 typedef LeaksTy::iterator leaks_iterator;
Ted Kremenekfa34b332008-04-09 01:10:13 +0000712
Ted Kremenek05cbe1a2008-04-09 23:49:11 +0000713 use_after_iterator use_after_begin() { return UseAfterReleases.begin(); }
714 use_after_iterator use_after_end() { return UseAfterReleases.end(); }
Ted Kremenekfa34b332008-04-09 01:10:13 +0000715
Ted Kremenek05cbe1a2008-04-09 23:49:11 +0000716 bad_release_iterator bad_release_begin() { return ReleasesNotOwned.begin(); }
717 bad_release_iterator bad_release_end() { return ReleasesNotOwned.end(); }
Ted Kremenek989d5192008-04-17 23:43:50 +0000718
719 leaks_iterator leaks_begin() { return Leaks.begin(); }
720 leaks_iterator leaks_end() { return Leaks.end(); }
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000721};
722
723} // end anonymous namespace
724
Ted Kremenek8dd56462008-04-18 03:39:05 +0000725
Ted Kremenek05cbe1a2008-04-09 23:49:11 +0000726
727
Ted Kremenekf3948042008-03-11 19:44:10 +0000728void CFRefCount::BindingsPrinter::PrintCheckerState(std::ostream& Out,
729 void* State, const char* nl,
730 const char* sep) {
731 RefBindings B((RefBindings::TreeTy*) State);
732
733 if (State)
734 Out << sep << nl;
735
736 for (RefBindings::iterator I=B.begin(), E=B.end(); I!=E; ++I) {
737 Out << (*I).first << " : ";
738 (*I).second.print(Out);
739 Out << nl;
740 }
741}
742
Ted Kremenekf9561e52008-04-11 20:23:24 +0000743static inline ArgEffect GetArgE(CFRefSummary* Summ, unsigned idx) {
744 return Summ ? Summ->getArg(idx) : DoNothing;
745}
746
747static inline RetEffect GetRetE(CFRefSummary* Summ) {
748 return Summ ? Summ->getRet() : RetEffect::MakeNoRet();
749}
750
Ted Kremenekdb863712008-04-16 22:32:20 +0000751void CFRefCount::ProcessNonLeakError(ExplodedNodeSet<ValueState>& Dst,
752 GRStmtNodeBuilder<ValueState>& Builder,
753 Expr* NodeExpr, Expr* ErrorExpr,
754 ExplodedNode<ValueState>* Pred,
755 ValueState* St,
Ted Kremenek8dd56462008-04-18 03:39:05 +0000756 RefVal::Kind hasErr, SymbolID Sym) {
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000757 Builder.BuildSinks = true;
758 GRExprEngine::NodeTy* N = Builder.MakeNode(Dst, NodeExpr, Pred, St);
759
760 if (!N) return;
761
762 switch (hasErr) {
763 default: assert(false);
764 case RefVal::ErrorUseAfterRelease:
Ted Kremenek8dd56462008-04-18 03:39:05 +0000765 UseAfterReleases[N] = std::make_pair(ErrorExpr, Sym);
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000766 break;
767
768 case RefVal::ErrorReleaseNotOwned:
Ted Kremenek8dd56462008-04-18 03:39:05 +0000769 ReleasesNotOwned[N] = std::make_pair(ErrorExpr, Sym);
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000770 break;
771 }
772}
773
Ted Kremenek2fff37e2008-03-06 00:08:09 +0000774void CFRefCount::EvalCall(ExplodedNodeSet<ValueState>& Dst,
Ted Kremenek199e1a02008-03-12 21:06:49 +0000775 GRExprEngine& Eng,
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000776 GRStmtNodeBuilder<ValueState>& Builder,
Ted Kremenek186350f2008-04-23 20:12:28 +0000777 CallExpr* CE, RVal L,
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000778 ExplodedNode<ValueState>* Pred) {
779
Ted Kremenek199e1a02008-03-12 21:06:49 +0000780 ValueStateManager& StateMgr = Eng.getStateManager();
Ted Kremenek2fff37e2008-03-06 00:08:09 +0000781
Ted Kremenek7ded73c2008-04-14 17:45:13 +0000782 CFRefSummary* Summ = NULL;
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000783
784 // Get the summary.
Ted Kremenek2fff37e2008-03-06 00:08:09 +0000785
Ted Kremenek7ded73c2008-04-14 17:45:13 +0000786 if (isa<lval::FuncVal>(L)) {
787 lval::FuncVal FV = cast<lval::FuncVal>(L);
788 FunctionDecl* FD = FV.getDecl();
789 Summ = Summaries.getSummary(FD, Eng.getContext());
790 }
Ted Kremenek2fff37e2008-03-06 00:08:09 +0000791
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000792 // Get the state.
793
794 ValueState* St = Builder.GetState(Pred);
795
796 // Evaluate the effects of the call.
797
798 ValueState StVals = *St;
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000799 RefVal::Kind hasErr = (RefVal::Kind) 0;
Ted Kremenekf9561e52008-04-11 20:23:24 +0000800
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000801 // This function has a summary. Evaluate the effect of the arguments.
802
803 unsigned idx = 0;
804
Ted Kremenekbcf50ad2008-04-11 18:40:51 +0000805 Expr* ErrorExpr = NULL;
Ted Kremenek8dd56462008-04-18 03:39:05 +0000806 SymbolID ErrorSym = 0;
Ted Kremenekbcf50ad2008-04-11 18:40:51 +0000807
808 for (CallExpr::arg_iterator I = CE->arg_begin(), E = CE->arg_end();
809 I != E; ++I, ++idx) {
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000810
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000811 RVal V = StateMgr.GetRVal(St, *I);
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000812
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000813 if (isa<lval::SymbolVal>(V)) {
814 SymbolID Sym = cast<lval::SymbolVal>(V).getSymbol();
Ted Kremenekf9561e52008-04-11 20:23:24 +0000815 RefBindings B = GetRefBindings(StVals);
816
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000817 if (RefBindings::TreeTy* T = B.SlimFind(Sym)) {
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000818 B = Update(B, Sym, T->getValue().second, GetArgE(Summ, idx), hasErr);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000819 SetRefBindings(StVals, B);
Ted Kremenekbcf50ad2008-04-11 18:40:51 +0000820
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000821 if (hasErr) {
Ted Kremenekbcf50ad2008-04-11 18:40:51 +0000822 ErrorExpr = *I;
Ted Kremenek8dd56462008-04-18 03:39:05 +0000823 ErrorSym = T->getValue().first;
Ted Kremenekbcf50ad2008-04-11 18:40:51 +0000824 break;
825 }
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000826 }
Ted Kremenekb8873552008-04-11 20:51:02 +0000827 }
828 else if (isa<LVal>(V)) { // Nuke all arguments passed by reference.
829
830 // FIXME: This is basically copy-and-paste from GRSimpleVals. We
831 // should compose behavior, not copy it.
Ted Kremenekf9561e52008-04-11 20:23:24 +0000832 StateMgr.Unbind(StVals, cast<LVal>(V));
Ted Kremenekb8873552008-04-11 20:51:02 +0000833 }
Ted Kremeneka5488462008-04-22 21:39:21 +0000834 else if (isa<nonlval::LValAsInteger>(V))
835 StateMgr.Unbind(StVals, cast<nonlval::LValAsInteger>(V).getLVal());
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000836 }
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000837
838 St = StateMgr.getPersistentState(StVals);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000839
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000840 if (hasErr) {
Ted Kremenek8dd56462008-04-18 03:39:05 +0000841 ProcessNonLeakError(Dst, Builder, CE, ErrorExpr, Pred, St,
842 hasErr, ErrorSym);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000843 return;
Ted Kremenek1ac08d62008-03-11 17:48:22 +0000844 }
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000845
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000846 // Finally, consult the summary for the return value.
847
Ted Kremenekf9561e52008-04-11 20:23:24 +0000848 RetEffect RE = GetRetE(Summ);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000849
850 switch (RE.getKind()) {
851 default:
852 assert (false && "Unhandled RetEffect."); break;
853
Ted Kremenek940b1d82008-04-10 23:44:06 +0000854 case RetEffect::NoRet:
Ted Kremenekf9561e52008-04-11 20:23:24 +0000855
856 // Make up a symbol for the return value (not reference counted).
Ted Kremenekb8873552008-04-11 20:51:02 +0000857 // FIXME: This is basically copy-and-paste from GRSimpleVals. We
858 // should compose behavior, not copy it.
Ted Kremenekf9561e52008-04-11 20:23:24 +0000859
860 if (CE->getType() != Eng.getContext().VoidTy) {
861 unsigned Count = Builder.getCurrentBlockCount();
862 SymbolID Sym = Eng.getSymbolManager().getConjuredSymbol(CE, Count);
863
864 RVal X = CE->getType()->isPointerType()
865 ? cast<RVal>(lval::SymbolVal(Sym))
866 : cast<RVal>(nonlval::SymbolVal(Sym));
867
868 St = StateMgr.SetRVal(St, CE, X, Eng.getCFG().isBlkExpr(CE), false);
869 }
870
Ted Kremenek940b1d82008-04-10 23:44:06 +0000871 break;
872
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000873 case RetEffect::Alias: {
874 unsigned idx = RE.getValue();
875 assert (idx < CE->getNumArgs());
876 RVal V = StateMgr.GetRVal(St, CE->getArg(idx));
Ted Kremenek199e1a02008-03-12 21:06:49 +0000877 St = StateMgr.SetRVal(St, CE, V, Eng.getCFG().isBlkExpr(CE), false);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000878 break;
879 }
880
881 case RetEffect::OwnedSymbol: {
882 unsigned Count = Builder.getCurrentBlockCount();
Ted Kremenek361fa8e2008-03-12 21:45:47 +0000883 SymbolID Sym = Eng.getSymbolManager().getConjuredSymbol(CE, Count);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000884
885 ValueState StImpl = *St;
886 RefBindings B = GetRefBindings(StImpl);
Ted Kremenek61b9f872008-04-10 23:09:18 +0000887 SetRefBindings(StImpl, RefBFactory.Add(B, Sym, RefVal::makeOwned()));
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000888
889 St = StateMgr.SetRVal(StateMgr.getPersistentState(StImpl),
890 CE, lval::SymbolVal(Sym),
Ted Kremenek199e1a02008-03-12 21:06:49 +0000891 Eng.getCFG().isBlkExpr(CE), false);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000892
893 break;
894 }
895
896 case RetEffect::NotOwnedSymbol: {
897 unsigned Count = Builder.getCurrentBlockCount();
Ted Kremenek361fa8e2008-03-12 21:45:47 +0000898 SymbolID Sym = Eng.getSymbolManager().getConjuredSymbol(CE, Count);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000899
900 ValueState StImpl = *St;
901 RefBindings B = GetRefBindings(StImpl);
902 SetRefBindings(StImpl, RefBFactory.Add(B, Sym, RefVal::makeNotOwned()));
903
904 St = StateMgr.SetRVal(StateMgr.getPersistentState(StImpl),
905 CE, lval::SymbolVal(Sym),
Ted Kremenek199e1a02008-03-12 21:06:49 +0000906 Eng.getCFG().isBlkExpr(CE), false);
Ted Kremenek00a3a5f2008-03-12 01:21:45 +0000907
908 break;
909 }
910 }
911
Ted Kremenek0e561a32008-03-21 21:30:14 +0000912 Builder.MakeNode(Dst, CE, Pred, St);
Ted Kremenek2fff37e2008-03-06 00:08:09 +0000913}
Ted Kremenek6b3a0f72008-03-11 06:39:11 +0000914
Ted Kremenek85348202008-04-15 23:44:31 +0000915
916void CFRefCount::EvalObjCMessageExpr(ExplodedNodeSet<ValueState>& Dst,
917 GRExprEngine& Eng,
918 GRStmtNodeBuilder<ValueState>& Builder,
919 ObjCMessageExpr* ME,
920 ExplodedNode<ValueState>* Pred) {
921
922 if (EvalObjCMessageExprAux(Dst, Eng, Builder, ME, Pred))
923 GRSimpleVals::EvalObjCMessageExpr(Dst, Eng, Builder, ME, Pred);
924}
925
926bool CFRefCount::EvalObjCMessageExprAux(ExplodedNodeSet<ValueState>& Dst,
927 GRExprEngine& Eng,
928 GRStmtNodeBuilder<ValueState>& Builder,
929 ObjCMessageExpr* ME,
930 ExplodedNode<ValueState>* Pred) {
931
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000932 // Handle "toll-free bridging" of calls to "Release" and "Retain".
933
934 // FIXME: track the underlying object type associated so that we can
935 // flag illegal uses of toll-free bridging (or at least handle it
936 // at casts).
Ted Kremenek85348202008-04-15 23:44:31 +0000937
938 Selector S = ME->getSelector();
939
940 if (!S.isUnarySelector())
941 return true;
942
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000943 Expr* Receiver = ME->getReceiver();
944
945 if (!Receiver)
946 return true;
947
948 // Check if we are calling "Retain" or "Release".
949
950 bool isRetain = false;
951
952 if (S == RetainSelector)
953 isRetain = true;
954 else if (S != ReleaseSelector)
955 return true;
956
957 // We have "Retain" or "Release". Get the reference binding.
958
959 ValueStateManager& StateMgr = Eng.getStateManager();
960 ValueState* St = Builder.GetState(Pred);
961 RVal V = StateMgr.GetRVal(St, Receiver);
962
963 if (!isa<lval::SymbolVal>(V))
964 return true;
965
966 SymbolID Sym = cast<lval::SymbolVal>(V).getSymbol();
967 RefBindings B = GetRefBindings(*St);
968
969 RefBindings::TreeTy* T = B.SlimFind(Sym);
970
971 if (!T)
972 return true;
973
974 RefVal::Kind hasErr = (RefVal::Kind) 0;
975 B = Update(B, Sym, T->getValue().second, isRetain ? IncRef : DecRef, hasErr);
976
977 // Create a new state with the updated bindings.
978
979 ValueState StVals = *St;
980 SetRefBindings(StVals, B);
981 St = StateMgr.getPersistentState(StVals);
982
983 // Create an error node if it exists.
984
985 if (hasErr)
Ted Kremenek8dd56462008-04-18 03:39:05 +0000986 ProcessNonLeakError(Dst, Builder, ME, Receiver, Pred, St, hasErr, Sym);
Ted Kremenek9ed18e62008-04-16 04:28:53 +0000987 else
988 Builder.MakeNode(Dst, ME, Pred, St);
989
990 return false;
Ted Kremenek85348202008-04-15 23:44:31 +0000991}
992
Ted Kremenek13922612008-04-16 20:40:59 +0000993// Stores.
994
995void CFRefCount::EvalStore(ExplodedNodeSet<ValueState>& Dst,
996 GRExprEngine& Eng,
997 GRStmtNodeBuilder<ValueState>& Builder,
998 Expr* E, ExplodedNode<ValueState>* Pred,
999 ValueState* St, RVal TargetLV, RVal Val) {
1000
1001 // Check if we have a binding for "Val" and if we are storing it to something
1002 // we don't understand or otherwise the value "escapes" the function.
1003
1004 if (!isa<lval::SymbolVal>(Val))
1005 return;
1006
1007 // Are we storing to something that causes the value to "escape"?
1008
1009 bool escapes = false;
1010
1011 if (!isa<lval::DeclVal>(TargetLV))
1012 escapes = true;
1013 else
1014 escapes = cast<lval::DeclVal>(TargetLV).getDecl()->hasGlobalStorage();
1015
1016 if (!escapes)
1017 return;
1018
1019 SymbolID Sym = cast<lval::SymbolVal>(Val).getSymbol();
1020 RefBindings B = GetRefBindings(*St);
1021 RefBindings::TreeTy* T = B.SlimFind(Sym);
1022
1023 if (!T)
1024 return;
1025
Ted Kremenekdb863712008-04-16 22:32:20 +00001026 // Nuke the binding.
1027 St = NukeBinding(Eng.getStateManager(), St, Sym);
Ted Kremenek13922612008-04-16 20:40:59 +00001028
1029 // Hand of the remaining logic to the parent implementation.
1030 GRSimpleVals::EvalStore(Dst, Eng, Builder, E, Pred, St, TargetLV, Val);
1031}
1032
Ted Kremenekdb863712008-04-16 22:32:20 +00001033
1034ValueState* CFRefCount::NukeBinding(ValueStateManager& VMgr, ValueState* St,
1035 SymbolID sid) {
1036 ValueState StImpl = *St;
1037 RefBindings B = GetRefBindings(StImpl);
1038 StImpl.CheckerState = RefBFactory.Remove(B, sid).getRoot();
1039 return VMgr.getPersistentState(StImpl);
1040}
1041
Ted Kremeneke7bd9c22008-04-11 22:25:11 +00001042// End-of-path.
1043
Ted Kremenekdb863712008-04-16 22:32:20 +00001044ValueState* CFRefCount::HandleSymbolDeath(ValueStateManager& VMgr,
1045 ValueState* St, SymbolID sid,
1046 RefVal V, bool& hasLeak) {
1047
Ted Kremenek4fd88972008-04-17 18:12:53 +00001048 hasLeak = V.isOwned() ||
1049 ((V.isNotOwned() || V.isReturnedOwned()) && V.getCount() > 0);
Ted Kremenekdb863712008-04-16 22:32:20 +00001050
1051 if (!hasLeak)
1052 return NukeBinding(VMgr, St, sid);
1053
1054 RefBindings B = GetRefBindings(*St);
1055 ValueState StImpl = *St;
1056 StImpl.CheckerState = RefBFactory.Add(B, sid, RefVal::makeLeak()).getRoot();
1057 return VMgr.getPersistentState(StImpl);
1058}
1059
1060void CFRefCount::EvalEndPath(GRExprEngine& Eng,
Ted Kremeneke7bd9c22008-04-11 22:25:11 +00001061 GREndPathNodeBuilder<ValueState>& Builder) {
1062
Ted Kremenekdb863712008-04-16 22:32:20 +00001063 ValueState* St = Builder.getState();
1064 RefBindings B = GetRefBindings(*St);
Ted Kremeneke7bd9c22008-04-11 22:25:11 +00001065
Ted Kremenekdb863712008-04-16 22:32:20 +00001066 llvm::SmallVector<SymbolID, 10> Leaked;
Ted Kremeneke7bd9c22008-04-11 22:25:11 +00001067
Ted Kremenekdb863712008-04-16 22:32:20 +00001068 for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) {
1069 bool hasLeak = false;
Ted Kremeneke7bd9c22008-04-11 22:25:11 +00001070
Ted Kremenekdb863712008-04-16 22:32:20 +00001071 St = HandleSymbolDeath(Eng.getStateManager(), St,
1072 (*I).first, (*I).second, hasLeak);
1073
1074 if (hasLeak) Leaked.push_back((*I).first);
1075 }
Ted Kremenek652adc62008-04-24 23:57:27 +00001076
1077 if (Leaked.empty())
1078 return;
1079
Ted Kremenek8dd56462008-04-18 03:39:05 +00001080 ExplodedNode<ValueState>* N = Builder.MakeNode(St);
Ted Kremenek4f285152008-04-18 16:30:14 +00001081
Ted Kremenek652adc62008-04-24 23:57:27 +00001082 if (!N)
Ted Kremenek4f285152008-04-18 16:30:14 +00001083 return;
Ted Kremenekcb612922008-04-18 19:23:43 +00001084
Ted Kremenek8dd56462008-04-18 03:39:05 +00001085 std::vector<SymbolID>*& LeaksAtNode = Leaks[N];
1086 assert (!LeaksAtNode);
1087 LeaksAtNode = new std::vector<SymbolID>();
Ted Kremenekdb863712008-04-16 22:32:20 +00001088
1089 for (llvm::SmallVector<SymbolID, 10>::iterator I=Leaked.begin(),
1090 E = Leaked.end(); I != E; ++I)
Ted Kremenek8dd56462008-04-18 03:39:05 +00001091 (*LeaksAtNode).push_back(*I);
Ted Kremeneke7bd9c22008-04-11 22:25:11 +00001092}
1093
Ted Kremenek652adc62008-04-24 23:57:27 +00001094// Dead symbols.
1095
1096void CFRefCount::EvalDeadSymbols(ExplodedNodeSet<ValueState>& Dst,
1097 GRExprEngine& Eng,
1098 GRStmtNodeBuilder<ValueState>& Builder,
Ted Kremenek910e9992008-04-25 01:25:15 +00001099 ExplodedNode<ValueState>* Pred,
1100 Stmt* S,
Ted Kremenek652adc62008-04-24 23:57:27 +00001101 ValueState* St,
1102 const ValueStateManager::DeadSymbolsTy& Dead) {
Ted Kremenek910e9992008-04-25 01:25:15 +00001103
Ted Kremenek652adc62008-04-24 23:57:27 +00001104 // FIXME: a lot of copy-and-paste from EvalEndPath. Refactor.
1105
1106 RefBindings B = GetRefBindings(*St);
1107 llvm::SmallVector<SymbolID, 10> Leaked;
1108
1109 for (ValueStateManager::DeadSymbolsTy::const_iterator
1110 I=Dead.begin(), E=Dead.end(); I!=E; ++I) {
1111
1112 RefBindings::TreeTy* T = B.SlimFind(*I);
1113
1114 if (!T)
1115 continue;
1116
1117 bool hasLeak = false;
1118
1119 St = HandleSymbolDeath(Eng.getStateManager(), St,
1120 *I, T->getValue().second, hasLeak);
1121
1122 if (hasLeak) Leaked.push_back(*I);
1123 }
1124
1125 if (Leaked.empty())
1126 return;
1127
1128 ExplodedNode<ValueState>* N = Builder.MakeNode(Dst, S, Pred, St);
1129
1130 if (!N)
1131 return;
1132
1133 std::vector<SymbolID>*& LeaksAtNode = Leaks[N];
1134 assert (!LeaksAtNode);
1135 LeaksAtNode = new std::vector<SymbolID>();
1136
1137 for (llvm::SmallVector<SymbolID, 10>::iterator I=Leaked.begin(),
1138 E = Leaked.end(); I != E; ++I)
1139 (*LeaksAtNode).push_back(*I);
1140}
1141
Ted Kremenek4fd88972008-04-17 18:12:53 +00001142 // Return statements.
1143
1144void CFRefCount::EvalReturn(ExplodedNodeSet<ValueState>& Dst,
1145 GRExprEngine& Eng,
1146 GRStmtNodeBuilder<ValueState>& Builder,
1147 ReturnStmt* S,
1148 ExplodedNode<ValueState>* Pred) {
1149
1150 Expr* RetE = S->getRetValue();
1151 if (!RetE) return;
1152
1153 ValueStateManager& StateMgr = Eng.getStateManager();
1154 ValueState* St = Builder.GetState(Pred);
1155 RVal V = StateMgr.GetRVal(St, RetE);
1156
1157 if (!isa<lval::SymbolVal>(V))
1158 return;
1159
1160 // Get the reference count binding (if any).
1161 SymbolID Sym = cast<lval::SymbolVal>(V).getSymbol();
1162 RefBindings B = GetRefBindings(*St);
1163 RefBindings::TreeTy* T = B.SlimFind(Sym);
1164
1165 if (!T)
1166 return;
1167
1168 // Change the reference count.
1169
1170 RefVal X = T->getValue().second;
1171
1172 switch (X.getKind()) {
1173
1174 case RefVal::Owned: {
1175 unsigned cnt = X.getCount();
1176 X = RefVal::makeReturnedOwned(cnt);
1177 break;
1178 }
1179
1180 case RefVal::NotOwned: {
1181 unsigned cnt = X.getCount();
1182 X = cnt ? RefVal::makeReturnedOwned(cnt - 1)
1183 : RefVal::makeReturnedNotOwned();
1184 break;
1185 }
1186
1187 default:
1188 // None of the error states should be possible at this point.
1189 // A symbol could not have been leaked (yet) if we are returning it
1190 // (and thus it is still live), and the other errors are hard errors.
1191 assert(false);
1192 return;
1193 }
1194
1195 // Update the binding.
1196
1197 ValueState StImpl = *St;
1198 StImpl.CheckerState = RefBFactory.Add(B, Sym, X).getRoot();
1199 Builder.MakeNode(Dst, S, Pred, StateMgr.getPersistentState(StImpl));
1200}
1201
Ted Kremenekcb612922008-04-18 19:23:43 +00001202// Assumptions.
1203
1204ValueState* CFRefCount::EvalAssume(GRExprEngine& Eng, ValueState* St,
1205 RVal Cond, bool Assumption,
1206 bool& isFeasible) {
1207
1208 // FIXME: We may add to the interface of EvalAssume the list of symbols
1209 // whose assumptions have changed. For now we just iterate through the
1210 // bindings and check if any of the tracked symbols are NULL. This isn't
1211 // too bad since the number of symbols we will track in practice are
1212 // probably small and EvalAssume is only called at branches and a few
1213 // other places.
1214
1215 RefBindings B = GetRefBindings(*St);
1216
1217 if (B.isEmpty())
1218 return St;
1219
1220 bool changed = false;
1221
1222 for (RefBindings::iterator I=B.begin(), E=B.end(); I!=E; ++I) {
1223
1224 // Check if the symbol is null (or equal to any constant).
1225 // If this is the case, stop tracking the symbol.
1226
1227 if (St->getSymVal(I.getKey())) {
1228 changed = true;
1229 B = RefBFactory.Remove(B, I.getKey());
1230 }
1231 }
1232
1233 if (!changed)
1234 return St;
1235
1236 ValueState StImpl = *St;
1237 StImpl.CheckerState = B.getRoot();
1238 return Eng.getStateManager().getPersistentState(StImpl);
1239}
Ted Kremenek6b3a0f72008-03-11 06:39:11 +00001240
1241CFRefCount::RefBindings CFRefCount::Update(RefBindings B, SymbolID sym,
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001242 RefVal V, ArgEffect E,
Ted Kremenek9ed18e62008-04-16 04:28:53 +00001243 RefVal::Kind& hasErr) {
Ted Kremenek6b3a0f72008-03-11 06:39:11 +00001244
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001245 // FIXME: This dispatch can potentially be sped up by unifiying it into
1246 // a single switch statement. Opt for simplicity for now.
Ted Kremenek6b3a0f72008-03-11 06:39:11 +00001247
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001248 switch (E) {
1249 default:
1250 assert (false && "Unhandled CFRef transition.");
1251
1252 case DoNothing:
Ted Kremenek00a3a5f2008-03-12 01:21:45 +00001253 if (V.getKind() == RefVal::Released) {
1254 V = RefVal::makeUseAfterRelease();
Ted Kremenek9ed18e62008-04-16 04:28:53 +00001255 hasErr = V.getKind();
Ted Kremenek00a3a5f2008-03-12 01:21:45 +00001256 break;
1257 }
1258
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001259 return B;
1260
1261 case IncRef:
1262 switch (V.getKind()) {
1263 default:
1264 assert(false);
1265
1266 case RefVal::Owned:
Ted Kremenek940b1d82008-04-10 23:44:06 +00001267 V = RefVal::makeOwned(V.getCount()+1);
1268 break;
Ted Kremenek61b9f872008-04-10 23:09:18 +00001269
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001270 case RefVal::NotOwned:
Ted Kremenek61b9f872008-04-10 23:09:18 +00001271 V = RefVal::makeNotOwned(V.getCount()+1);
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001272 break;
1273
1274 case RefVal::Released:
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001275 V = RefVal::makeUseAfterRelease();
Ted Kremenek9ed18e62008-04-16 04:28:53 +00001276 hasErr = V.getKind();
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001277 break;
1278 }
1279
Ted Kremenek940b1d82008-04-10 23:44:06 +00001280 break;
1281
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001282 case DecRef:
1283 switch (V.getKind()) {
1284 default:
1285 assert (false);
1286
1287 case RefVal::Owned: {
Ted Kremenek4fd88972008-04-17 18:12:53 +00001288 unsigned Count = V.getCount();
1289 V = Count > 0 ? RefVal::makeOwned(Count - 1) : RefVal::makeReleased();
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001290 break;
1291 }
1292
Ted Kremenek61b9f872008-04-10 23:09:18 +00001293 case RefVal::NotOwned: {
Ted Kremenek4fd88972008-04-17 18:12:53 +00001294 unsigned Count = V.getCount();
Ted Kremenek61b9f872008-04-10 23:09:18 +00001295
Ted Kremenek4fd88972008-04-17 18:12:53 +00001296 if (Count > 0)
1297 V = RefVal::makeNotOwned(Count - 1);
Ted Kremenek61b9f872008-04-10 23:09:18 +00001298 else {
1299 V = RefVal::makeReleaseNotOwned();
Ted Kremenek9ed18e62008-04-16 04:28:53 +00001300 hasErr = V.getKind();
Ted Kremenek61b9f872008-04-10 23:09:18 +00001301 }
1302
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001303 break;
1304 }
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001305
1306 case RefVal::Released:
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001307 V = RefVal::makeUseAfterRelease();
Ted Kremenek9ed18e62008-04-16 04:28:53 +00001308 hasErr = V.getKind();
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001309 break;
1310 }
Ted Kremenek940b1d82008-04-10 23:44:06 +00001311
1312 break;
Ted Kremenek1ac08d62008-03-11 17:48:22 +00001313 }
1314
1315 return RefBFactory.Add(B, sym, V);
Ted Kremenek6b3a0f72008-03-11 06:39:11 +00001316}
1317
Ted Kremenekfa34b332008-04-09 01:10:13 +00001318
1319//===----------------------------------------------------------------------===//
Ted Kremenek05cbe1a2008-04-09 23:49:11 +00001320// Error reporting.
Ted Kremenekfa34b332008-04-09 01:10:13 +00001321//===----------------------------------------------------------------------===//
1322
Ted Kremenek8dd56462008-04-18 03:39:05 +00001323namespace {
1324
1325 //===-------------===//
1326 // Bug Descriptions. //
1327 //===-------------===//
1328
Ted Kremenek95cc1ba2008-04-18 20:54:29 +00001329 class VISIBILITY_HIDDEN CFRefBug : public BugTypeCacheLocation {
Ted Kremenek8dd56462008-04-18 03:39:05 +00001330 protected:
1331 CFRefCount& TF;
1332
1333 public:
1334 CFRefBug(CFRefCount& tf) : TF(tf) {}
1335 };
1336
1337 class VISIBILITY_HIDDEN UseAfterRelease : public CFRefBug {
1338 public:
1339 UseAfterRelease(CFRefCount& tf) : CFRefBug(tf) {}
1340
1341 virtual const char* getName() const {
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001342 return "Core Foundation: Use-After-Release";
Ted Kremenek8dd56462008-04-18 03:39:05 +00001343 }
1344 virtual const char* getDescription() const {
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001345 return "Reference-counted object is used"
1346 " after it is released.";
Ted Kremenek8dd56462008-04-18 03:39:05 +00001347 }
1348
1349 virtual void EmitWarnings(BugReporter& BR);
1350
1351 };
1352
1353 class VISIBILITY_HIDDEN BadRelease : public CFRefBug {
1354 public:
1355 BadRelease(CFRefCount& tf) : CFRefBug(tf) {}
1356
1357 virtual const char* getName() const {
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001358 return "Core Foundation: Release of non-owned object";
Ted Kremenek8dd56462008-04-18 03:39:05 +00001359 }
1360 virtual const char* getDescription() const {
1361 return "Incorrect decrement of the reference count of a "
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001362 "CoreFoundation object: "
Ted Kremenek8dd56462008-04-18 03:39:05 +00001363 "The object is not owned at this point by the caller.";
1364 }
1365
1366 virtual void EmitWarnings(BugReporter& BR);
1367 };
1368
1369 class VISIBILITY_HIDDEN Leak : public CFRefBug {
1370 public:
1371 Leak(CFRefCount& tf) : CFRefBug(tf) {}
1372
1373 virtual const char* getName() const {
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001374 return "Core Foundation: Memory Leak";
Ted Kremenek8dd56462008-04-18 03:39:05 +00001375 }
1376
1377 virtual const char* getDescription() const {
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001378 return "Object leaked.";
Ted Kremenek8dd56462008-04-18 03:39:05 +00001379 }
1380
1381 virtual void EmitWarnings(BugReporter& BR);
Ted Kremenekcb612922008-04-18 19:23:43 +00001382 virtual void GetErrorNodes(std::vector<ExplodedNode<ValueState>*>& Nodes);
Ted Kremenek8dd56462008-04-18 03:39:05 +00001383 };
1384
1385 //===---------===//
1386 // Bug Reports. //
1387 //===---------===//
1388
1389 class VISIBILITY_HIDDEN CFRefReport : public RangedBugReport {
1390 SymbolID Sym;
1391 public:
Ted Kremenek95cc1ba2008-04-18 20:54:29 +00001392 CFRefReport(BugType& D, ExplodedNode<ValueState> *n, SymbolID sym)
Ted Kremenek8dd56462008-04-18 03:39:05 +00001393 : RangedBugReport(D, n), Sym(sym) {}
1394
1395 virtual ~CFRefReport() {}
1396
1397
1398 virtual PathDiagnosticPiece* VisitNode(ExplodedNode<ValueState>* N,
1399 ExplodedNode<ValueState>* PrevN,
1400 ExplodedGraph<ValueState>& G,
1401 BugReporter& BR);
1402 };
1403
1404
1405} // end anonymous namespace
1406
1407void CFRefCount::RegisterChecks(GRExprEngine& Eng) {
1408 GRSimpleVals::RegisterChecks(Eng);
1409 Eng.Register(new UseAfterRelease(*this));
1410 Eng.Register(new BadRelease(*this));
1411 Eng.Register(new Leak(*this));
1412}
1413
1414PathDiagnosticPiece* CFRefReport::VisitNode(ExplodedNode<ValueState>* N,
1415 ExplodedNode<ValueState>* PrevN,
1416 ExplodedGraph<ValueState>& G,
1417 BugReporter& BR) {
1418
1419 // Check if the type state has changed.
1420
1421 ValueState* PrevSt = PrevN->getState();
1422 ValueState* CurrSt = N->getState();
1423
1424 CFRefCount::RefBindings PrevB = CFRefCount::GetRefBindings(*PrevSt);
1425 CFRefCount::RefBindings CurrB = CFRefCount::GetRefBindings(*CurrSt);
1426
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001427 CFRefCount::RefBindings::TreeTy* PrevT = PrevB.SlimFind(Sym);
1428 CFRefCount::RefBindings::TreeTy* CurrT = CurrB.SlimFind(Sym);
Ted Kremenek8dd56462008-04-18 03:39:05 +00001429
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001430 if (!CurrT)
1431 return NULL;
Ted Kremenek8dd56462008-04-18 03:39:05 +00001432
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001433 const char* Msg = NULL;
1434 RefVal CurrV = CurrB.SlimFind(Sym)->getValue().second;
Ted Kremenek8dd56462008-04-18 03:39:05 +00001435
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001436 if (!PrevT) {
1437
1438 // Check for the point where we start tracking the value.
1439
1440 if (CurrV.isOwned())
1441 Msg = "Function call returns 'Owned' Core Foundation object.";
1442 else {
1443 assert (CurrV.isNotOwned());
1444 Msg = "Function call returns 'Non-Owned' Core Foundation object.";
1445 }
1446
1447 Stmt* S = cast<PostStmt>(N->getLocation()).getStmt();
1448 FullSourceLoc Pos(S->getLocStart(), BR.getContext().getSourceManager());
1449 PathDiagnosticPiece* P = new PathDiagnosticPiece(Pos, Msg);
1450
1451 if (Expr* Exp = dyn_cast<Expr>(S))
1452 P->addRange(Exp->getSourceRange());
1453
1454 return P;
1455 }
1456
1457 // Determine if the typestate has changed.
1458
1459 RefVal PrevV = PrevB.SlimFind(Sym)->getValue().second;
1460
1461 if (PrevV == CurrV)
1462 return NULL;
1463
1464 // The typestate has changed.
1465
1466 std::ostringstream os;
1467
1468 switch (CurrV.getKind()) {
1469 case RefVal::Owned:
1470 case RefVal::NotOwned:
1471 assert (PrevV.getKind() == CurrV.getKind());
1472
1473 if (PrevV.getCount() > CurrV.getCount())
1474 os << "Reference count decremented.";
1475 else
1476 os << "Reference count incremented.";
1477
Ted Kremenek79c140b2008-04-18 05:32:44 +00001478 if (CurrV.getCount()) {
1479 os << " Object has +" << CurrV.getCount();
1480
1481 if (CurrV.getCount() > 1)
1482 os << " reference counts.";
1483 else
1484 os << " reference count.";
1485 }
Ted Kremenek2cf943a2008-04-18 04:55:01 +00001486
1487 Msg = os.str().c_str();
1488
1489 break;
1490
1491 case RefVal::Released:
1492 Msg = "Object released.";
1493 break;
1494
1495 case RefVal::ReturnedOwned:
1496 Msg = "Object returned to caller. "
1497 "Caller gets ownership of object.";
1498 break;
1499
1500 case RefVal::ReturnedNotOwned:
1501 Msg = "Object returned to caller. "
1502 "Caller does not get ownership of object.";
1503 break;
1504
1505 default:
1506 return NULL;
1507 }
1508
1509 Stmt* S = cast<PostStmt>(N->getLocation()).getStmt();
1510 FullSourceLoc Pos(S->getLocStart(), BR.getContext().getSourceManager());
1511 PathDiagnosticPiece* P = new PathDiagnosticPiece(Pos, Msg);
1512
1513 // Add the range by scanning the children of the statement for any bindings
1514 // to Sym.
1515
1516 ValueStateManager& VSM = BR.getEngine().getStateManager();
1517
1518 for (Stmt::child_iterator I = S->child_begin(), E = S->child_end(); I!=E; ++I)
1519 if (Expr* Exp = dyn_cast_or_null<Expr>(*I)) {
1520 RVal X = VSM.GetRVal(CurrSt, Exp);
1521
1522 if (lval::SymbolVal* SV = dyn_cast<lval::SymbolVal>(&X))
1523 if (SV->getSymbol() == Sym) {
1524 P->addRange(Exp->getSourceRange()); break;
1525 }
1526 }
1527
1528 return P;
Ted Kremenek8dd56462008-04-18 03:39:05 +00001529}
1530
Ted Kremenek05cbe1a2008-04-09 23:49:11 +00001531void UseAfterRelease::EmitWarnings(BugReporter& BR) {
Ted Kremenekfa34b332008-04-09 01:10:13 +00001532
Ted Kremenek05cbe1a2008-04-09 23:49:11 +00001533 for (CFRefCount::use_after_iterator I = TF.use_after_begin(),
1534 E = TF.use_after_end(); I != E; ++I) {
1535
Ted Kremenek8dd56462008-04-18 03:39:05 +00001536 CFRefReport report(*this, I->first, I->second.second);
1537 report.addRange(I->second.first->getSourceRange());
Ted Kremenek75840e12008-04-18 01:56:37 +00001538 BR.EmitWarning(report);
Ted Kremenekfa34b332008-04-09 01:10:13 +00001539 }
Ted Kremenek05cbe1a2008-04-09 23:49:11 +00001540}
1541
1542void BadRelease::EmitWarnings(BugReporter& BR) {
Ted Kremenekfa34b332008-04-09 01:10:13 +00001543
Ted Kremenek05cbe1a2008-04-09 23:49:11 +00001544 for (CFRefCount::bad_release_iterator I = TF.bad_release_begin(),
1545 E = TF.bad_release_end(); I != E; ++I) {
1546
Ted Kremenek8dd56462008-04-18 03:39:05 +00001547 CFRefReport report(*this, I->first, I->second.second);
1548 report.addRange(I->second.first->getSourceRange());
1549 BR.EmitWarning(report);
Ted Kremenek05cbe1a2008-04-09 23:49:11 +00001550 }
1551}
Ted Kremenekfa34b332008-04-09 01:10:13 +00001552
Ted Kremenek989d5192008-04-17 23:43:50 +00001553void Leak::EmitWarnings(BugReporter& BR) {
1554
1555 for (CFRefCount::leaks_iterator I = TF.leaks_begin(),
1556 E = TF.leaks_end(); I != E; ++I) {
1557
Ted Kremenek8dd56462008-04-18 03:39:05 +00001558 std::vector<SymbolID>& SymV = *(I->second);
1559 unsigned n = SymV.size();
1560
1561 for (unsigned i = 0; i < n; ++i) {
1562 CFRefReport report(*this, I->first, SymV[i]);
1563 BR.EmitWarning(report);
1564 }
Ted Kremenek989d5192008-04-17 23:43:50 +00001565 }
1566}
1567
Ted Kremenekcb612922008-04-18 19:23:43 +00001568void Leak::GetErrorNodes(std::vector<ExplodedNode<ValueState>*>& Nodes) {
1569 for (CFRefCount::leaks_iterator I=TF.leaks_begin(), E=TF.leaks_end();
1570 I!=E; ++I)
1571 Nodes.push_back(I->first);
1572}
1573
Ted Kremenek6b3a0f72008-03-11 06:39:11 +00001574//===----------------------------------------------------------------------===//
Ted Kremenekd71ed262008-04-10 22:16:52 +00001575// Transfer function creation for external clients.
Ted Kremenek6b3a0f72008-03-11 06:39:11 +00001576//===----------------------------------------------------------------------===//
1577
Ted Kremenek3ea0b6a2008-04-10 22:58:08 +00001578GRTransferFuncs* clang::MakeCFRefCountTF(ASTContext& Ctx) {
1579 return new CFRefCount(Ctx);
1580}