Chris Lattner | bda0b62 | 2008-03-15 23:59:48 +0000 | [diff] [blame] | 1 | // CFRefCount.cpp - Transfer functions for tracking simple values -*- C++ -*--// |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 2 | // |
| 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 Greif | 843e934 | 2008-03-06 10:40:09 +0000 | [diff] [blame] | 10 | // This file defines the methods for CFRefCount, which implements |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 11 | // a reference count checker for Core Foundation (Mac OS X). |
| 12 | // |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 15 | #include "GRSimpleVals.h" |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 16 | #include "clang/Analysis/PathSensitive/ValueState.h" |
Ted Kremenek | 4dc41cc | 2008-03-31 18:26:32 +0000 | [diff] [blame] | 17 | #include "clang/Analysis/PathDiagnostic.h" |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 18 | #include "clang/Analysis/LocalCheckers.h" |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 19 | #include "clang/Analysis/PathDiagnostic.h" |
| 20 | #include "clang/Analysis/PathSensitive/BugReporter.h" |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 21 | #include "llvm/ADT/DenseMap.h" |
| 22 | #include "llvm/ADT/FoldingSet.h" |
| 23 | #include "llvm/ADT/ImmutableMap.h" |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 24 | #include "llvm/Support/Compiler.h" |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 25 | #include <ostream> |
Ted Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 26 | #include <sstream> |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 27 | |
| 28 | using namespace clang; |
| 29 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 30 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 31 | // Utility functions. |
| 32 | //===----------------------------------------------------------------------===// |
| 33 | |
| 34 | static 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 Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 40 | // Symbolic Evaluation of Reference Counting Logic |
| 41 | //===----------------------------------------------------------------------===// |
| 42 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 43 | namespace { |
| 44 | enum ArgEffect { IncRef, DecRef, DoNothing }; |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 45 | typedef std::vector<std::pair<unsigned,ArgEffect> > ArgEffects; |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 46 | } |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 47 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 48 | namespace llvm { |
| 49 | template <> struct FoldingSetTrait<ArgEffects> { |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 50 | static void Profile(const ArgEffects& X, FoldingSetNodeID& ID) { |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 51 | 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 Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 55 | } |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 56 | }; |
| 57 | } // end llvm namespace |
| 58 | |
| 59 | namespace { |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 60 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 61 | class RetEffect { |
| 62 | public: |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 63 | enum Kind { NoRet = 0x0, Alias = 0x1, OwnedSymbol = 0x2, |
| 64 | NotOwnedSymbol = 0x3 }; |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 65 | |
| 66 | private: |
| 67 | unsigned Data; |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 68 | RetEffect(Kind k, unsigned D) { Data = (D << 2) | (unsigned) k; } |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 69 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 70 | public: |
| 71 | |
| 72 | Kind getKind() const { return (Kind) (Data & 0x3); } |
| 73 | |
| 74 | unsigned getValue() const { |
| 75 | assert(getKind() == Alias); |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 76 | return Data >> 2; |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 77 | } |
Ted Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 78 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 79 | static RetEffect MakeAlias(unsigned Idx) { return RetEffect(Alias, Idx); } |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 80 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 81 | static RetEffect MakeOwned() { return RetEffect(OwnedSymbol, 0); } |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 82 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 83 | static RetEffect MakeNotOwned() { return RetEffect(NotOwnedSymbol, 0); } |
| 84 | |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 85 | static RetEffect MakeNoRet() { return RetEffect(NoRet, 0); } |
| 86 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 87 | operator Kind() const { return getKind(); } |
| 88 | |
| 89 | void Profile(llvm::FoldingSetNodeID& ID) const { ID.AddInteger(Data); } |
| 90 | }; |
| 91 | |
| 92 | |
| 93 | class CFRefSummary : public llvm::FoldingSetNode { |
| 94 | ArgEffects* Args; |
| 95 | RetEffect Ret; |
| 96 | public: |
| 97 | |
| 98 | CFRefSummary(ArgEffects* A, RetEffect R) : Args(A), Ret(R) {} |
| 99 | |
| 100 | unsigned getNumArgs() const { return Args->size(); } |
| 101 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 102 | ArgEffect getArg(unsigned idx) const { |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 103 | 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 Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 122 | } |
| 123 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 124 | RetEffect getRet() const { |
| 125 | return Ret; |
| 126 | } |
| 127 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 128 | 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 | |
| 144 | class CFRefSummaryManager { |
| 145 | typedef llvm::FoldingSet<llvm::FoldingSetNodeWrapper<ArgEffects> > AESetTy; |
| 146 | typedef llvm::FoldingSet<CFRefSummary> SummarySetTy; |
| 147 | typedef llvm::DenseMap<FunctionDecl*, CFRefSummary*> SummaryMapTy; |
| 148 | |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 149 | ASTContext& Ctx; |
| 150 | SummarySetTy SummarySet; |
| 151 | SummaryMapTy SummaryMap; |
| 152 | AESetTy AESet; |
| 153 | llvm::BumpPtrAllocator BPAlloc; |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 154 | ArgEffects ScratchArgs; |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 155 | |
| 156 | ArgEffects* getArgEffects(); |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 157 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 158 | 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 Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 166 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 167 | public: |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 168 | CFRefSummaryManager(ASTContext& ctx) : Ctx(ctx) {} |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 169 | ~CFRefSummaryManager(); |
| 170 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 171 | CFRefSummary* getSummary(FunctionDecl* FD, ASTContext& Ctx); |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 172 | }; |
| 173 | |
| 174 | } // end anonymous namespace |
| 175 | |
| 176 | //===----------------------------------------------------------------------===// |
| 177 | // Implementation of checker data structures. |
| 178 | //===----------------------------------------------------------------------===// |
| 179 | |
| 180 | CFRefSummaryManager::~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 Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 188 | } |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 189 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 190 | ArgEffects* CFRefSummaryManager::getArgEffects() { |
| 191 | |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 192 | if (ScratchArgs.empty()) |
| 193 | return NULL; |
| 194 | |
| 195 | // Compute a profile for a non-empty ScratchArgs. |
| 196 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 197 | llvm::FoldingSetNodeID profile; |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 198 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 199 | profile.Add(ScratchArgs); |
| 200 | void* InsertPos; |
| 201 | |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 202 | // Look up the uniqued copy, or create a new one. |
| 203 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 204 | llvm::FoldingSetNodeWrapper<ArgEffects>* E = |
| 205 | AESet.FindNodeOrInsertPos(profile, InsertPos); |
| 206 | |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 207 | if (E) { |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 208 | 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 | |
| 222 | CFRefSummary* CFRefSummaryManager::getPersistentSummary(ArgEffects* AE, |
| 223 | RetEffect RE) { |
| 224 | |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 225 | // Generate a profile for the summary. |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 226 | llvm::FoldingSetNodeID profile; |
| 227 | CFRefSummary::Profile(profile, AE, RE); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 228 | |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 229 | // Look up the uniqued summary, or create one if it doesn't exist. |
| 230 | void* InsertPos; |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 231 | CFRefSummary* Summ = SummarySet.FindNodeOrInsertPos(profile, InsertPos); |
| 232 | |
| 233 | if (Summ) |
| 234 | return Summ; |
| 235 | |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 236 | // Create the summary and return it. |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 237 | Summ = (CFRefSummary*) BPAlloc.Allocate<CFRefSummary>(); |
| 238 | new (Summ) CFRefSummary(AE, RE); |
| 239 | SummarySet.InsertNode(Summ, InsertPos); |
| 240 | |
| 241 | return Summ; |
| 242 | } |
| 243 | |
| 244 | |
| 245 | CFRefSummary* CFRefSummaryManager::getSummary(FunctionDecl* FD, |
| 246 | ASTContext& Ctx) { |
| 247 | |
| 248 | SourceLocation Loc = FD->getLocation(); |
| 249 | |
| 250 | if (!Loc.isFileID()) |
| 251 | return NULL; |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 252 | |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 253 | |
| 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 Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 261 | 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 Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 268 | |
| 269 | // Function has no ref-count effects. Return the NULL summary. |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 270 | return NULL; |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 271 | } |
| 272 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 273 | CFRefSummary* 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 | |
| 310 | CFRefSummary* 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 Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 327 | if (strcmp("CFTypeRef", TDName) != 0) |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 328 | return NULL; |
| 329 | |
| 330 | if (!ArgT->isPointerType()) |
| 331 | return NULL; |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 332 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 333 | QualType RetTy = FT->getResultType(); |
| 334 | |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 335 | if (isRetain) { |
| 336 | // CFRetain: the return type should also be "CFTypeRef". |
| 337 | if (RetTy.getTypePtr() != ArgT) |
| 338 | return NULL; |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 339 | |
| 340 | // The function's interface checks out. Generate a canned summary. |
| 341 | assert (ScratchArgs.empty()); |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 342 | ScratchArgs.push_back(std::make_pair(0, IncRef)); |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 343 | return getPersistentSummary(getArgEffects(), RetEffect::MakeAlias(0)); |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 344 | } |
| 345 | else { |
| 346 | // CFRelease: the return type should be void. |
| 347 | |
| 348 | if (RetTy != Ctx.VoidTy) |
| 349 | return NULL; |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 350 | |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 351 | assert (ScratchArgs.empty()); |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 352 | ScratchArgs.push_back(std::make_pair(0, DecRef)); |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 353 | return getPersistentSummary(getArgEffects(), RetEffect::MakeNoRet()); |
| 354 | } |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 355 | } |
| 356 | |
| 357 | static 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 Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 380 | |
| 381 | CFRefSummary* |
| 382 | CFRefSummaryManager::getCFSummaryCreateRule(FunctionTypeProto* FT) { |
| 383 | |
| 384 | if (!isCFRefType(FT->getResultType())) |
Ted Kremenek | a0df99f | 2008-04-11 20:11:19 +0000 | [diff] [blame] | 385 | return NULL; |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 386 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 387 | // FIXME: Add special-cases for functions that retain/release. For now |
| 388 | // just handle the default case. |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 389 | |
| 390 | assert (ScratchArgs.empty()); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 391 | return getPersistentSummary(getArgEffects(), RetEffect::MakeOwned()); |
| 392 | } |
| 393 | |
| 394 | CFRefSummary* |
| 395 | CFRefSummaryManager::getCFSummaryGetRule(FunctionTypeProto* FT) { |
| 396 | |
Ted Kremenek | a0df99f | 2008-04-11 20:11:19 +0000 | [diff] [blame] | 397 | 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 Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 407 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 408 | // FIXME: Add special-cases for functions that retain/release. For now |
| 409 | // just handle the default case. |
| 410 | |
Ted Kremenek | 891d5cc | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 411 | assert (ScratchArgs.empty()); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 412 | return getPersistentSummary(getArgEffects(), RetEffect::MakeNotOwned()); |
| 413 | } |
| 414 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 415 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 1392261 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 416 | // Reference-counting logic (typestate + counts). |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 417 | //===----------------------------------------------------------------------===// |
| 418 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 419 | namespace { |
| 420 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 421 | class VISIBILITY_HIDDEN RefVal { |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 422 | public: |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 423 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 424 | 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 Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 434 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 435 | private: |
| 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 Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 443 | |
| 444 | public: |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 445 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 446 | Kind getKind() const { return kind; } |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 447 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 448 | unsigned getCount() const { return Cnt; } |
| 449 | |
| 450 | // Useful predicates. |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 451 | |
Ted Kremenek | 73c750b | 2008-03-11 18:14:09 +0000 | [diff] [blame] | 452 | static bool isError(Kind k) { return k >= ErrorUseAfterRelease; } |
| 453 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 454 | static bool isLeak(Kind k) { return k == ErrorLeak; } |
| 455 | |
Ted Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 456 | bool isOwned() const { |
| 457 | return getKind() == Owned; |
| 458 | } |
| 459 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 460 | bool isNotOwned() const { |
| 461 | return getKind() == NotOwned; |
| 462 | } |
| 463 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 464 | 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 Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 479 | 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 Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 486 | |
| 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 Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 496 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 497 | static RefVal makeLeak() { return RefVal(ErrorLeak); } |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 498 | static RefVal makeReleased() { return RefVal(Released); } |
| 499 | static RefVal makeUseAfterRelease() { return RefVal(ErrorUseAfterRelease); } |
| 500 | static RefVal makeReleaseNotOwned() { return RefVal(ErrorReleaseNotOwned); } |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 501 | |
| 502 | // Comparison, profiling, and pretty-printing. |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 503 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 504 | bool operator==(const RefVal& X) const { |
| 505 | return kind == X.kind && Cnt == X.Cnt; |
| 506 | } |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 507 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 508 | void Profile(llvm::FoldingSetNodeID& ID) const { |
| 509 | ID.AddInteger((unsigned) kind); |
| 510 | ID.AddInteger(Cnt); |
| 511 | } |
| 512 | |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 513 | void print(std::ostream& Out) const; |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 514 | }; |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 515 | |
| 516 | void RefVal::print(std::ostream& Out) const { |
| 517 | switch (getKind()) { |
| 518 | default: assert(false); |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 519 | case Owned: { |
| 520 | Out << "Owned"; |
| 521 | unsigned cnt = getCount(); |
| 522 | if (cnt) Out << " (+ " << cnt << ")"; |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 523 | break; |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 524 | } |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 525 | |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 526 | case NotOwned: { |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 527 | Out << "NotOwned"; |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 528 | unsigned cnt = getCount(); |
| 529 | if (cnt) Out << " (+ " << cnt << ")"; |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 530 | break; |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 531 | } |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 532 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 533 | 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 Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 547 | case Released: |
| 548 | Out << "Released"; |
| 549 | break; |
| 550 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 551 | case ErrorLeak: |
| 552 | Out << "Leaked"; |
| 553 | break; |
| 554 | |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 555 | 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 Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 564 | |
Ted Kremenek | 1392261 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 565 | //===----------------------------------------------------------------------===// |
| 566 | // Transfer functions. |
| 567 | //===----------------------------------------------------------------------===// |
| 568 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 569 | class VISIBILITY_HIDDEN CFRefCount : public GRSimpleVals { |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 570 | public: |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 571 | // Type definitions. |
| 572 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 573 | typedef llvm::ImmutableMap<SymbolID, RefVal> RefBindings; |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 574 | typedef RefBindings::Factory RefBFactoryTy; |
Ted Kremenek | 73c750b | 2008-03-11 18:14:09 +0000 | [diff] [blame] | 575 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 576 | 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 Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 582 | LeaksTy; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 583 | |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 584 | 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 Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 589 | |
| 590 | private: |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 591 | // Instance variables. |
| 592 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 593 | CFRefSummaryManager Summaries; |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 594 | RefBFactoryTy RefBFactory; |
| 595 | |
Ted Kremenek | 73c750b | 2008-03-11 18:14:09 +0000 | [diff] [blame] | 596 | UseAfterReleasesTy UseAfterReleases; |
| 597 | ReleasesNotOwnedTy ReleasesNotOwned; |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 598 | LeaksTy Leaks; |
Ted Kremenek | 73c750b | 2008-03-11 18:14:09 +0000 | [diff] [blame] | 599 | |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 600 | BindingsPrinter Printer; |
| 601 | |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 602 | Selector RetainSelector; |
| 603 | Selector ReleaseSelector; |
| 604 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 605 | public: |
| 606 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 607 | static RefBindings GetRefBindings(ValueState& StImpl) { |
| 608 | return RefBindings((RefBindings::TreeTy*) StImpl.CheckerState); |
| 609 | } |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 610 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 611 | private: |
| 612 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 613 | static void SetRefBindings(ValueState& StImpl, RefBindings B) { |
| 614 | StImpl.CheckerState = B.getRoot(); |
| 615 | } |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 616 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 617 | RefBindings Remove(RefBindings B, SymbolID sym) { |
| 618 | return RefBFactory.Remove(B, sym); |
| 619 | } |
| 620 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 621 | RefBindings Update(RefBindings B, SymbolID sym, RefVal V, ArgEffect E, |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 622 | RefVal::Kind& hasErr); |
| 623 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 624 | void ProcessNonLeakError(ExplodedNodeSet<ValueState>& Dst, |
| 625 | GRStmtNodeBuilder<ValueState>& Builder, |
| 626 | Expr* NodeExpr, Expr* ErrorExpr, |
| 627 | ExplodedNode<ValueState>* Pred, |
| 628 | ValueState* St, |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 629 | RefVal::Kind hasErr, SymbolID Sym); |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 630 | |
| 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 Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 636 | |
| 637 | public: |
Ted Kremenek | 1392261 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 638 | |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 639 | CFRefCount(ASTContext& Ctx) |
| 640 | : Summaries(Ctx), |
| 641 | RetainSelector(GetUnarySelector("retain", Ctx)), |
| 642 | ReleaseSelector(GetUnarySelector("release", Ctx)) {} |
| 643 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 644 | virtual ~CFRefCount() { |
| 645 | for (LeaksTy::iterator I = Leaks.begin(), E = Leaks.end(); I!=E; ++I) |
| 646 | delete I->second; |
| 647 | } |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 648 | |
| 649 | virtual void RegisterChecks(GRExprEngine& Eng); |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 650 | |
| 651 | virtual ValueState::CheckerStatePrinter* getCheckerStatePrinter() { |
| 652 | return &Printer; |
| 653 | } |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 654 | |
| 655 | // Calls. |
| 656 | |
| 657 | virtual void EvalCall(ExplodedNodeSet<ValueState>& Dst, |
Ted Kremenek | 199e1a0 | 2008-03-12 21:06:49 +0000 | [diff] [blame] | 658 | GRExprEngine& Eng, |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 659 | GRStmtNodeBuilder<ValueState>& Builder, |
Ted Kremenek | 186350f | 2008-04-23 20:12:28 +0000 | [diff] [blame] | 660 | CallExpr* CE, RVal L, |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 661 | ExplodedNode<ValueState>* Pred); |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 662 | |
Ted Kremenek | 8534820 | 2008-04-15 23:44:31 +0000 | [diff] [blame] | 663 | 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 Kremenek | 1392261 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 675 | // 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 Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 682 | // End-of-path. |
| 683 | |
| 684 | virtual void EvalEndPath(GRExprEngine& Engine, |
| 685 | GREndPathNodeBuilder<ValueState>& Builder); |
| 686 | |
Ted Kremenek | 652adc6 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 687 | virtual void EvalDeadSymbols(ExplodedNodeSet<ValueState>& Dst, |
| 688 | GRExprEngine& Engine, |
| 689 | GRStmtNodeBuilder<ValueState>& Builder, |
Ted Kremenek | 910e999 | 2008-04-25 01:25:15 +0000 | [diff] [blame] | 690 | ExplodedNode<ValueState>* Pred, |
| 691 | Stmt* S, |
Ted Kremenek | 652adc6 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 692 | ValueState* St, |
| 693 | const ValueStateManager::DeadSymbolsTy& Dead); |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 694 | // 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 Kremenek | cb61292 | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 701 | |
| 702 | // Assumptions. |
| 703 | |
| 704 | virtual ValueState* EvalAssume(GRExprEngine& Engine, ValueState* St, |
| 705 | RVal Cond, bool Assumption, bool& isFeasible); |
| 706 | |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 707 | // Error iterators. |
| 708 | |
| 709 | typedef UseAfterReleasesTy::iterator use_after_iterator; |
| 710 | typedef ReleasesNotOwnedTy::iterator bad_release_iterator; |
Ted Kremenek | 989d519 | 2008-04-17 23:43:50 +0000 | [diff] [blame] | 711 | typedef LeaksTy::iterator leaks_iterator; |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 712 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 713 | use_after_iterator use_after_begin() { return UseAfterReleases.begin(); } |
| 714 | use_after_iterator use_after_end() { return UseAfterReleases.end(); } |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 715 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 716 | bad_release_iterator bad_release_begin() { return ReleasesNotOwned.begin(); } |
| 717 | bad_release_iterator bad_release_end() { return ReleasesNotOwned.end(); } |
Ted Kremenek | 989d519 | 2008-04-17 23:43:50 +0000 | [diff] [blame] | 718 | |
| 719 | leaks_iterator leaks_begin() { return Leaks.begin(); } |
| 720 | leaks_iterator leaks_end() { return Leaks.end(); } |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 721 | }; |
| 722 | |
| 723 | } // end anonymous namespace |
| 724 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 725 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 726 | |
| 727 | |
Ted Kremenek | f394804 | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 728 | void 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 Kremenek | f9561e5 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 743 | static inline ArgEffect GetArgE(CFRefSummary* Summ, unsigned idx) { |
| 744 | return Summ ? Summ->getArg(idx) : DoNothing; |
| 745 | } |
| 746 | |
| 747 | static inline RetEffect GetRetE(CFRefSummary* Summ) { |
| 748 | return Summ ? Summ->getRet() : RetEffect::MakeNoRet(); |
| 749 | } |
| 750 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 751 | void CFRefCount::ProcessNonLeakError(ExplodedNodeSet<ValueState>& Dst, |
| 752 | GRStmtNodeBuilder<ValueState>& Builder, |
| 753 | Expr* NodeExpr, Expr* ErrorExpr, |
| 754 | ExplodedNode<ValueState>* Pred, |
| 755 | ValueState* St, |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 756 | RefVal::Kind hasErr, SymbolID Sym) { |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 757 | 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 Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 765 | UseAfterReleases[N] = std::make_pair(ErrorExpr, Sym); |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 766 | break; |
| 767 | |
| 768 | case RefVal::ErrorReleaseNotOwned: |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 769 | ReleasesNotOwned[N] = std::make_pair(ErrorExpr, Sym); |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 770 | break; |
| 771 | } |
| 772 | } |
| 773 | |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 774 | void CFRefCount::EvalCall(ExplodedNodeSet<ValueState>& Dst, |
Ted Kremenek | 199e1a0 | 2008-03-12 21:06:49 +0000 | [diff] [blame] | 775 | GRExprEngine& Eng, |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 776 | GRStmtNodeBuilder<ValueState>& Builder, |
Ted Kremenek | 186350f | 2008-04-23 20:12:28 +0000 | [diff] [blame] | 777 | CallExpr* CE, RVal L, |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 778 | ExplodedNode<ValueState>* Pred) { |
| 779 | |
Ted Kremenek | 199e1a0 | 2008-03-12 21:06:49 +0000 | [diff] [blame] | 780 | ValueStateManager& StateMgr = Eng.getStateManager(); |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 781 | |
Ted Kremenek | 7ded73c | 2008-04-14 17:45:13 +0000 | [diff] [blame] | 782 | CFRefSummary* Summ = NULL; |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 783 | |
| 784 | // Get the summary. |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 785 | |
Ted Kremenek | 7ded73c | 2008-04-14 17:45:13 +0000 | [diff] [blame] | 786 | 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 Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 791 | |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 792 | // Get the state. |
| 793 | |
| 794 | ValueState* St = Builder.GetState(Pred); |
| 795 | |
| 796 | // Evaluate the effects of the call. |
| 797 | |
| 798 | ValueState StVals = *St; |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 799 | RefVal::Kind hasErr = (RefVal::Kind) 0; |
Ted Kremenek | f9561e5 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 800 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 801 | // This function has a summary. Evaluate the effect of the arguments. |
| 802 | |
| 803 | unsigned idx = 0; |
| 804 | |
Ted Kremenek | bcf50ad | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 805 | Expr* ErrorExpr = NULL; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 806 | SymbolID ErrorSym = 0; |
Ted Kremenek | bcf50ad | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 807 | |
| 808 | for (CallExpr::arg_iterator I = CE->arg_begin(), E = CE->arg_end(); |
| 809 | I != E; ++I, ++idx) { |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 810 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 811 | RVal V = StateMgr.GetRVal(St, *I); |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 812 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 813 | if (isa<lval::SymbolVal>(V)) { |
| 814 | SymbolID Sym = cast<lval::SymbolVal>(V).getSymbol(); |
Ted Kremenek | f9561e5 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 815 | RefBindings B = GetRefBindings(StVals); |
| 816 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 817 | if (RefBindings::TreeTy* T = B.SlimFind(Sym)) { |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 818 | B = Update(B, Sym, T->getValue().second, GetArgE(Summ, idx), hasErr); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 819 | SetRefBindings(StVals, B); |
Ted Kremenek | bcf50ad | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 820 | |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 821 | if (hasErr) { |
Ted Kremenek | bcf50ad | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 822 | ErrorExpr = *I; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 823 | ErrorSym = T->getValue().first; |
Ted Kremenek | bcf50ad | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 824 | break; |
| 825 | } |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 826 | } |
Ted Kremenek | b887355 | 2008-04-11 20:51:02 +0000 | [diff] [blame] | 827 | } |
| 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 Kremenek | f9561e5 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 832 | StateMgr.Unbind(StVals, cast<LVal>(V)); |
Ted Kremenek | b887355 | 2008-04-11 20:51:02 +0000 | [diff] [blame] | 833 | } |
Ted Kremenek | a548846 | 2008-04-22 21:39:21 +0000 | [diff] [blame] | 834 | else if (isa<nonlval::LValAsInteger>(V)) |
| 835 | StateMgr.Unbind(StVals, cast<nonlval::LValAsInteger>(V).getLVal()); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 836 | } |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 837 | |
| 838 | St = StateMgr.getPersistentState(StVals); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 839 | |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 840 | if (hasErr) { |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 841 | ProcessNonLeakError(Dst, Builder, CE, ErrorExpr, Pred, St, |
| 842 | hasErr, ErrorSym); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 843 | return; |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 844 | } |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 845 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 846 | // Finally, consult the summary for the return value. |
| 847 | |
Ted Kremenek | f9561e5 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 848 | RetEffect RE = GetRetE(Summ); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 849 | |
| 850 | switch (RE.getKind()) { |
| 851 | default: |
| 852 | assert (false && "Unhandled RetEffect."); break; |
| 853 | |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 854 | case RetEffect::NoRet: |
Ted Kremenek | f9561e5 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 855 | |
| 856 | // Make up a symbol for the return value (not reference counted). |
Ted Kremenek | b887355 | 2008-04-11 20:51:02 +0000 | [diff] [blame] | 857 | // FIXME: This is basically copy-and-paste from GRSimpleVals. We |
| 858 | // should compose behavior, not copy it. |
Ted Kremenek | f9561e5 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 859 | |
| 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 Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 871 | break; |
| 872 | |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 873 | case RetEffect::Alias: { |
| 874 | unsigned idx = RE.getValue(); |
| 875 | assert (idx < CE->getNumArgs()); |
| 876 | RVal V = StateMgr.GetRVal(St, CE->getArg(idx)); |
Ted Kremenek | 199e1a0 | 2008-03-12 21:06:49 +0000 | [diff] [blame] | 877 | St = StateMgr.SetRVal(St, CE, V, Eng.getCFG().isBlkExpr(CE), false); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 878 | break; |
| 879 | } |
| 880 | |
| 881 | case RetEffect::OwnedSymbol: { |
| 882 | unsigned Count = Builder.getCurrentBlockCount(); |
Ted Kremenek | 361fa8e | 2008-03-12 21:45:47 +0000 | [diff] [blame] | 883 | SymbolID Sym = Eng.getSymbolManager().getConjuredSymbol(CE, Count); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 884 | |
| 885 | ValueState StImpl = *St; |
| 886 | RefBindings B = GetRefBindings(StImpl); |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 887 | SetRefBindings(StImpl, RefBFactory.Add(B, Sym, RefVal::makeOwned())); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 888 | |
| 889 | St = StateMgr.SetRVal(StateMgr.getPersistentState(StImpl), |
| 890 | CE, lval::SymbolVal(Sym), |
Ted Kremenek | 199e1a0 | 2008-03-12 21:06:49 +0000 | [diff] [blame] | 891 | Eng.getCFG().isBlkExpr(CE), false); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 892 | |
| 893 | break; |
| 894 | } |
| 895 | |
| 896 | case RetEffect::NotOwnedSymbol: { |
| 897 | unsigned Count = Builder.getCurrentBlockCount(); |
Ted Kremenek | 361fa8e | 2008-03-12 21:45:47 +0000 | [diff] [blame] | 898 | SymbolID Sym = Eng.getSymbolManager().getConjuredSymbol(CE, Count); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 899 | |
| 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 Kremenek | 199e1a0 | 2008-03-12 21:06:49 +0000 | [diff] [blame] | 906 | Eng.getCFG().isBlkExpr(CE), false); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 907 | |
| 908 | break; |
| 909 | } |
| 910 | } |
| 911 | |
Ted Kremenek | 0e561a3 | 2008-03-21 21:30:14 +0000 | [diff] [blame] | 912 | Builder.MakeNode(Dst, CE, Pred, St); |
Ted Kremenek | 2fff37e | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 913 | } |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 914 | |
Ted Kremenek | 8534820 | 2008-04-15 23:44:31 +0000 | [diff] [blame] | 915 | |
| 916 | void 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 | |
| 926 | bool CFRefCount::EvalObjCMessageExprAux(ExplodedNodeSet<ValueState>& Dst, |
| 927 | GRExprEngine& Eng, |
| 928 | GRStmtNodeBuilder<ValueState>& Builder, |
| 929 | ObjCMessageExpr* ME, |
| 930 | ExplodedNode<ValueState>* Pred) { |
| 931 | |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 932 | // 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 Kremenek | 8534820 | 2008-04-15 23:44:31 +0000 | [diff] [blame] | 937 | |
| 938 | Selector S = ME->getSelector(); |
| 939 | |
| 940 | if (!S.isUnarySelector()) |
| 941 | return true; |
| 942 | |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 943 | 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 Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 986 | ProcessNonLeakError(Dst, Builder, ME, Receiver, Pred, St, hasErr, Sym); |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 987 | else |
| 988 | Builder.MakeNode(Dst, ME, Pred, St); |
| 989 | |
| 990 | return false; |
Ted Kremenek | 8534820 | 2008-04-15 23:44:31 +0000 | [diff] [blame] | 991 | } |
| 992 | |
Ted Kremenek | 1392261 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 993 | // Stores. |
| 994 | |
| 995 | void 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 Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1026 | // Nuke the binding. |
| 1027 | St = NukeBinding(Eng.getStateManager(), St, Sym); |
Ted Kremenek | 1392261 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 1028 | |
| 1029 | // Hand of the remaining logic to the parent implementation. |
| 1030 | GRSimpleVals::EvalStore(Dst, Eng, Builder, E, Pred, St, TargetLV, Val); |
| 1031 | } |
| 1032 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1033 | |
| 1034 | ValueState* 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 Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1042 | // End-of-path. |
| 1043 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1044 | ValueState* CFRefCount::HandleSymbolDeath(ValueStateManager& VMgr, |
| 1045 | ValueState* St, SymbolID sid, |
| 1046 | RefVal V, bool& hasLeak) { |
| 1047 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1048 | hasLeak = V.isOwned() || |
| 1049 | ((V.isNotOwned() || V.isReturnedOwned()) && V.getCount() > 0); |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1050 | |
| 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 | |
| 1060 | void CFRefCount::EvalEndPath(GRExprEngine& Eng, |
Ted Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1061 | GREndPathNodeBuilder<ValueState>& Builder) { |
| 1062 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1063 | ValueState* St = Builder.getState(); |
| 1064 | RefBindings B = GetRefBindings(*St); |
Ted Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1065 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1066 | llvm::SmallVector<SymbolID, 10> Leaked; |
Ted Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1067 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1068 | for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { |
| 1069 | bool hasLeak = false; |
Ted Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1070 | |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1071 | St = HandleSymbolDeath(Eng.getStateManager(), St, |
| 1072 | (*I).first, (*I).second, hasLeak); |
| 1073 | |
| 1074 | if (hasLeak) Leaked.push_back((*I).first); |
| 1075 | } |
Ted Kremenek | 652adc6 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1076 | |
| 1077 | if (Leaked.empty()) |
| 1078 | return; |
| 1079 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1080 | ExplodedNode<ValueState>* N = Builder.MakeNode(St); |
Ted Kremenek | 4f28515 | 2008-04-18 16:30:14 +0000 | [diff] [blame] | 1081 | |
Ted Kremenek | 652adc6 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1082 | if (!N) |
Ted Kremenek | 4f28515 | 2008-04-18 16:30:14 +0000 | [diff] [blame] | 1083 | return; |
Ted Kremenek | cb61292 | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 1084 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1085 | std::vector<SymbolID>*& LeaksAtNode = Leaks[N]; |
| 1086 | assert (!LeaksAtNode); |
| 1087 | LeaksAtNode = new std::vector<SymbolID>(); |
Ted Kremenek | db86371 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1088 | |
| 1089 | for (llvm::SmallVector<SymbolID, 10>::iterator I=Leaked.begin(), |
| 1090 | E = Leaked.end(); I != E; ++I) |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1091 | (*LeaksAtNode).push_back(*I); |
Ted Kremenek | e7bd9c2 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1092 | } |
| 1093 | |
Ted Kremenek | 652adc6 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1094 | // Dead symbols. |
| 1095 | |
| 1096 | void CFRefCount::EvalDeadSymbols(ExplodedNodeSet<ValueState>& Dst, |
| 1097 | GRExprEngine& Eng, |
| 1098 | GRStmtNodeBuilder<ValueState>& Builder, |
Ted Kremenek | 910e999 | 2008-04-25 01:25:15 +0000 | [diff] [blame] | 1099 | ExplodedNode<ValueState>* Pred, |
| 1100 | Stmt* S, |
Ted Kremenek | 652adc6 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1101 | ValueState* St, |
| 1102 | const ValueStateManager::DeadSymbolsTy& Dead) { |
Ted Kremenek | 910e999 | 2008-04-25 01:25:15 +0000 | [diff] [blame] | 1103 | |
Ted Kremenek | 652adc6 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1104 | // 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 Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1142 | // Return statements. |
| 1143 | |
| 1144 | void 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 Kremenek | cb61292 | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 1202 | // Assumptions. |
| 1203 | |
| 1204 | ValueState* 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 Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1240 | |
| 1241 | CFRefCount::RefBindings CFRefCount::Update(RefBindings B, SymbolID sym, |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1242 | RefVal V, ArgEffect E, |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1243 | RefVal::Kind& hasErr) { |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1244 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1245 | // FIXME: This dispatch can potentially be sped up by unifiying it into |
| 1246 | // a single switch statement. Opt for simplicity for now. |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1247 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1248 | switch (E) { |
| 1249 | default: |
| 1250 | assert (false && "Unhandled CFRef transition."); |
| 1251 | |
| 1252 | case DoNothing: |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1253 | if (V.getKind() == RefVal::Released) { |
| 1254 | V = RefVal::makeUseAfterRelease(); |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1255 | hasErr = V.getKind(); |
Ted Kremenek | 00a3a5f | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1256 | break; |
| 1257 | } |
| 1258 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1259 | return B; |
| 1260 | |
| 1261 | case IncRef: |
| 1262 | switch (V.getKind()) { |
| 1263 | default: |
| 1264 | assert(false); |
| 1265 | |
| 1266 | case RefVal::Owned: |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 1267 | V = RefVal::makeOwned(V.getCount()+1); |
| 1268 | break; |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1269 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1270 | case RefVal::NotOwned: |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1271 | V = RefVal::makeNotOwned(V.getCount()+1); |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1272 | break; |
| 1273 | |
| 1274 | case RefVal::Released: |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1275 | V = RefVal::makeUseAfterRelease(); |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1276 | hasErr = V.getKind(); |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1277 | break; |
| 1278 | } |
| 1279 | |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 1280 | break; |
| 1281 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1282 | case DecRef: |
| 1283 | switch (V.getKind()) { |
| 1284 | default: |
| 1285 | assert (false); |
| 1286 | |
| 1287 | case RefVal::Owned: { |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1288 | unsigned Count = V.getCount(); |
| 1289 | V = Count > 0 ? RefVal::makeOwned(Count - 1) : RefVal::makeReleased(); |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1290 | break; |
| 1291 | } |
| 1292 | |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1293 | case RefVal::NotOwned: { |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1294 | unsigned Count = V.getCount(); |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1295 | |
Ted Kremenek | 4fd8897 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1296 | if (Count > 0) |
| 1297 | V = RefVal::makeNotOwned(Count - 1); |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1298 | else { |
| 1299 | V = RefVal::makeReleaseNotOwned(); |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1300 | hasErr = V.getKind(); |
Ted Kremenek | 61b9f87 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1301 | } |
| 1302 | |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1303 | break; |
| 1304 | } |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1305 | |
| 1306 | case RefVal::Released: |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1307 | V = RefVal::makeUseAfterRelease(); |
Ted Kremenek | 9ed18e6 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1308 | hasErr = V.getKind(); |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1309 | break; |
| 1310 | } |
Ted Kremenek | 940b1d8 | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 1311 | |
| 1312 | break; |
Ted Kremenek | 1ac08d6 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1313 | } |
| 1314 | |
| 1315 | return RefBFactory.Add(B, sym, V); |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1316 | } |
| 1317 | |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1318 | |
| 1319 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1320 | // Error reporting. |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1321 | //===----------------------------------------------------------------------===// |
| 1322 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1323 | namespace { |
| 1324 | |
| 1325 | //===-------------===// |
| 1326 | // Bug Descriptions. // |
| 1327 | //===-------------===// |
| 1328 | |
Ted Kremenek | 95cc1ba | 2008-04-18 20:54:29 +0000 | [diff] [blame] | 1329 | class VISIBILITY_HIDDEN CFRefBug : public BugTypeCacheLocation { |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1330 | 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 Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1342 | return "Core Foundation: Use-After-Release"; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1343 | } |
| 1344 | virtual const char* getDescription() const { |
Ted Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1345 | return "Reference-counted object is used" |
| 1346 | " after it is released."; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1347 | } |
| 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 Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1358 | return "Core Foundation: Release of non-owned object"; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1359 | } |
| 1360 | virtual const char* getDescription() const { |
| 1361 | return "Incorrect decrement of the reference count of a " |
Ted Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1362 | "CoreFoundation object: " |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1363 | "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 Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1374 | return "Core Foundation: Memory Leak"; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1375 | } |
| 1376 | |
| 1377 | virtual const char* getDescription() const { |
Ted Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1378 | return "Object leaked."; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1379 | } |
| 1380 | |
| 1381 | virtual void EmitWarnings(BugReporter& BR); |
Ted Kremenek | cb61292 | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 1382 | virtual void GetErrorNodes(std::vector<ExplodedNode<ValueState>*>& Nodes); |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1383 | }; |
| 1384 | |
| 1385 | //===---------===// |
| 1386 | // Bug Reports. // |
| 1387 | //===---------===// |
| 1388 | |
| 1389 | class VISIBILITY_HIDDEN CFRefReport : public RangedBugReport { |
| 1390 | SymbolID Sym; |
| 1391 | public: |
Ted Kremenek | 95cc1ba | 2008-04-18 20:54:29 +0000 | [diff] [blame] | 1392 | CFRefReport(BugType& D, ExplodedNode<ValueState> *n, SymbolID sym) |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1393 | : 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 | |
| 1407 | void 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 | |
| 1414 | PathDiagnosticPiece* 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 Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1427 | CFRefCount::RefBindings::TreeTy* PrevT = PrevB.SlimFind(Sym); |
| 1428 | CFRefCount::RefBindings::TreeTy* CurrT = CurrB.SlimFind(Sym); |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1429 | |
Ted Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1430 | if (!CurrT) |
| 1431 | return NULL; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1432 | |
Ted Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1433 | const char* Msg = NULL; |
| 1434 | RefVal CurrV = CurrB.SlimFind(Sym)->getValue().second; |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1435 | |
Ted Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1436 | 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 Kremenek | 79c140b | 2008-04-18 05:32:44 +0000 | [diff] [blame] | 1478 | 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 Kremenek | 2cf943a | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1486 | |
| 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 Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1529 | } |
| 1530 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1531 | void UseAfterRelease::EmitWarnings(BugReporter& BR) { |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1532 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1533 | for (CFRefCount::use_after_iterator I = TF.use_after_begin(), |
| 1534 | E = TF.use_after_end(); I != E; ++I) { |
| 1535 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1536 | CFRefReport report(*this, I->first, I->second.second); |
| 1537 | report.addRange(I->second.first->getSourceRange()); |
Ted Kremenek | 75840e1 | 2008-04-18 01:56:37 +0000 | [diff] [blame] | 1538 | BR.EmitWarning(report); |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1539 | } |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1540 | } |
| 1541 | |
| 1542 | void BadRelease::EmitWarnings(BugReporter& BR) { |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1543 | |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1544 | for (CFRefCount::bad_release_iterator I = TF.bad_release_begin(), |
| 1545 | E = TF.bad_release_end(); I != E; ++I) { |
| 1546 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1547 | CFRefReport report(*this, I->first, I->second.second); |
| 1548 | report.addRange(I->second.first->getSourceRange()); |
| 1549 | BR.EmitWarning(report); |
Ted Kremenek | 05cbe1a | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1550 | } |
| 1551 | } |
Ted Kremenek | fa34b33 | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1552 | |
Ted Kremenek | 989d519 | 2008-04-17 23:43:50 +0000 | [diff] [blame] | 1553 | void Leak::EmitWarnings(BugReporter& BR) { |
| 1554 | |
| 1555 | for (CFRefCount::leaks_iterator I = TF.leaks_begin(), |
| 1556 | E = TF.leaks_end(); I != E; ++I) { |
| 1557 | |
Ted Kremenek | 8dd5646 | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1558 | 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 Kremenek | 989d519 | 2008-04-17 23:43:50 +0000 | [diff] [blame] | 1565 | } |
| 1566 | } |
| 1567 | |
Ted Kremenek | cb61292 | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 1568 | void 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 Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1574 | //===----------------------------------------------------------------------===// |
Ted Kremenek | d71ed26 | 2008-04-10 22:16:52 +0000 | [diff] [blame] | 1575 | // Transfer function creation for external clients. |
Ted Kremenek | 6b3a0f7 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1576 | //===----------------------------------------------------------------------===// |
| 1577 | |
Ted Kremenek | 3ea0b6a | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 1578 | GRTransferFuncs* clang::MakeCFRefCountTF(ASTContext& Ctx) { |
| 1579 | return new CFRefCount(Ctx); |
| 1580 | } |