RetainCountChecker.cpp revision 491306a83c4f0f49f95a3bcbca8580cb98a91c7a
1910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//==-- RetainCountChecker.cpp - Checks for leaks and other issues -*- C++ -*--// 22fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek// 32fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek// The LLVM Compiler Infrastructure 42fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek// 52fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek// This file is distributed under the University of Illinois Open Source 62fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek// License. See LICENSE.TXT for details. 72fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek// 82fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek//===----------------------------------------------------------------------===// 92fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek// 10910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This file defines the methods for RetainCountChecker, which implements 11910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// a reference count checker for Core Foundation and Cocoa on (Mac OS X). 122fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek// 132fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek//===----------------------------------------------------------------------===// 142fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 15910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "ClangSACheckers.h" 160b526b454814fa693bf0b2a6748db58a65b9cb7cTed Kremenek#include "clang/AST/DeclObjC.h" 17b277159055933e610bbc80262b600d3ad7e0595cTed Kremenek#include "clang/AST/DeclCXX.h" 18072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek#include "clang/Basic/LangOptions.h" 19c9fa2f7bcc3061aa8bcdbe0df26d2c7cf7281539Ted Kremenek#include "clang/Basic/SourceManager.h" 20910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/Analysis/DomainSpecific/CocoaConventions.h" 21910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/StaticAnalyzer/Core/Checker.h" 22910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/StaticAnalyzer/Core/CheckerManager.h" 239b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" 249b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 25910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h" 269b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngineBuilders.h" 2718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h" 289b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.h" 29d1e5a89226da79f7e6f43d40facc46abda9e5245Jordy Rose#include "clang/StaticAnalyzer/Core/PathSensitive/ObjCMessage.h" 306b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek#include "llvm/ADT/DenseMap.h" 316b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek#include "llvm/ADT/FoldingSet.h" 326d34893fc886f4153f104de8880876764981cb7fTed Kremenek#include "llvm/ADT/ImmutableList.h" 330b526b454814fa693bf0b2a6748db58a65b9cb7cTed Kremenek#include "llvm/ADT/ImmutableMap.h" 346ed9afc804731284b9b6d275dce7053d13d0c044Ted Kremenek#include "llvm/ADT/STLExtras.h" 350b526b454814fa693bf0b2a6748db58a65b9cb7cTed Kremenek#include "llvm/ADT/StringExtras.h" 365f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner#include <cstdarg> 372fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 382fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenekusing namespace clang; 399ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremenekusing namespace ento; 40a64e89bbfa756816d1e4a48e5d6c03edf1d7f23bTed Kremenekusing llvm::StrInStrNoCase; 414c79e55951517e9b3c06d0b7ac4bd82320f43f4bTed Kremenek 42d775c66b3a1ea17e770cf8fbf4ae37c667c1e043Ted Kremeneknamespace { 43910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// Wrapper around different kinds of node builder, so that helper functions 44910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// can have a common interface. 45ea0978568c55d97aefe260348767ee40a31ca2a4Francois Pichetclass GenericNodeBuilderRefCount { 46d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis StmtNodeBuilder *SNB; 4703509aea098772644bf4662dc1c88634818ceeccZhongxing Xu const Stmt *S; 48ca804539d908d3a0e8c72a0df5f1f571d29490bbTed Kremenek const ProgramPointTag *tag; 49e36de1fe51c39d9161915dd3dbef880954af6476Ted Kremenek EndOfFunctionNodeBuilder *ENB; 509d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenekpublic: 51ea0978568c55d97aefe260348767ee40a31ca2a4Francois Pichet GenericNodeBuilderRefCount(StmtNodeBuilder &snb, const Stmt *s, 52ca804539d908d3a0e8c72a0df5f1f571d29490bbTed Kremenek const ProgramPointTag *t) 539d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek : SNB(&snb), S(s), tag(t), ENB(0) {} 54031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 55ea0978568c55d97aefe260348767ee40a31ca2a4Francois Pichet GenericNodeBuilderRefCount(EndOfFunctionNodeBuilder &enb) 569d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek : SNB(0), S(0), tag(0), ENB(&enb) {} 571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *MakeNode(const ProgramState *state, ExplodedNode *Pred) { 599d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek if (SNB) 601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return SNB->generateNode(PostStmt(S, Pred->getLocationContext(), tag), 6125e695b2d574d919cc1bbddf3a2efe073d449b1cZhongxing Xu state, Pred); 621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 639d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek assert(ENB); 6480c24182549f45b9b3aa1cec1e547e8c4c09179bTed Kremenek return ENB->generateNode(state, Pred); 659d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek } 669d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek}; 679d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek} // end anonymous namespace 689d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek 6905cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek//===----------------------------------------------------------------------===// 70553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Primitives used for constructing summaries for function/method calls. 7105cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek//===----------------------------------------------------------------------===// 7205cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek 73553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// ArgEffect is used to summarize a function/method call's effect on a 74553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// particular argument. 75bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Roseenum ArgEffect { DoNothing, Autorelease, Dealloc, DecRef, DecRefMsg, 76f85e193739c953358c865005855253af4f68a497John McCall DecRefBridgedTransfered, 77bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Rose IncRefMsg, IncRef, MakeCollectable, MayEscape, 78f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek NewAutoreleasePool, SelfOwn, StopTracking }; 79553cf18cd44769a7624fc942493f076498527529Ted Kremenek 806b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremeneknamespace llvm { 81b77449cead63264650958c92cb30609c942cc5e9Ted Kremenektemplate <> struct FoldingSetTrait<ArgEffect> { 82b77449cead63264650958c92cb30609c942cc5e9Ted Kremenekstatic inline void Profile(const ArgEffect X, FoldingSetNodeID& ID) { 83b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ID.AddInteger((unsigned) X); 84b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek} 85553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 866b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end llvm namespace 876b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 88b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek/// ArgEffects summarizes the effects of a function/method call on all of 89b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek/// its arguments. 90b77449cead63264650958c92cb30609c942cc5e9Ted Kremenektypedef llvm::ImmutableMap<unsigned,ArgEffect> ArgEffects; 91b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek 926b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremeneknamespace { 93553cf18cd44769a7624fc942493f076498527529Ted Kremenek 94553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// RetEffect is used to summarize a function/method call's behavior with 951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// respect to its return value. 96ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetEffect { 976b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 9876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose enum Kind { NoRet, OwnedSymbol, OwnedAllocatedSymbol, 99f85e193739c953358c865005855253af4f68a497John McCall NotOwnedSymbol, GCNotOwnedSymbol, ARCNotOwnedSymbol, 10078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek OwnedWhenTrackedReceiver }; 1011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum ObjKind { CF, ObjC, AnyObj }; 1032d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 1046b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekprivate: 1052d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek Kind K; 1062d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek ObjKind O; 1072d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 10876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose RetEffect(Kind k, ObjKind o = AnyObj) : K(k), O(o) {} 1091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1106b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 1112d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek Kind getKind() const { return K; } 1122d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 1132d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek ObjKind getObjKind() const { return O; } 1141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 115a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek bool isOwned() const { 11678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek return K == OwnedSymbol || K == OwnedAllocatedSymbol || 11778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek K == OwnedWhenTrackedReceiver; 118a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek } 1191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1204df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetEffect &Other) const { 1214df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return K == Other.K && O == Other.O; 1224df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 1234df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 12478a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek static RetEffect MakeOwnedWhenTrackedReceiver() { 12578a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek return RetEffect(OwnedWhenTrackedReceiver, ObjC); 12678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek } 1271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1282d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek static RetEffect MakeOwned(ObjKind o, bool isAllocated = false) { 1292d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return RetEffect(isAllocated ? OwnedAllocatedSymbol : OwnedSymbol, o); 1301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1312d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek static RetEffect MakeNotOwned(ObjKind o) { 1322d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return RetEffect(NotOwnedSymbol, o); 133e798e7c5a107ff5262005431817409a855a67922Ted Kremenek } 134e798e7c5a107ff5262005431817409a855a67922Ted Kremenek static RetEffect MakeGCNotOwned() { 135e798e7c5a107ff5262005431817409a855a67922Ted Kremenek return RetEffect(GCNotOwnedSymbol, ObjC); 136e798e7c5a107ff5262005431817409a855a67922Ted Kremenek } 137f85e193739c953358c865005855253af4f68a497John McCall static RetEffect MakeARCNotOwned() { 138f85e193739c953358c865005855253af4f68a497John McCall return RetEffect(ARCNotOwnedSymbol, ObjC); 139f85e193739c953358c865005855253af4f68a497John McCall } 140553cf18cd44769a7624fc942493f076498527529Ted Kremenek static RetEffect MakeNoRet() { 141553cf18cd44769a7624fc942493f076498527529Ted Kremenek return RetEffect(NoRet); 142a73447013c919d43f40c05451f5e4b662c043d6dTed Kremenek } 1436b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 1441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 145b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 146b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// Reference-counting logic (typestate + counts). 147b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 1481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 149ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RefVal { 150b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 151b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek enum Kind { 152b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Owned = 0, // Owning reference. 153b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek NotOwned, // Reference is not owned by still valid (not freed). 154b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Released, // Object has been released. 155b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedOwned, // Returned object passes ownership to caller. 156b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedNotOwned, // Return object does not pass ownership to caller. 157b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_START, 158b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocNotOwned, // -dealloc called on non-owned object. 159b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocGC, // Calling -dealloc with GC enabled. 160b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorUseAfterRelease, // Object used after released. 161b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReleaseNotOwned, // Release of an object that was not owned. 162b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_LEAK_START, 163b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeak, // A memory leak due to excessive reference counts. 164b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeakReturned, // A memory leak due to the returning method not having 165b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // the correct naming conventions. 166b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorGCLeakReturned, 167b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorOverAutorelease, 168b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReturnedNotOwned 169b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek }; 170dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 171b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekprivate: 172b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind kind; 173b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind okind; 174b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Cnt; 175b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned ACnt; 176b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType T; 177dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 178b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal(Kind k, RetEffect::ObjKind o, unsigned cnt, unsigned acnt, QualType t) 179b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek : kind(k), okind(o), Cnt(cnt), ACnt(acnt), T(t) {} 180dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 181b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 182b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind getKind() const { return kind; } 183dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 184b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind getObjKind() const { return okind; } 185dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 186b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCount() const { return Cnt; } 187b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getAutoreleaseCount() const { return ACnt; } 188b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCombinedCounts() const { return Cnt + ACnt; } 189b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void clearCounts() { Cnt = 0; ACnt = 0; } 190b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setCount(unsigned i) { Cnt = i; } 191b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setAutoreleaseCount(unsigned i) { ACnt = i; } 192dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 193b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType getType() const { return T; } 194dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 195b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isOwned() const { 196b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == Owned; 197b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 198dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 199b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isNotOwned() const { 200b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == NotOwned; 201b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 202dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 203b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedOwned() const { 204b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedOwned; 205b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 206dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 207b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedNotOwned() const { 208b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedNotOwned; 209b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 210dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 211b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeOwned(RetEffect::ObjKind o, QualType t, 212b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 1) { 213b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(Owned, o, Count, 0, t); 214b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 215dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 216b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeNotOwned(RetEffect::ObjKind o, QualType t, 217b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 0) { 218b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(NotOwned, o, Count, 0, t); 219b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 220dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 221b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Comparison, profiling, and pretty-printing. 222dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 223b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool operator==(const RefVal& X) const { 224b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return kind == X.kind && Cnt == X.Cnt && T == X.T && ACnt == X.ACnt; 225b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 226dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 227b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator-(size_t i) const { 228b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount() - i, 229b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getAutoreleaseCount(), getType()); 230b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 231dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 232b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator+(size_t i) const { 233b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount() + i, 234b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getAutoreleaseCount(), getType()); 235b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 236dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 237b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator^(Kind k) const { 238b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(k, getObjKind(), getCount(), getAutoreleaseCount(), 239b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 240b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 241dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 242b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal autorelease() const { 243b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount(), getAutoreleaseCount()+1, 244b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 245b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 246dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 247b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 248b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger((unsigned) kind); 249b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(Cnt); 250b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(ACnt); 251b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.Add(T); 252b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 253dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2549c378f705405d37f49795d5e915989de774fe11fTed Kremenek void print(raw_ostream &Out) const; 255b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek}; 256b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 2579c378f705405d37f49795d5e915989de774fe11fTed Kremenekvoid RefVal::print(raw_ostream &Out) const { 258b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (!T.isNull()) 259dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "Tracked " << T.getAsString() << '/'; 260dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 261b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek switch (getKind()) { 262910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose default: llvm_unreachable("Invalid RefVal kind"); 263b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Owned: { 264b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Owned"; 265b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 266b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 267b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 268b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 269dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 270b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case NotOwned: { 271b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "NotOwned"; 272b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 273b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 274b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 275b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 276dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 277b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedOwned: { 278b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedOwned"; 279b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 280b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 281b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 282b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 283dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 284b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedNotOwned: { 285b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedNotOwned"; 286b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 287b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 288b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 289b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 290dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 291b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Released: 292b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Released"; 293b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 294dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 295b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocGC: 296b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (GC)"; 297b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 298dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 299b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocNotOwned: 300b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (not-owned)"; 301b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 302dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 303b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeak: 304b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked"; 305b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 306dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 307b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeakReturned: 308b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (Bad naming)"; 309b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 310dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 311b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorGCLeakReturned: 312b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (GC-ed at return)"; 313b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 314dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 315b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorUseAfterRelease: 316b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Use-After-Release [ERROR]"; 317b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 318dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 319b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorReleaseNotOwned: 320b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Release of Not-Owned [ERROR]"; 321b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 322dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 323b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorOverAutorelease: 324b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Over autoreleased"; 325b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 326dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 327b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorReturnedNotOwned: 328b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Non-owned object returned instead of owned"; 329b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 330b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 331dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 332b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (ACnt) { 333b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << " [ARC +" << ACnt << ']'; 334b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 335b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 336b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} //end anonymous namespace 337b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 338b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 339b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// RefBindings - State used to track object reference counts. 340b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 341b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 342b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, RefVal> RefBindings; 343b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 344b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace clang { 3459ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 34618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> 34718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenekstruct ProgramStateTrait<RefBindings> 34818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<RefBindings> { 34918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static void *GDMIndex() { 35018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static int RefBIndex = 0; 35118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek return &RefBIndex; 35218c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek } 35318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek}; 354b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 3555a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} 356b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 357b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 358910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Function/Method behavior summaries. 359b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 360b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 361b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace { 362ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummary { 3631bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// Args - an ordered vector of (index, ArgEffect) pairs, where index 3641bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// specifies the argument (starting from 0). This can be sparsely 3651bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// populated; arguments with no entry in Args use 'DefaultArgEffect'. 366b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects Args; 3671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3681bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// DefaultArgEffect - The default ArgEffect to apply to arguments that 3691bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// do not have an entry in Args. 3701bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek ArgEffect DefaultArgEffect; 3711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 372553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Receiver - If this summary applies to an Objective-C message expression, 373553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// this is the effect applied to the state of the receiver. 3743c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek ArgEffect Receiver; 3751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 376553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ret - The effect on the return value. Used to indicate if the 37776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose /// function/method call returns a new tracked symbol. 3786b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek RetEffect Ret; 3791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3806b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 381b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetainSummary(ArgEffects A, RetEffect R, ArgEffect defaultEff, 382e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect ReceiverEff) 383e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose : Args(A), DefaultArgEffect(defaultEff), Receiver(ReceiverEff), Ret(R) {} 3841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 385553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArg - Return the argument effect on the argument specified by 386553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// idx (starting from 0). 3871ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek ArgEffect getArg(unsigned idx) const { 388b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek if (const ArgEffect *AE = Args.lookup(idx)) 389b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return *AE; 3901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3911bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek return DefaultArgEffect; 3921ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 39311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 39411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek void addArg(ArgEffects::Factory &af, unsigned idx, ArgEffect e) { 39511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek Args = af.add(Args, idx, e); 39611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 3971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 398885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setDefaultArgEffect - Set the default argument effect. 399885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setDefaultArgEffect(ArgEffect E) { 400885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek DefaultArgEffect = E; 401885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek } 4021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 403553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getRetEffect - Returns the effect on the return value of the call. 404b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetEffect getRetEffect() const { return Ret; } 4051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 406885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setRetEffect - Set the effect of the return value of the call. 407885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setRetEffect(RetEffect E) { Ret = E; } 4081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40912b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 41012b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek /// Sets the effect on the receiver of the message. 41112b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek void setReceiverEffect(ArgEffect e) { Receiver = e; } 41212b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 413553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getReceiverEffect - Returns the effect on the receiver of the call. 414553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// This is only meaningful if the summary applies to an ObjCMessageExpr*. 415b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffect getReceiverEffect() const { return Receiver; } 4164df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 4174df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// Test if two retain summaries are identical. Note that merely equivalent 4184df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// summaries are not necessarily identical (for example, if an explicit 4194df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// argument effect matches the default effect). 4204df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetainSummary &Other) const { 4214df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return Args == Other.Args && DefaultArgEffect == Other.DefaultArgEffect && 4224df54feb02d72b76249e846053d5d53d820bf832Jordy Rose Receiver == Other.Receiver && Ret == Other.Ret; 4234df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 4246b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 4254f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} // end anonymous namespace 4266b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 427553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 428553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for constructing summaries. 429553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 430553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4314f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 432ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryKey { 433553cf18cd44769a7624fc942493f076498527529Ted Kremenek IdentifierInfo* II; 434553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector S; 4351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 436553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(IdentifierInfo* ii, Selector s) 437553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(ii), S(s) {} 438553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4399c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, Selector s) 440553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(d ? d->getIdentifier() : 0), S(s) {} 44170b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek 4429c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, IdentifierInfo *ii, Selector s) 44370b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek : II(d ? d->getIdentifier() : ii), S(s) {} 4441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 445553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(Selector s) 446553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(0), S(s) {} 4471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 448553cf18cd44769a7624fc942493f076498527529Ted Kremenek IdentifierInfo* getIdentifier() const { return II; } 449553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector getSelector() const { return S; } 450553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 4514f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} 4524f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek 4534f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace llvm { 454553cf18cd44769a7624fc942493f076498527529Ted Kremenektemplate <> struct DenseMapInfo<ObjCSummaryKey> { 455553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getEmptyKey() { 456553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getEmptyKey(), 457553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::getEmptyKey()); 458553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 460553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getTombstoneKey() { 461553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getTombstoneKey(), 4621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump DenseMapInfo<Selector>::getTombstoneKey()); 463553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 465553cf18cd44769a7624fc942493f076498527529Ted Kremenek static unsigned getHashValue(const ObjCSummaryKey &V) { 466553cf18cd44769a7624fc942493f076498527529Ted Kremenek return (DenseMapInfo<IdentifierInfo*>::getHashValue(V.getIdentifier()) 4671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump & 0x88888888) 468553cf18cd44769a7624fc942493f076498527529Ted Kremenek | (DenseMapInfo<Selector>::getHashValue(V.getSelector()) 469553cf18cd44769a7624fc942493f076498527529Ted Kremenek & 0x55555555); 470553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 472553cf18cd44769a7624fc942493f076498527529Ted Kremenek static bool isEqual(const ObjCSummaryKey& LHS, const ObjCSummaryKey& RHS) { 473553cf18cd44769a7624fc942493f076498527529Ted Kremenek return DenseMapInfo<IdentifierInfo*>::isEqual(LHS.getIdentifier(), 474553cf18cd44769a7624fc942493f076498527529Ted Kremenek RHS.getIdentifier()) && 475553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::isEqual(LHS.getSelector(), 476553cf18cd44769a7624fc942493f076498527529Ted Kremenek RHS.getSelector()); 477553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 479553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 48006159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <> 48106159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<ObjCSummaryKey> { static const bool value = true; }; 482553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end llvm namespace 4831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 484553cf18cd44769a7624fc942493f076498527529Ted Kremeneknamespace { 485ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryCache { 486553cf18cd44769a7624fc942493f076498527529Ted Kremenek typedef llvm::DenseMap<ObjCSummaryKey, RetainSummary*> MapTy; 487553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy M; 488553cf18cd44769a7624fc942493f076498527529Ted Kremenekpublic: 489553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryCache() {} 4901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4919c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummary* find(const ObjCInterfaceDecl *D, IdentifierInfo *ClsName, 492a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek Selector S) { 4938711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Lookup the method using the decl for the class @interface. If we 4948711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // have no decl, lookup using the class name. 4958711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek return D ? find(D, S) : find(ClsName, S); 4968711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 4971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4989c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummary* find(const ObjCInterfaceDecl *D, Selector S) { 499553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Do a lookup with the (D,S) pair. If we find a match return 500553cf18cd44769a7624fc942493f076498527529Ted Kremenek // the iterator. 501553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey K(D, S); 502553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy::iterator I = M.find(K); 5031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 504553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (I != M.end() || !D) 505614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I->second; 5061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 507553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Walk the super chain. If we find a hit with a parent, we'll end 508553cf18cd44769a7624fc942493f076498527529Ted Kremenek // up returning that summary. We actually allow that key (null,S), as 509553cf18cd44769a7624fc942493f076498527529Ted Kremenek // we cache summaries for the null ObjCInterfaceDecl* to allow us to 510553cf18cd44769a7624fc942493f076498527529Ted Kremenek // generate initial summaries without having to worry about NSObject 511553cf18cd44769a7624fc942493f076498527529Ted Kremenek // being declared. 512553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: We may change this at some point. 5139c378f705405d37f49795d5e915989de774fe11fTed Kremenek for (ObjCInterfaceDecl *C=D->getSuperClass() ;; C=C->getSuperClass()) { 514553cf18cd44769a7624fc942493f076498527529Ted Kremenek if ((I = M.find(ObjCSummaryKey(C, S))) != M.end()) 515553cf18cd44769a7624fc942493f076498527529Ted Kremenek break; 5161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 517553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (!C) 518614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return NULL; 5194f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek } 5201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Cache the summary with original key to make the next lookup faster 522553cf18cd44769a7624fc942493f076498527529Ted Kremenek // and return the iterator. 523614cc540a617978814e37d75bf5066926b921a0aTed Kremenek RetainSummary *Summ = I->second; 524614cc540a617978814e37d75bf5066926b921a0aTed Kremenek M[K] = Summ; 525614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return Summ; 526553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 528614cc540a617978814e37d75bf5066926b921a0aTed Kremenek RetainSummary* find(IdentifierInfo* II, Selector S) { 529553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: Class method lookup. Right now we dont' have a good way 530553cf18cd44769a7624fc942493f076498527529Ted Kremenek // of going between IdentifierInfo* and the class hierarchy. 531614cc540a617978814e37d75bf5066926b921a0aTed Kremenek MapTy::iterator I = M.find(ObjCSummaryKey(II, S)); 5321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 533614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (I == M.end()) 534614cc540a617978814e37d75bf5066926b921a0aTed Kremenek I = M.find(ObjCSummaryKey(S)); 5351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 536614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I == M.end() ? NULL : I->second; 537553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 539553cf18cd44769a7624fc942493f076498527529Ted Kremenek RetainSummary*& operator[](ObjCSummaryKey K) { 540553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[K]; 541553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 543553cf18cd44769a7624fc942493f076498527529Ted Kremenek RetainSummary*& operator[](Selector S) { 544553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[ ObjCSummaryKey(S) ]; 545553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 547553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end anonymous namespace 548553cf18cd44769a7624fc942493f076498527529Ted Kremenek 549553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 550553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for managing collections of summaries. 551553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 552553cf18cd44769a7624fc942493f076498527529Ted Kremenek 5534f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 554ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummaryManager { 555d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 556d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 557d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Typedefs. 558d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 560bc5495b666fc5243effe91c9a63e6196b77f9518Zhongxing Xu typedef llvm::DenseMap<const FunctionDecl*, RetainSummary*> 561d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy; 5621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5634f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek typedef ObjCSummaryCache ObjCMethodSummariesTy; 5641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 565d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 566d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Data. 567d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 569553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ctx - The ASTContext object for the analyzed ASTs. 5709c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &Ctx; 571179064eb831125630c296556dd6d67e67f716143Ted Kremenek 572553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// GCEnabled - Records whether or not the analyzed code runs in GC mode. 573377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek const bool GCEnabled; 5741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 575f85e193739c953358c865005855253af4f68a497John McCall /// Records whether or not the analyzed code runs in ARC mode. 576f85e193739c953358c865005855253af4f68a497John McCall const bool ARCEnabled; 577f85e193739c953358c865005855253af4f68a497John McCall 578553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// FuncSummaries - A map from FunctionDecls to summaries. 5791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump FuncSummariesTy FuncSummaries; 5801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 581553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCClassMethodSummaries - A map from selectors (for instance methods) 582553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// to summaries. 5831f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCClassMethodSummaries; 584d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 585553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCMethodSummaries - A map from selectors to summaries. 5861f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCMethodSummaries; 587d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 588553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// BPAlloc - A BumpPtrAllocator used for allocating summaries, ArgEffects, 589553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// and all other data used by the checker. 590d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek llvm::BumpPtrAllocator BPAlloc; 5911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 592b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek /// AF - A factory for ArgEffects objects. 5931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ArgEffects::Factory AF; 5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 595553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ScratchArgs - A holding buffer for construct ArgEffects. 596d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek ArgEffects ScratchArgs; 5971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 598ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// ObjCAllocRetE - Default return effect for methods returning Objective-C 599ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// objects. 600ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek RetEffect ObjCAllocRetE; 601547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek 6021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// ObjCInitRetE - Default return effect for init methods returning 603ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek /// Objective-C objects. 604547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek RetEffect ObjCInitRetE; 6051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6067faca821633c9521030127bf7f42f032c73b24e2Ted Kremenek RetainSummary DefaultSummary; 607432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek RetainSummary* StopSummary; 6081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 609d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 610d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Methods. 611d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 6121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 613553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArgEffects - Returns a persistent ArgEffects object based on the 614553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// data in ScratchArgs. 615b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects getArgEffects(); 61600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 6171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum UnaryFuncKind { cfretain, cfrelease, cfmakecollectable }; 6181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 619896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekpublic: 62078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek RetEffect getObjAllocRetEffect() const { return ObjCAllocRetE; } 62178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek 6226ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek RetainSummary* getUnarySummary(const FunctionType* FT, UnaryFuncKind func); 6231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6249c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummary* getCFSummaryCreateRule(const FunctionDecl *FD); 6259c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummary* getCFSummaryGetRule(const FunctionDecl *FD); 6267df2ff45f101c87398329d0ea23c1377328dca40John McCall RetainSummary* getCFCreateGetRuleSummary(const FunctionDecl *FD); 6271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 628b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetainSummary* getPersistentSummary(ArgEffects AE, RetEffect RetEff, 6291bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek ArgEffect ReceiverEff = DoNothing, 630e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect DefaultEff = MayEscape); 631706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 6323c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek RetainSummary* getPersistentSummary(RetEffect RE, 6331bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek ArgEffect ReceiverEff = DoNothing, 6343eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek ArgEffect DefaultEff = MayEscape) { 6351bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek return getPersistentSummary(getArgEffects(), RE, ReceiverEff, DefaultEff); 6369c32d08925045b32d7c39516e35d860159252e1dTed Kremenek } 6371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6388711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek RetainSummary *getPersistentStopSummary() { 639432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek if (StopSummary) 640432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek return StopSummary; 6411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 642432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek StopSummary = getPersistentSummary(RetEffect::MakeNoRet(), 643432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek StopTracking, StopTracking); 644706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 645432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek return StopSummary; 6461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 647b309525445c8ec3d36e49568382029efc2740554Ted Kremenek 6488711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek RetainSummary *getInitMethodSummary(QualType RetTy); 64946e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek 6501f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeClassMethodSummaries(); 6511f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeMethodSummaries(); 652896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekprivate: 653553cf18cd44769a7624fc942493f076498527529Ted Kremenek void addNSObjectClsMethSummary(Selector S, RetainSummary *Summ) { 654553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCClassMethodSummaries[S] = Summ; 655553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 657553cf18cd44769a7624fc942493f076498527529Ted Kremenek void addNSObjectMethSummary(Selector S, RetainSummary *Summ) { 658553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCMethodSummaries[S] = Summ; 659553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6603aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek 6613aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek void addClassMethSummary(const char* Cls, const char* nullaryName, 6623aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek RetainSummary *Summ) { 6633aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6643aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6653aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6663aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek } 6671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6686c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek void addInstMethSummary(const char* Cls, const char* nullaryName, 6696c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek RetainSummary *Summ) { 6706c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6716c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6726c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek ObjCMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6736c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek } 6741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 675de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector generateSelector(va_list argp) { 6765f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<IdentifierInfo*, 10> II; 677de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6789e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek while (const char* s = va_arg(argp, const char*)) 6799e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek II.push_back(&Ctx.Idents.get(s)); 680de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return Ctx.Selectors.getSelector(II.size(), &II[0]); 682de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 6831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 684de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addMethodSummary(IdentifierInfo *ClsII, ObjCMethodSummariesTy& Summaries, 685de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek RetainSummary* Summ, va_list argp) { 686de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector S = generateSelector(argp); 687de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Summaries[ObjCSummaryKey(ClsII, S)] = Summ; 68870a733e64e2379a654631a14fa29e46761d5f80dTed Kremenek } 6891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 690af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek void addInstMethSummary(const char* Cls, RetainSummary* Summ, ...) { 691af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_list argp; 692af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_start(argp, Summ); 693de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls), ObjCMethodSummaries, Summ, argp); 6941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump va_end(argp); 695af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek } 6961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 697de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addClsMethSummary(const char* Cls, RetainSummary* Summ, ...) { 698de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 699de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 700de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls),ObjCClassMethodSummaries, Summ, argp); 701de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 702de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 704de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addClsMethSummary(IdentifierInfo *II, RetainSummary* Summ, ...) { 705de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 706de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 707de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(II, ObjCClassMethodSummaries, Summ, argp); 708de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 709de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 710de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7116b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 7121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7139c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummaryManager(ASTContext &ctx, bool gcenabled, bool usesARC) 714179064eb831125630c296556dd6d67e67f716143Ted Kremenek : Ctx(ctx), 715f85e193739c953358c865005855253af4f68a497John McCall GCEnabled(gcenabled), 716f85e193739c953358c865005855253af4f68a497John McCall ARCEnabled(usesARC), 717f85e193739c953358c865005855253af4f68a497John McCall AF(BPAlloc), ScratchArgs(AF.getEmptyMap()), 718f85e193739c953358c865005855253af4f68a497John McCall ObjCAllocRetE(gcenabled 719f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 720f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 721f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwned(RetEffect::ObjC, true))), 722f85e193739c953358c865005855253af4f68a497John McCall ObjCInitRetE(gcenabled 723f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 724f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 725f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwnedWhenTrackedReceiver())), 7263baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek DefaultSummary(AF.getEmptyMap() /* per-argument effects (none) */, 7277faca821633c9521030127bf7f42f032c73b24e2Ted Kremenek RetEffect::MakeNoRet() /* return effect */, 728ebd5a2dc1a3743fed9157379d89e5eb26293c9d6Ted Kremenek MayEscape, /* default argument effect */ 729ebd5a2dc1a3743fed9157379d89e5eb26293c9d6Ted Kremenek DoNothing /* receiver effect */), 730b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek StopSummary(0) { 731553cf18cd44769a7624fc942493f076498527529Ted Kremenek 732553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeClassMethodSummaries(); 733553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeMethodSummaries(); 734553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 7351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7369c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummary* getSummary(const FunctionDecl *FD); 7371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 738432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 73918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *state, 740b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek const LocationContext *LC); 741dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 742432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis RetainSummary* getInstanceMethodSummary(const ObjCMessage &msg, 7439c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID) { 744432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis return getInstanceMethodSummary(msg.getSelector(), 0, 745432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis ID, msg.getMethodDecl(), msg.getType(Ctx)); 7468711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 7471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 748ce8a41d020d0b171535d77f73adb8acb3e6a881eTed Kremenek RetainSummary* getInstanceMethodSummary(Selector S, IdentifierInfo *ClsName, 7499c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID, 750a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCMethodDecl *MD, 751a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek QualType RetTy); 752fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek 753fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek RetainSummary *getClassMethodSummary(Selector S, IdentifierInfo *ClsName, 754a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID, 755a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCMethodDecl *MD, 756a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek QualType RetTy); 7571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 758432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis RetainSummary *getClassMethodSummary(const ObjCMessage &msg) { 759432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const ObjCInterfaceDecl *Class = 0; 760432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis if (!msg.isInstanceMessage()) 761432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis Class = msg.getReceiverInterface(); 76204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 763432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis return getClassMethodSummary(msg.getSelector(), 76404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Class? Class->getIdentifier() : 0, 76504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Class, 766432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis msg.getMethodDecl(), msg.getType(Ctx)); 767fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek } 768552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek 769552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// getMethodSummary - This version of getMethodSummary is used to query 770552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// the summary for the current method being analyzed. 771a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek RetainSummary *getMethodSummary(const ObjCMethodDecl *MD) { 772a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek // FIXME: Eventually this should be unneeded. 773a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID = MD->getClassInterface(); 77470a6576c9c8d21ff2361574f4937a2e73bd57779Ted Kremenek Selector S = MD->getSelector(); 775552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek IdentifierInfo *ClsName = ID->getIdentifier(); 776552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek QualType ResultTy = MD->getResultType(); 7771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 778552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek if (MD->isInstanceMethod()) 779552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek return getInstanceMethodSummary(S, ClsName, ID, MD, ResultTy); 780552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek else 781552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek return getClassMethodSummary(S, ClsName, ID, MD, ResultTy); 782552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek } 7831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7849c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummary* getCommonMethodSummary(const ObjCMethodDecl *MD, 785a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek Selector S, QualType RetTy); 786a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek 7874df54feb02d72b76249e846053d5d53d820bf832Jordy Rose void updateSummaryFromAnnotations(RetainSummary *&Summ, 7884dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD); 7894dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 7904df54feb02d72b76249e846053d5d53d820bf832Jordy Rose void updateSummaryFromAnnotations(RetainSummary *&Summ, 7914dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD); 7924dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 793d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek bool isGCEnabled() const { return GCEnabled; } 7941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 795f85e193739c953358c865005855253af4f68a497John McCall bool isARCEnabled() const { return ARCEnabled; } 796f85e193739c953358c865005855253af4f68a497John McCall 797f85e193739c953358c865005855253af4f68a497John McCall bool isARCorGCEnabled() const { return GCEnabled || ARCEnabled; } 798f85e193739c953358c865005855253af4f68a497John McCall 799885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek RetainSummary *copySummary(RetainSummary *OldSumm) { 800885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek RetainSummary *Summ = (RetainSummary*) BPAlloc.Allocate<RetainSummary>(); 801885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek new (Summ) RetainSummary(*OldSumm); 802885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek return Summ; 8031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 8046b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 8051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8060fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// Used to avoid allocating long-term (BPAlloc'd) memory for default retain 8070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// summaries. If a function or method looks like it has a default summary, but 8080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// it has annotations, the annotations are added to the stack-based template 8090fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// and then copied into managed memory. 8100fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Roseclass RetainSummaryTemplate { 8110fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &Manager; 8120fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *&RealSummary; 8130fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary ScratchSummary; 8140fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose bool Accessed; 8150fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rosepublic: 8160fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryTemplate(RetainSummary *&real, const RetainSummary &base, 8170fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &manager) 8180fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose : Manager(manager), RealSummary(real), ScratchSummary(base), Accessed(false) 8190fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose {} 8200fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8210fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose ~RetainSummaryTemplate() { 8220fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose if (!RealSummary && Accessed) 8230fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RealSummary = Manager.copySummary(&ScratchSummary); 8240fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8250fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8260fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary &operator*() { 8270fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 8280fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose return RealSummary ? *RealSummary : ScratchSummary; 8290fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8310fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *operator->() { 8320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 8330fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose return RealSummary ? RealSummary : &ScratchSummary; 8340fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8350fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose}; 8360fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8376b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end anonymous namespace 8386b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 8396b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8406b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek// Implementation of checker data structures. 8416b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8426b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 843b77449cead63264650958c92cb30609c942cc5e9Ted KremenekArgEffects RetainSummaryManager::getArgEffects() { 844b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects AE = ScratchArgs; 8453baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.getEmptyMap(); 846b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return AE; 84700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 84800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 8493c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted KremenekRetainSummary* 850b77449cead63264650958c92cb30609c942cc5e9Ted KremenekRetainSummaryManager::getPersistentSummary(ArgEffects AE, RetEffect RetEff, 8511bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek ArgEffect ReceiverEff, 852e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect DefaultEff) { 853891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Create the summary and return it. 85422fe248abdab6ff458d57b7f0afa562d63908d25Ted Kremenek RetainSummary *Summ = (RetainSummary*) BPAlloc.Allocate<RetainSummary>(); 855e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose new (Summ) RetainSummary(AE, RetEff, DefaultEff, ReceiverEff); 85600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek return Summ; 85700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 85800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 859d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 860d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for functions (largely uses of Core Foundation). 861d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 86200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 8639c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRetain(const FunctionDecl *FD, StringRef FName) { 864b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Retain"); 8651261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8661261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 8679c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRelease(const FunctionDecl *FD, StringRef FName) { 868b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Release"); 8691261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8701261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 87176c506fba2359296d1f19e64998bd11d7b864563Jordy Rosestatic bool isMakeCollectable(const FunctionDecl *FD, StringRef FName) { 87276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Remove FunctionDecl parameter. 87376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Is it really okay if MakeCollectable isn't a suffix? 87476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return FName.find("MakeCollectable") != StringRef::npos; 87576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 87676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 8779c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummary* RetainSummaryManager::getSummary(const FunctionDecl *FD) { 878891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 879d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 880d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 881891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 882891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 883e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 8841261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek RetainSummary *S = 0; 8851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 88637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 8871261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 8881261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 8891261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 8901261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 8911261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 8929ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // For C++ methods, generate an implicit "stop" summary as well. We 8939ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // can relax this once we have a clear policy for C++ methods and 8949ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // ownership attributes. 8959ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek if (isa<CXXMethodDecl>(FD)) { 8969ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek S = getPersistentStopSummary(); 8979ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek break; 8989ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek } 8991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 900183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 90199890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 902183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 90348c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 90448c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 90548c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 906b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 907b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 9081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 909bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 910bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 911b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 9121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9131261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 9141261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 9151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9161261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 9171261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 918008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 919e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 920b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer if (FName == "pthread_create") { 921b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of: <rdar://problem/7299394>. This will be addressed 922b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // better with IPA. 923b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 924b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 925b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 926b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 927b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 928b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 929b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 930b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 931b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 932b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 933b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 934b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 935b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 936b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 937b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 938b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 939b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 940b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 941b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 942b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 9433baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 944b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 945b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 946b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 947b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 948b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 9493baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 950b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 951b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 952b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 953b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 954b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 955b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 956b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 957b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 9583baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 959b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 960b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 961b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 962b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 963b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 964b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 9653baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 966b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 967b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 968b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 969b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 970b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 971b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 972b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 973b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 9743baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 975b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 976b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 9771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 978b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 979b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 980b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 98161991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 98261991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Enable this code once the semantics of NSDeallocateObject are resolved 98361991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // for GC. <rdar://problem/6619988> 98461991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#if 0 98561991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Handle: NSDeallocateObject(id anObject); 98661991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // This method does allow 'nil' (although we don't check it now). 9871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (strcmp(FName, "NSDeallocateObject") == 0) { 98861991903335144605031c3597a5c99e1565b0bd4Ted Kremenek return RetTy == Ctx.VoidTy 98961991903335144605031c3597a5c99e1565b0bd4Ted Kremenek ? getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, Dealloc) 99061991903335144605031c3597a5c99e1565b0bd4Ted Kremenek : getPersistentStopSummary(); 99161991903335144605031c3597a5c99e1565b0bd4Ted Kremenek } 99261991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#endif 9931261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 9941261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (RetTy->isPointerType()) { 9951261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 99678acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 9971261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 9981261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 99976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 10001261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 10011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 10027df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10031261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 100437d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 100537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10061261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10071261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 100878acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 10091261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10101261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 10111261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 10127df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10131261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 101437d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 101537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10161261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10171261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 101878acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 101978acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 102078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 10217df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1022706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1023706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 10241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10251261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 102637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10271261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10281261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 10291261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 10301261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1031e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1032b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1033e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1034bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 10351261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 10361261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1037b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 10386818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 10396818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 10406818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 10416818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 10426818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 10446818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 10451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 10466818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 10476818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10486818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1049c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1050c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1051c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1052c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1053e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1054e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1055e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1056e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1057c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 10586818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 10591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10606818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 10611261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 106264e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 106337d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 106437d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 10651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10664dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 10674df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(S, FD); 10681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1069d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 10701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 10712fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 10722fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 107337d785bf2b318cc1206e2653c914acc5295bb38cTed KremenekRetainSummary* 10747df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 10757df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 107686ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 10771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1078d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 107900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 108000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 1081d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed KremenekRetainSummary* 10826ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 10836ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 10846ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 10851261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 10861261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 108772564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 10881261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 10891261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 10901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1091b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 10921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1094377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 109576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 109676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 109776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 109876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose default: llvm_unreachable("Not a supported unary function."); 1099940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 110076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 110176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 110276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 110300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 110400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 1105bc5495b666fc5243effe91c9a63e6196b77f9518Zhongxing XuRetainSummary* 11069c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1107b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11092d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 111000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 111100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 1112bc5495b666fc5243effe91c9a63e6196b77f9518Zhongxing XuRetainSummary* 11139c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 11141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 11152d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 11162d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 111700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 111800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 11196b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1120d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1121d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1122d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 11231bffd7471bf3d392a3bc0e241c8d169cbde96156Ted KremenekRetainSummary* 11248711c03dda12863a7537f14025513f7717b14ce1Ted KremenekRetainSummaryManager::getInitMethodSummary(QualType RetTy) { 11251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(ScratchArgs.isEmpty()); 112678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek // 'init' methods conceptually return a newly allocated object and claim 11271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // the receiver. 11280556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek if (cocoa::isCocoaObjectRef(RetTy) || 11290556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek coreFoundation::isCFObjectRef(RetTy)) 1130547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek return getPersistentSummary(ObjCInitRetE, DecRefMsg); 11311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11324df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return 0; 113346e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek} 11344dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11354dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 11364df54feb02d72b76249e846053d5d53d820bf832Jordy RoseRetainSummaryManager::updateSummaryFromAnnotations(RetainSummary *&Summ, 11374dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 11384dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 11394dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11404dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11410fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryTemplate Template(Summ, DefaultSummary, *this); 11424df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 114311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 114411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 114511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 114698b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 114711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 114811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 11494df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 11500fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 11514df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 11524df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 11530fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 115411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 115511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 115611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1157b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 11581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11594dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 116078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 116140b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 11620fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 11634dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 116440b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 11650fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1166b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 11676041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>()) { 11680fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 11696041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11706041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11710fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 11726041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11734df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (RetTy->getAs<PointerType>()) { 117440b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 11750fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 11764dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1177d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11780fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1179d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 11804dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 11814dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 11824dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11834dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 11844df54feb02d72b76249e846053d5d53d820bf832Jordy RoseRetainSummaryManager::updateSummaryFromAnnotations(RetainSummary *&Summ, 11854dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD) { 11864dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 11874dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11884dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11890fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryTemplate Template(Summ, DefaultSummary, *this); 11904df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 11916d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 11921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 119312b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 119412b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 119511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 11960fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 119711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 119811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 119911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 120011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1201491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1202491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 120311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 120411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 120511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 120611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 120811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 120911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 12100fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 121111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 121212b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 121312b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 12144dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 121578acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 121640b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 12170fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 12186d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 12194dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 12206041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>()) { 12210fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 12226041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 12236041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12256d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 12260fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 12276217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 12280fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 12291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12306041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 12316041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 12320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 12336041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 12340fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 12356041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12364dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 12374dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 12381bffd7471bf3d392a3bc0e241c8d169cbde96156Ted KremenekRetainSummary* 12399c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCommonMethodSummary(const ObjCMethodDecl *MD, 1240a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek Selector S, QualType RetTy) { 12418ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek 1242fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek if (MD) { 1243376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Scan the method decl for 'void*' arguments. These should be treated 1244376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // as 'StopTracking' because they are often used with delegates. 1245376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Delegates are a frequent form of false positives with the retain 1246376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // count checker. 1247376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek unsigned i = 0; 1248491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator I = MD->param_begin(), 1249376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek E = MD->param_end(); I != E; ++I, ++i) 1250491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis if (const ParmVarDecl *PD = *I) { 1251376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek QualType Ty = Ctx.getCanonicalType(PD->getType()); 1252a4923eb7c4b04d360cb2747641a5e92818edf804Douglas Gregor if (Ty.getLocalUnqualifiedType() == Ctx.VoidPtrTy) 12533baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, i, StopTracking); 1254376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 1255376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 12561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12578ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // Any special effect for the receiver? 12588ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 12591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12608ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 12618ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 12628ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 12638ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 12648ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 12658ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek const std::string &str = S.getAsString(); 12668ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek assert(!str.empty()); 1267e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer if (StrInStrNoCase(str, "delegate:") != StringRef::npos) 1268e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ReceiverEff = StopTracking; 12698ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 12701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1271250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek // Look for methods that return an owned object. 127278acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 127328f47b92e760ccf641ac91cb0fe1c12d9ca89795Ted Kremenek // EXPERIMENTAL: assume the Cocoa conventions for all objects returned 127492511433cc78021dca5f340136be1bbd72388191Ted Kremenek // by instance methods. 1275786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor RetEffect E = cocoa::followsFundamentalRule(S, MD) 12767db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek ? ObjCAllocRetE : RetEffect::MakeNotOwned(RetEffect::ObjC); 12771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return getPersistentSummary(E, ReceiverEff, MayEscape); 1279376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 12801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 128192511433cc78021dca5f340136be1bbd72388191Ted Kremenek // Look for methods that return an owned core foundation object. 12820556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek if (coreFoundation::isCFObjectRef(RetTy)) { 1283786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor RetEffect E = cocoa::followsFundamentalRule(S, MD) 12847db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek ? RetEffect::MakeOwned(RetEffect::CF, true) 12857db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek : RetEffect::MakeNotOwned(RetEffect::CF); 12861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 128792511433cc78021dca5f340136be1bbd72388191Ted Kremenek return getPersistentSummary(E, ReceiverEff, MayEscape); 128892511433cc78021dca5f340136be1bbd72388191Ted Kremenek } 12891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 129092511433cc78021dca5f340136be1bbd72388191Ted Kremenek if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing) 12914df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return 0; 12921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1293885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek return getPersistentSummary(RetEffect::MakeNoRet(), ReceiverEff, MayEscape); 1294250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1295250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 1296250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted KremenekRetainSummary* 1297432424d67641d609e4990d791baa782fc161027eArgyrios KyrtzidisRetainSummaryManager::getInstanceMethodSummary(const ObjCMessage &msg, 129818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *state, 1299b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek const LocationContext *LC) { 1300b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1301b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // We need the type-information of the tracked receiver object 1302b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Retrieve it from the state. 1303432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const Expr *Receiver = msg.getInstanceReceiver(); 13049c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID = 0; 1305b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1306b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: Is this really working as expected? There are cases where 1307b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we just use the 'ID' from the message expression. 130804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor SVal receiverV; 130904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 13108f326751df18e78bdb7edf786a842def8a4f41e3Ted Kremenek if (Receiver) { 131104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor receiverV = state->getSValAsScalarOrLoc(Receiver); 1312dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 131304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Eventually replace the use of state->get<RefBindings> with 131404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // a generic API for reasoning about the Objective-C types of symbolic 131504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // objects. 131604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (SymbolRef Sym = receiverV.getAsLocSymbol()) 131704badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const RefVal *T = state->get<RefBindings>(Sym)) 1318dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek if (const ObjCObjectPointerType* PT = 1319b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 132004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 1321dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 132204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: this is a hack. This may or may not be the actual method 132304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // that is called. 132404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (!ID) { 132504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const ObjCObjectPointerType *PT = 132604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Receiver->getType()->getAs<ObjCObjectPointerType>()) 132704badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 132804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } 132904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } else { 133004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Hack for 'super'. 1331432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis ID = msg.getReceiverInterface(); 1332b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 133304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1334b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1335b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 13364df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return getInstanceMethodSummary(msg, ID); 1337b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1338b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1339b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted KremenekRetainSummary* 1340ce8a41d020d0b171535d77f73adb8acb3e6a881eTed KremenekRetainSummaryManager::getInstanceMethodSummary(Selector S, 1341ce8a41d020d0b171535d77f73adb8acb3e6a881eTed Kremenek IdentifierInfo *ClsName, 13429c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID, 1343a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCMethodDecl *MD, 1344ce8a41d020d0b171535d77f73adb8acb3e6a881eTed Kremenek QualType RetTy) { 13451bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 13468711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 1347614cc540a617978814e37d75bf5066926b921a0aTed Kremenek RetainSummary *Summ = ObjCMethodSummaries.find(ID, ClsName, S); 13481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1349614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1350614cc540a617978814e37d75bf5066926b921a0aTed Kremenek assert(ScratchArgs.isEmpty()); 13511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1352614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // "initXXX": pass-through for receiver. 1353786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor if (cocoa::deriveNamingConvention(S, MD) == cocoa::InitRule) 1354614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getInitMethodSummary(RetTy); 1355614cc540a617978814e37d75bf5066926b921a0aTed Kremenek else 1356614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getCommonMethodSummary(MD, S, RetTy); 13571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1358614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 13594df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 13601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1361614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 1362614cc540a617978814e37d75bf5066926b921a0aTed Kremenek ObjCMethodSummaries[ObjCSummaryKey(ID, ClsName, S)] = Summ; 1363614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 13641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1365e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 136646e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek} 136746e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek 1368c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted KremenekRetainSummary* 1369fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed KremenekRetainSummaryManager::getClassMethodSummary(Selector S, IdentifierInfo *ClsName, 1370a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID, 1371a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCMethodDecl *MD, 1372a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek QualType RetTy) { 1373de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 1374fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek assert(ClsName && "Class name must be specified."); 13751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump RetainSummary *Summ = ObjCClassMethodSummaries.find(ID, ClsName, S); 13761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1377614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1378614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getCommonMethodSummary(MD, S, RetTy); 13794df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1380614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 13814df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 13824df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1383614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 1384614cc540a617978814e37d75bf5066926b921a0aTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ID, ClsName, S)] = Summ; 1385614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 13861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1387e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1388c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1389c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 13901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1391ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 13921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 13936fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 13942d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 13951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13966d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 13973baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 13986fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 13996fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 14006fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 14011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1402de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // Create the summaries for [NSObject performSelector...]. We treat 1403de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // these as 'stop tracking' for the arguments because they are often 1404de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // used for delegates that can release the object. When we have better 1405de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // inter-procedural analysis we can potentially do something better. This 1406de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // workaround is to remove false positives. 1407012614ecf78442368ec82ee30efb3bc047b413e6Ted Kremenek RetainSummary *Summ = 1408012614ecf78442368ec82ee30efb3bc047b413e6Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, StopTracking); 1409de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek IdentifierInfo *NSObjectII = &Ctx.Idents.get("NSObject"); 1410de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1411de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", NULL); 1412de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1413de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", "inModes", NULL); 1414de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1415de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1416de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1417de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1418de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1419de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1420de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1421de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1422de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorInBackground", 1423de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", NULL); 14249c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 14259c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 14261f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 14271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 14291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1430c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1431c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 14321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1433ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1434ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1435ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1436ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1437ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1438ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 14391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1440c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 1441a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 14421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump RetainSummary *CFAllocSumm = 1443a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 14441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14453c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1446500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 1447500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1448553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 14491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14503c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1451500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1452553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 14531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1454299e8158d63d69830cca0187f4003cba1e66081fTed Kremenek // Create the "drain" selector. 1455500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, isGCEnabled() ? DoNothing : DecRef); 1456553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); 14571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1458f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1459500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1460f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 14613c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 14623c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1463500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1464553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 14651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1466f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek // Specially handle NSAutoreleasePool. 14676c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek addInstMethSummary("NSAutoreleasePool", "init", 1468500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose getPersistentSummary(NoRet, NewAutoreleasePool)); 14691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 147189e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 147289e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 147389e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 147489e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 14753aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 147678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 147778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 147878a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 14791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 148099d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 148199d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 14823aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#if 0 148378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1484af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 14851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 148678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1487af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 14883aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#endif 14891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1490179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1491179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 149299d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 149399d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 149499d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 14951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 149678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#if 0 149778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1498af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 14991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 150078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1501af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 150278a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#endif 15031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1504ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // Don't track allocated autorelease pools yet, as it is okay to prematurely 1505ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1506ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1507553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1508767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1509767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1510767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1511767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1512767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1513767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1514211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1515a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1516a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1517a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1518767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1519a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 15201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1521a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1522211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1523b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1524b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1525d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 15264d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek// AutoreleaseBindings - State used to track objects in autorelease pools. 15276d34893fc886f4153f104de8880876764981cb7fTed Kremenek//===----------------------------------------------------------------------===// 15286d34893fc886f4153f104de8880876764981cb7fTed Kremenek 15294d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, unsigned> ARCounts; 15304d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, ARCounts> ARPoolContents; 15314d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableList<SymbolRef> ARStack; 1532f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek 15334d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenekstatic int AutoRCIndex = 0; 15346d34893fc886f4153f104de8880876764981cb7fTed Kremenekstatic int AutoRBIndex = 0; 15356d34893fc886f4153f104de8880876764981cb7fTed Kremenek 1536ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleasePoolContents {}; } 1537ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleaseStack {}; } 15384d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 15396d34893fc886f4153f104de8880876764981cb7fTed Kremeneknamespace clang { 15409ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 154118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleaseStack> 154218c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARStack> { 15439c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRBIndex; } 15444d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15454d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 154618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleasePoolContents> 154718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARPoolContents> { 15489c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRCIndex; } 15494d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15505a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 15514d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek} // end clang namespace 15526d34893fc886f4153f104de8880876764981cb7fTed Kremenek 155318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenekstatic SymbolRef GetCurrentAutoreleasePool(const ProgramState *state) { 15547037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARStack stack = state->get<AutoreleaseStack>(); 15557037ab8f15950e594642adf77a56d299667debe7Ted Kremenek return stack.isEmpty() ? SymbolRef() : stack.getHead(); 15567037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 15577037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 155818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenekstatic const ProgramState * 155918c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekSendAutorelease(const ProgramState *state, 156018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ARCounts::Factory &F, 156118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek SymbolRef sym) { 15627037ab8f15950e594642adf77a56d299667debe7Ted Kremenek SymbolRef pool = GetCurrentAutoreleasePool(state); 1563b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const ARCounts *cnts = state->get<AutoreleasePoolContents>(pool); 15647037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARCounts newCnts(0); 15651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15667037ab8f15950e594642adf77a56d299667debe7Ted Kremenek if (cnts) { 15677037ab8f15950e594642adf77a56d299667debe7Ted Kremenek const unsigned *cnt = (*cnts).lookup(sym); 15683baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(*cnts, sym, cnt ? *cnt + 1 : 1); 15697037ab8f15950e594642adf77a56d299667debe7Ted Kremenek } 15707037ab8f15950e594642adf77a56d299667debe7Ted Kremenek else 15713baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(F.getEmptyMap(), sym, 1); 15721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1573b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek return state->set<AutoreleasePoolContents>(pool, newCnts); 15747037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 15757037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 15761392261ff4418a070fb919cb4832b76b468b6faaTed Kremenek//===----------------------------------------------------------------------===// 1577c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1578c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1579c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1580ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1581ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1582ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1583c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1584c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 15851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 15861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1587ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1588c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 158935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 159035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : BugType(name, "Memory (Core Foundation/Objective-C)") {} 1591c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 15921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1593c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 159435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 15951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1596c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1597c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 15981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1599ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1600c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 160135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 160335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1604c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1606c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1608ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1609c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 161035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 16111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 161235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1613bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1614bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1615b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1616c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1618ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1619c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 162035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 162135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 16221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1623c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1624369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 16251499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1626c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1628ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1629c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 163035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 163135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 16321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1633c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1634c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 163500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 16361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1638ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1639369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 164035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 164135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 16421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1643369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1644eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1645369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1646369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 16471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1648ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1649e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 165035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 165135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 16521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1653e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 16545b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1655e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1656e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1657e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 16581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1659ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1660c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const bool isReturn; 1661c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 166235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose Leak(StringRef name, bool isRet) 1663db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose : CFRefBug(name), isReturn(isRet) { 1664db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1665db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1666db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 1667c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 166935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 16701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1671c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1672c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1674ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class LeakAtReturn : public Leak { 1675c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 167635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose LeakAtReturn(StringRef name) 167735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Leak(name, true) {} 1678c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1680ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class LeakWithinFunction : public Leak { 1681c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 168235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose LeakWithinFunction(StringRef name) 168335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Leak(name, false) {} 16841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1686c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1687c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1688c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 16891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1690dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks class CFRefReportVisitor : public BugReporterVisitor { 169123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1692dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1693ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 169435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 169523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1696dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 169735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 169835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1699dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 170023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1701dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1702dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1703dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1704dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1705dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 170623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 170723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 170823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 170923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 171023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 171123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 171223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 171323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 171423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 171523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 171623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 171723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 171835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1719ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 172035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 172123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 172223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 172323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 172423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1725dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1726dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1727e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 17282058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 172935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1730c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17312058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17322058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17332058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1734edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 173523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 17362058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17372058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1738dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1739eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 17402058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17412058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17422058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1743edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 17442058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17452058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1746dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 17471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1748e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1749edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1750edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1751e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1752c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1753640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1754c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1755c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1756eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1757ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1758c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 175923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1760c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17612058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17622058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17632058956954802229bf98604e8063fa57677abff4Jordy Rose ExprEngine &Eng); 17641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1765590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1766590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1767590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1768590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 17691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 17705216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 17715216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 17722058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 17732058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1774f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 17751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1776e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 17777f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 17782058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 177935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 178035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 17811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 17827f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 17832058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 178435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 178535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 17861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 17877f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 17882058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 178935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 179035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 179135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 179235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 179335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 179435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 179535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 179635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 179735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 17987f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1799c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 180035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1801f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 180235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1803c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1804e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1805910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18065f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1807c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18085f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1809c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1810c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 18111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1812c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1813c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1814c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 1815dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1816dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1817dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1818dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 18191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1820f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<StmtPoint>(N->getLocation())) 18212033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 18221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18238966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 182418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *PrevSt = PrevN->getState(); 182518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *CurrSt = N->getState(); 18261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const RefVal* CurrT = CurrSt->get<RefBindings>(Sym); 1828c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 18291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1830b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 1831b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal *PrevT = PrevSt->get<RefBindings>(Sym); 18321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1833c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1834c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1835c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1836c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 18371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1838c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1839c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1840c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 1841f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 18421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18435f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1844c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the callee (if it is available). 18451397663af9dbcc24dbf0e11de43931b3dc08fdbbTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee()); 18469c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 1847900fc6388e803868a34b9483510c345e9b49d7ebBenjamin Kramer os << "Call to function '" << FD << '\''; 1848c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 18491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump os << "function call"; 18501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 185114429b918bd2f4cb52abc75546a7fe37142054caArgyrios Kyrtzidis else if (isa<ObjCMessageExpr>(S)) { 1852c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Method"; 185314429b918bd2f4cb52abc75546a7fe37142054caArgyrios Kyrtzidis } else { 185414429b918bd2f4cb52abc75546a7fe37142054caArgyrios Kyrtzidis os << "Property"; 1855c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 18561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1857c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 1858c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " returns a Core Foundation object with a "; 1859c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1860c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else { 1861c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 1862c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " returns an Objective-C object with a "; 18634fd8897f81e2d9e2d9b8c6a5f10fe0dae3e52223Ted Kremenek } 18641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1865c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.isOwned()) { 1866f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "+1 retain count"; 18671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 186835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 1869c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 18705b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose os << ". " 1871c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "Core Foundation objects are not automatically garbage collected."; 1872c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 18734fd8897f81e2d9e2d9b8c6a5f10fe0dae3e52223Ted Kremenek } 1874c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else { 1875c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert (CurrV.isNotOwned()); 1876f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "+0 retain count"; 1877cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 18781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1879220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 1880220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 1881c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 1882cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 18831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1884c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 1885c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 18865f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 18871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1888ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 1889ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 1890c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 1891c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 1892f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 18931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18945f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1895c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 1896c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 1897c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 18981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18995f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 1900c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 19011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1902c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 1903c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 19041397663af9dbcc24dbf0e11de43931b3dc08fdbbTed Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI).getAsLocSymbol() != Sym) 1905c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 19061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1907c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 1908c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 1909c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1910c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 191204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 19131397663af9dbcc24dbf0e11de43931b3dc08fdbbTed Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver).getAsLocSymbol() == Sym) { 1914c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 1915c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 1916c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1917c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19181c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 19191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1920c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 1921c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 1922c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 19231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1924c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 192535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 1926c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 1927c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 1928c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 1929c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 1930c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 1931f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 1932c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 1933f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 1934f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 1935c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1937c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 1938c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 1939c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 1940f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19411397663af9dbcc24dbf0e11de43931b3dc08fdbbTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee()); 19429c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 19431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 194435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 1945c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 1946c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 19471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19487df1234c2e62b2a23dc4417e527f941c20ebe858Jordy Rose os << "In GC mode a call to '" << FD 1949c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 1950c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 19511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1952c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 1953c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 1954c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 1955c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 1956c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1957c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1958c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 1959c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 1960c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 19613eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 19621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 19637df1234c2e62b2a23dc4417e527f941c20ebe858Jordy Rose os << "When GC is not enabled a call to '" << FD 1964c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 19651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1966c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 1967c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 1968c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 1971c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 1972c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 19731ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 19741ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 19751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1976f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 1977f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 1978f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 1979f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 19801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1981264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 1982eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 1983f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 1984f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 19851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1986c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 1987c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 1988c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1989c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 19901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1991c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 1992c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 19931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1994c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 199535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 1996c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object is not eligible for garbage collection until the " 1997c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "retain count reaches 0 again."; 1998c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2000c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20021ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2003c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 20041ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 20051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2006c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 2007c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object returned to caller as an owning reference (single retain " 2008f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count transferred to caller)"; 2009c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2011c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2012f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2013c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2015c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2016c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2017c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2019c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 20205f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2021c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 20221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2023c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 202435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2025c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2026c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2027c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2028c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2029c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2030c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2031c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2032c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2033c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2034c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2035c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2036c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2037c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 20391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2040c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2041c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 20422033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 2043f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 2044220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2045220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 20469c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 20471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2048c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2049c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 20501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 20515f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 20529c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 20531397663af9dbcc24dbf0e11de43931b3dc08fdbbTed Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp).getAsLocSymbol() == Sym) { 2054c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2055c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2056c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2058c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2059c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2060c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2061c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 2062ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class FindUniqueBinding : 2063c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public StoreManager::BindingsHandler { 2064c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym; 2065c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* Binding; 2066c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool First; 20671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2068c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 2069c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek FindUniqueBinding(SymbolRef sym) : Sym(sym), Binding(0), First(true) {} 20701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2071c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool HandleBinding(StoreManager& SMgr, Store store, const MemRegion* R, 2072c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SVal val) { 20731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SymbolRef SymV = val.getAsSymbol(); 2075c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!SymV || SymV != Sym) 2076c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return true; 20771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2078c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (Binding) { 2079c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek First = false; 2080c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 2081c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2082c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2083c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Binding = R; 20841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return true; 2086c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2088c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek operator bool() { return First && Binding; } 2089c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* getRegion() { return Binding; } 20901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 2091c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 20929e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek 2093c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 209418c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2095c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 20961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2097c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Find both first node that referred to the tracked symbol and the 2098c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // memory location that value was store to. 20999c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 21001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 21011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2102c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 210318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *St = N->getState(); 2104c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefBindings B = St->get<RefBindings>(); 21051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2106c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!B.lookup(Sym)) 2107940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 21081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2109c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek FindUniqueBinding FB(Sym); 21101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 21111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 21121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2113c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Last = N; 21141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 21151ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 21161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2117c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 21186b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 21196b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2120c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 212123f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 212223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 212323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 21248966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2125c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 21268966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek BRC.addNotableSymbol(Sym); 212723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2128c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2129fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2130c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 213123f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 213223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 213323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 21341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21358966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2136c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 21378966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek BRC.addNotableSymbol(Sym); 21381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2139c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2140c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2141c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 21429c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2143c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 21441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2145c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2146f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 21471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21484fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 21491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2150c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2151c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2152c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 21539c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 21544fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 21551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2156c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2157c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 21581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2159f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 21601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2161f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2162f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2163f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2164f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2165f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2166f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 21671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2168c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 2169c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const RefVal* RV = EndN->getState()->get<RefBindings>(Sym); 21701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2171c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2172c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 21735b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2174c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2175d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2176d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2177d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek os << " is returned from a method whose name ('" 2178d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << MD->getSelector().getAsString() 2179d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 21805b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose " This violates the naming convention rules" 2181f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " given in the Memory Management Guide for Cocoa"; 2182d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2183d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2184d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2185d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek os << " is return from a function whose name ('" 2186d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << FD->getNameAsString() 2187d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 21885b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose " convention rules given the Memory Management Guide for Core" 2189f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " Foundation"; 2190d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2191c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2192e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 21939c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2194e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 219582f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 219682f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 219782f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 219882f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2199e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2200c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2201abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2202f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 22031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2204c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2205c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2206cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 22072058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 22082058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 22092058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 22102058956954802229bf98604e8063fa57677abff4Jordy Rose ExprEngine &Eng) 22112058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 22121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2213fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2214c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2215c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2216c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2217c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2218c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2219c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2220c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 22219c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 22221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2223590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks const SourceManager& SMgr = Eng.getContext().getSourceManager(); 2224590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2225c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 2226edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks GetAllocationSite(Eng.getStateManager(), getErrorNode(), sym); 22271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2228c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2229c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 2230590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks const Stmt *AllocStmt = cast<PostStmt>(P).getStmt(); 2231590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2232590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2233c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2234c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2235c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2236590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks unsigned AllocLine = SMgr.getExpansionLineNumber(AllocStmt->getLocStart()); 2237dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 22382058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2239dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2240dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "of an object allocated on line " << AllocLine; 22411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2242c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2243c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2244c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " and stored into '" << AllocBinding->getString() << '\''; 2245dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 22462058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2247c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2248c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2249c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2250c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2251c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2252c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2253d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2254910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 22559c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 225638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 22579c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 225838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::EndPath, 22596704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2260f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 2261294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostStmt<CallExpr>, 2262537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose check::PostStmt<CXXConstructExpr>, 2263294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostObjCMessage, 2264f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 22656704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 226676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 226776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 2268d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose mutable llvm::OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 2269d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose mutable llvm::OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 2270d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose mutable llvm::OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 2271db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose mutable llvm::OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 2272db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose mutable llvm::OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 227338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 227438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 227538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 227638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 227738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 227838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2279b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose mutable llvm::OwningPtr<RetainSummaryManager> Summaries; 2280b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose mutable llvm::OwningPtr<RetainSummaryManager> SummariesGC; 2281b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 2282e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose mutable ARCounts::Factory ARCountFactory; 2283e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 22849c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 22859c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 22869c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 22872f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2288910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 228938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2290910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 229138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 229238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 229338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 22949c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 22959c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 22969c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 22979c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 22989c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 22999c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 23009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 23019c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 23029c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 23039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 23049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 23051ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23061ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 23071ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 23081ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 23091ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 23101ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23119c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 23129c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 23139c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 23149c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 23151ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23169c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 23179c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 23189c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 23199c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23209c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 23219c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 23229c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 23239c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 23249c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 23259c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 23269c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23279c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 23281ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 23291ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 233017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 233117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 233217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2333db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2334db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunctionGC.reset(new LeakWithinFunction("Leak of object when " 2335db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "using garbage " 2336db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "collection")); 233717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2338db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2339db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2340e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2341db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunction.reset(new LeakWithinFunction("Leak of object when " 2342db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "not using garbage " 2343db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "collection (GC) in " 2344db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "dual GC/non-GC " 2345db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "code")); 2346db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2347db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunction.reset(new LeakWithinFunction("Leak")); 2348db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2349db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 235017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunction.get(); 2351db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2352db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2353db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 235417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakAtReturnBug(const LangOptions &LOpts, bool GCEnabled) const { 235517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2356db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturnGC) 2357db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturnGC.reset(new LeakAtReturn("Leak of returned object when " 2358db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "using garbage collection")); 235917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2360db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2361db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2362e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2363db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturn.reset(new LeakAtReturn("Leak of returned object when " 2364db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "not using garbage collection " 2365db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "(GC) in dual GC/non-GC code")); 2366db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2367db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturn.reset(new LeakAtReturn("Leak of returned object")); 2368db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2369db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 237017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturn.get(); 2371db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2372db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2373db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 237417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(ASTContext &Ctx, 237517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 237617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // FIXME: We don't support ARC being turned on and off during one analysis. 237717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // (nor, for that matter, do we support changing ASTContexts) 237817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool ARCEnabled = (bool)Ctx.getLangOptions().ObjCAutoRefCount; 237917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 238017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!SummariesGC) 2381b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose SummariesGC.reset(new RetainSummaryManager(Ctx, true, ARCEnabled)); 238217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 238317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(SummariesGC->isARCEnabled() == ARCEnabled); 2384b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *SummariesGC; 2385b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } else { 238617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!Summaries) 2387b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose Summaries.reset(new RetainSummaryManager(Ctx, false, ARCEnabled)); 238817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 238917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(Summaries->isARCEnabled() == ARCEnabled); 2390b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *Summaries; 2391b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2392b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2393b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 239417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(CheckerContext &C) const { 239517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return getSummaryManager(C.getASTContext(), C.isObjCGCEnabled()); 239617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 239717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2398dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose void printState(raw_ostream &Out, const ProgramState *State, 2399dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const char *NL, const char *Sep) const; 2400dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 2401ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkBind(SVal loc, SVal val, CheckerContext &C) const; 2402ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const; 2403ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const CastExpr *CE, CheckerContext &C) const; 2404f85e193739c953358c865005855253af4f68a497John McCall 2405294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostStmt(const CallExpr *CE, CheckerContext &C) const; 2406537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose void checkPostStmt(const CXXConstructExpr *CE, CheckerContext &C) const; 2407294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostObjCMessage(const ObjCMessage &Msg, CheckerContext &C) const; 2408294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkSummary(const RetainSummary &Summ, const CallOrObjCMessage &Call, 2409e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2410294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 241176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 241276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 2413ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose const ProgramState *evalAssume(const ProgramState *state, SVal Cond, 2414ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 24156704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2416537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const ProgramState * 2417537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose checkRegionChanges(const ProgramState *state, 2418537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 2419537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 2420537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> Regions) const; 2421ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 2422ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool wantsRegionChangeUpdate(const ProgramState *state) const { 24232f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2424ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2425294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2426f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2427f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2428f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 2429f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose SymbolRef Sym, const ProgramState *state) const; 2430f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 243138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 243238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkEndPath(EndOfFunctionNodeBuilder &Builder, ExprEngine &Eng) const; 243338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2434e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose const ProgramState *updateSymbol(const ProgramState *state, SymbolRef sym, 243517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 243617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CheckerContext &C) const; 2437e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2438294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void processNonLeakError(const ProgramState *St, SourceRange ErrorRange, 2439294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2440294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 2441294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 244238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 244338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 244438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramState *handleSymbolDeath(const ProgramState *state, 244538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef sid, RefVal V, 244638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const; 244738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 24488d22863184419faa2348bd5148c663197bc4bb00Jordy Rose std::pair<ExplodedNode *, const ProgramState *> 24498d22863184419faa2348bd5148c663197bc4bb00Jordy Rose handleAutoreleaseCounts(const ProgramState *state, 24508d22863184419faa2348bd5148c663197bc4bb00Jordy Rose GenericNodeBuilderRefCount Bd, ExplodedNode *Pred, 24518d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ExprEngine &Eng, SymbolRef Sym, RefVal V) const; 24528d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 245338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *processLeaks(const ProgramState *state, 245438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 245538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount &Builder, 245638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExprEngine &Eng, 245738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2458d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2459d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2460d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 24616704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 24626704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 24636704429557544a890cf6c0859b13b1dc63572f70Jordy Rose const ProgramState *state; 24646704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 24656704429557544a890cf6c0859b13b1dc63572f70Jordy Rose StopTrackingCallback(const ProgramState *st) : state(st) {} 24666704429557544a890cf6c0859b13b1dc63572f70Jordy Rose const ProgramState *getState() const { return state; } 24676704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 24686704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 24696704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 24706704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 24716704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 24726704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 24736704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 24746704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2475910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2476910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2477910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 24786704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2479910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2480910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2481dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2482910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2483dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2484469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 248538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2486dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 248718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *state = C.getState(); 248838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 24891397663af9dbcc24dbf0e11de43931b3dc08fdbbTed Kremenek cast<BlockDataRegion>(state->getSVal(BE).getAsRegion()); 2490dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 249138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 249238cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2493dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 249438cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 249538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2496dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 249767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 249867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 249967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 25005f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 250167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const LocationContext *LC = C.getPredecessor()->getLocationContext(); 2502c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2503dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 250467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 250567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion *VR = *I; 250667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 250767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 250867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 250967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 251067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2511dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 251267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 251367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 251467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 251538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek C.addTransition(state); 251638cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 251738cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2518910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2519910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2520f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2521f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2522f85e193739c953358c865005855253af4f68a497John McCall return; 2523f85e193739c953358c865005855253af4f68a497John McCall 252471c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2525f85e193739c953358c865005855253af4f68a497John McCall 2526f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2527f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2528f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2529f85e193739c953358c865005855253af4f68a497John McCall return; 2530f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2531f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2532f85e193739c953358c865005855253af4f68a497John McCall break; 2533f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2534f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2535f85e193739c953358c865005855253af4f68a497John McCall break; 2536f85e193739c953358c865005855253af4f68a497John McCall } 2537f85e193739c953358c865005855253af4f68a497John McCall 253818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *state = C.getState(); 2539f85e193739c953358c865005855253af4f68a497John McCall SymbolRef Sym = state->getSVal(CE).getAsLocSymbol(); 2540f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2541f85e193739c953358c865005855253af4f68a497John McCall return; 2542f85e193739c953358c865005855253af4f68a497John McCall const RefVal* T = state->get<RefBindings>(Sym); 2543f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2544f85e193739c953358c865005855253af4f68a497John McCall return; 2545f85e193739c953358c865005855253af4f68a497John McCall 2546f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 254717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2548f85e193739c953358c865005855253af4f68a497John McCall 2549f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2550e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2551e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2552f85e193739c953358c865005855253af4f68a497John McCall return; 2553f85e193739c953358c865005855253af4f68a497John McCall } 2554f85e193739c953358c865005855253af4f68a497John McCall 2555f85e193739c953358c865005855253af4f68a497John McCall C.generateNode(state); 2556f85e193739c953358c865005855253af4f68a497John McCall} 2557f85e193739c953358c865005855253af4f68a497John McCall 2558910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CallExpr *CE, 2559910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2560294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Get the callee. 2561294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const ProgramState *state = C.getState(); 2562294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Callee = CE->getCallee(); 2563294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SVal L = state->getSVal(Callee); 2564294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 256517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2566294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetainSummary *Summ = 0; 2567294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2568294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Better support for blocks. For now we stop tracking anything 2569294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // that is passed to blocks. 2570294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Need to handle variables that are "captured" by the block. 2571294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (dyn_cast_or_null<BlockDataRegion>(L.getAsRegion())) { 2572294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getPersistentStopSummary(); 2573294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const FunctionDecl *FD = L.getAsFunctionDecl()) { 2574294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getSummary(FD); 2575294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const CXXMemberCallExpr *me = dyn_cast<CXXMemberCallExpr>(CE)) { 2576294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const CXXMethodDecl *MD = me->getMethodDecl()) 2577294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getSummary(MD); 2578294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2579294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2580294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // If we didn't get a summary, this function doesn't affect retain counts. 2581294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 2582294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2583294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2584e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose checkSummary(*Summ, CallOrObjCMessage(CE, state), C); 2585294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2586294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2587910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CXXConstructExpr *CE, 2588910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2589537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const CXXConstructorDecl *Ctor = CE->getConstructor(); 2590537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Ctor) 2591537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2592537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 259317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2594537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose RetainSummary *Summ = Summaries.getSummary(Ctor); 2595537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 2596537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose // If we didn't get a summary, this constructor doesn't affect retain counts. 2597537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Summ) 2598537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2599537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 2600537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const ProgramState *state = C.getState(); 2601e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose checkSummary(*Summ, CallOrObjCMessage(CE, state), C); 2602537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose} 2603537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 2604910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostObjCMessage(const ObjCMessage &Msg, 2605910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2606294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const ProgramState *state = C.getState(); 2607294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *Pred = C.getPredecessor(); 2608294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 260917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2610b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 2611294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetainSummary *Summ; 2612294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Msg.isInstanceMessage()) { 2613294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const LocationContext *LC = Pred->getLocationContext(); 2614294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getInstanceMethodSummary(Msg, state, LC); 2615294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 2616294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getClassMethodSummary(Msg); 2617294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2618294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2619294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // If we didn't get a summary, this message doesn't affect retain counts. 2620294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 2621294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2622294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2623e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose checkSummary(*Summ, CallOrObjCMessage(Msg, state), C); 2624294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2625294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2626910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2627910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2628910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// While the the return type can be queried directly from RetEx, when 2629910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2630910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2631910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2632910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2633910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2634910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2635910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2636910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2637910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2638910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2639910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2640910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2641910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2642910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2643910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2644910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2645910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2646910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2647910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2648910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2649910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2650910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2651910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2652910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2653910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2654910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 2655910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const CallOrObjCMessage &CallOrMsg, 2656910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2657294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const ProgramState *state = C.getState(); 2658294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2659294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2660294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2661294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2662294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2663294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2664294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2665537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2666294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2667294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 2668294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RefBindings::data_type *T = state->get<RefBindings>(Sym)) { 266917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2670294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2671294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2672294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2673294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2674294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2675294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2676294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2677294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2678294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2679294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2680294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 2681e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (!hasErr && CallOrMsg.isObjCMessage()) { 2682e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose const LocationContext *LC = C.getPredecessor()->getLocationContext(); 2683e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose SVal Receiver = CallOrMsg.getInstanceMessageReceiver(LC); 2684e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (SymbolRef Sym = Receiver.getAsLocSymbol()) { 2685294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const RefVal *T = state->get<RefBindings>(Sym)) { 2686294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ReceiverIsTracked = true; 268717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 268817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose hasErr, C); 2689294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2690e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose ErrorRange = CallOrMsg.getReceiverSourceRange(); 2691294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2692294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2693294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2694294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2695294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2696294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2697294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2698294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2699294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2700294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2701294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2702294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2703294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2704294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2705294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2706294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2707b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 270817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2709b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2710294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2711294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2712294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2713294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2714294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 2715294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled RetEffect."); break; 2716294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2717294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2718294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2719294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2720294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2721294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2722294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 2723294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr()).getAsSymbol(); 2724294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2725294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2726294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2727294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use the result type from callOrMsg as it automatically adjusts 2728294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 2729294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = CallOrMsg.getResultType(C.getASTContext()); 2730294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeOwned(RE.getObjKind(), 2731294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2732294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2733294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2734294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // *not* fail. (The code below is out-of-date, though.) 2735294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#if 0 2736294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedAllocatedSymbol) { 2737294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool isFeasible; 2738294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state.assume(loc::SymbolVal(Sym), true, isFeasible); 2739294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose assert(isFeasible && "Cannot assume fresh symbol is non-null."); 2740294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2741294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#endif 2742294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2743294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2744294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2745294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2746294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2747294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2748294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2749294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 2750294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = state->getSVal(Ex).getAsSymbol(); 2751294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2752294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2753294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2754294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2755294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 2756294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeNotOwned(RE.getObjKind(), 2757294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2758294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2759294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2760294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2761294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2762294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2763294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2764294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2765294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2766294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2767294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2768294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 2769294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.generateNode(state); 2770294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2771294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 27729c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 27739c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 27749c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 27759c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 27769c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 27779c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 27789c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2779ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 27809c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2781294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2782294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2783e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2784e0a5d326137c13946603c739babc722fd1e9a94fJordy Roseconst ProgramState * 2785910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::updateSymbol(const ProgramState *state, SymbolRef sym, 2786910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2787910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2788e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2789910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 279017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 279117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 279217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose IgnoreRetainMsg = (bool)C.getASTContext().getLangOptions().ObjCAutoRefCount; 279317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2794e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2795e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: break; 279617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case IncRefMsg: E = IgnoreRetainMsg ? DoNothing : IncRef; break; 279717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case DecRefMsg: E = IgnoreRetainMsg ? DoNothing : DecRef; break; 279817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case MakeCollectable: E = C.isObjCGCEnabled() ? DecRef : DoNothing; break; 279917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case NewAutoreleasePool: E = C.isObjCGCEnabled() ? DoNothing : 280017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose NewAutoreleasePool; break; 2801e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2802e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2803e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 280417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2805e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2806e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2807e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2808e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2809e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2810e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2811e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2812e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2813e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 2814e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2815e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2816e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2817e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2818e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 281917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2820e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2821e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2822e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2823e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2824e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2825e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2826e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2827e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2828e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2829e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2830e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2831e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2832e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 2833e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2834e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2835e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2836e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2837e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2838e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2839e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2840e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2841e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case NewAutoreleasePool: 284217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!C.isObjCGCEnabled()); 2843e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->add<AutoreleaseStack>(sym); 2844e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2845e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 2846e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 2847e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2848e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2849e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2850e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2851e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2852e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2853e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 2854e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2855e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2856e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 285717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 2858e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2859e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2860e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 2861e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose state = SendAutorelease(state, ARCountFactory, sym); 2862e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 2863e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2864e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2865e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 2866e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->remove<RefBindings>(sym); 2867e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2868e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 2869e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2870e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2871e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 2872e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2873e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2874e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2875e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 2876e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2877e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 2878e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 287917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 2880e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 2881e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2882e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2883e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2884e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2885e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case SelfOwn: 2886e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2887e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2888e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 2889e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 2890e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2891e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2892e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 2893e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 2894e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2895e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2896e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2897e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 2898e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 2899e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 2900e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 2901e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 2902e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2903e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2904e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2905e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() > 0) 2906e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 2907e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose else { 2908e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 2909e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2910e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2911e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2912e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2913e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 2914e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 291517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 2916e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2917e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2918e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2919e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2920e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2921e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2922e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2923e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 2924e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2925910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::processNonLeakError(const ProgramState *St, 2926910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 2927910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 2928910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 2929910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2930294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 2931294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 2932294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2933294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2934294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 2935294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 2936294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 2937294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 2938294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2939294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 2940d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 2941d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 2942d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 2943294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2944294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 2945d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 2946d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 2947d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 2948294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2949294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 2950d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 2951d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 2952d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 2953294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2954294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 2955d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 2956d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 2957d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 2958294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2959294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2960294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2961d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 29622058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOptions(), 296317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 296417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 2965294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 2966294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.EmitReport(report); 2967294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2968294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2969910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2970910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 2971910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2972910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2973910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 297476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 297576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose const ProgramState *state = C.getState(); 297676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose const Expr *Callee = CE->getCallee(); 297776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SVal L = state->getSVal(Callee); 297876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 297976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose const FunctionDecl *FD = L.getAsFunctionDecl(); 298076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 298176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 298276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 298376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 298476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 298576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 298676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 298776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 298876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 298976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 299076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 299176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 299276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 299376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 299476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 299576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 299676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 299776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 299876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 299976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 300076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 300176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose QualType ResultTy = FD->getResultType(); 300276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 300376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 300476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 300576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 300676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 300776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 300876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 300976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 301076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 301176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 301276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 301376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 301476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 301576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 301676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 301776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 301876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 301976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SVal RetVal = state->getSVal(CE->getArg(0)); 302076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 302176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 302276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 302376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose unsigned Count = C.getNodeBuilder().getCurrentBlockCount(); 302476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SVal RetVal = SVB.getConjuredSymbolVal(0, CE, ResultTy, Count); 302576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 302676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose state = state->BindExpr(CE, RetVal, false); 302776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3028294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3029294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3030294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3031294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3032294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 3033294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefBindings::data_type *Binding = 0; 3034294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 3035294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Binding = state->get<RefBindings>(Sym); 303676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3037294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 3038294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose unsigned Count = C.getNodeBuilder().getCurrentBlockCount(); 3039537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose state = state->invalidateRegions(ArgRegion, CE, Count); 304076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3041294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3042294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 3043294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, *Binding); 3044294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3045294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3046294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.addTransition(state); 304776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 304876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 304976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3050910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3051910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3052910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3053f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3054910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3055910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3056f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3057f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3058f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3059f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3060f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const ProgramState *state = C.getState(); 3061f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose SymbolRef Sym = state->getSValAsScalarOrLoc(RetE).getAsLocSymbol(); 3062f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3063f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3064f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3065f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 3066f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const RefVal *T = state->get<RefBindings>(Sym); 3067f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3068f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3069f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3070f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3071f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3072f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3073f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3074f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3075f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3076f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3077f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3078f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3079f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3080f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3081f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3082f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3083f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3084f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3085f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3086f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3087f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3088f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3089f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3090f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3091f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3092f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3093f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3094f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3095f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3096f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3097f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3098f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 3099f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 3100f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred = C.generateNode(state); 3101f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3102f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3103f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3104f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3105f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3106f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3107f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3108f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3109f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3110f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3111f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3112910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 3113f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose GenericNodeBuilderRefCount Bd(C.getNodeBuilder(), S, &AutoreleaseTag); 311435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, 311535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose C.getEngine(), Sym, X); 3116f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3117f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 31188d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!Pred) 3119f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3120f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3121f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 3122f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose T = state->get<RefBindings>(Sym); 3123f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3124f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3125f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3126f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 312717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3128f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 3129f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3130f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3131f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Unlike regular functions, /all/ ObjC methods are assumed to always 3132f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // follow Cocoa retain-count conventions, not just those with special 3133f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // names or attributes. 3134b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 3135f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RetEffect RE = Summ ? Summ->getRetEffect() : RetEffect::MakeNoRet(); 3136f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3137f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3138f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3139f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 3140f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<CXXMethodDecl>(FD)) 3141b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (const RetainSummary *Summ = Summaries.getSummary(FD)) 3142f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, Summ->getRetEffect(), X, 3143f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose Sym, state); 3144f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3145f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3146f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3147910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3148910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3149910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3150910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3151910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 3152f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const ProgramState *state) const { 3153f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3154f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3155f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3156f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 315717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3158f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3159f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3160f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3161f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3162f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3163f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3164f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3165f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3166f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3167f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3168f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3169f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3170f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3171f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3172f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3173f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3174f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 3175f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 3176f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose StmtNodeBuilder &Builder = C.getNodeBuilder(); 3177f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3178f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3179910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 3180f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *N = Builder.generateNode(S, state, Pred, 3181f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose &ReturnOwnLeakTag); 3182f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 318317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose const LangOptions &LOpts = C.getASTContext().getLangOptions(); 318417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3185f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 318617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 318717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 318817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym, C.getEngine()); 3189f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3190f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3191f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3192f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3193f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3194f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3195f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3196f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 3197f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X ^ RefVal::ErrorReturnedNotOwned); 3198f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose StmtNodeBuilder &Builder = C.getNodeBuilder(); 3199f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3200f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3201910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 3202f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *N = Builder.generateNode(S, state, Pred, 3203f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose &ReturnNotOwnedTag); 3204f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3205d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3206d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3207d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3208f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3209d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 321017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.getASTContext().getLangOptions(), 321117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3212f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3213f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3214f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3215f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3216f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3217f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32188d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3219910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3220910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3221910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3222910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkBind(SVal loc, SVal val, 3223910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3224910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3225910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3226910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3227910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3228910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3229910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3230910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3231910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3232910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 3233910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ProgramState *state = C.getState(); 3234910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3235910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (loc::MemRegionVal *regionLoc = dyn_cast<loc::MemRegionVal>(&loc)) { 3236910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3237910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3238910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3239910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3240910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3241910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3242910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = (state == (state->bindLoc(*regionLoc, val))); 3243910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3244910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3245910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3246910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3247910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3248910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3249910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3250910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3251910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3252910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3253910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3254910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 3255910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose C.addTransition(state); 3256910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3257910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3258910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseconst ProgramState *RetainCountChecker::evalAssume(const ProgramState *state, 3259910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3260910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3261910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3262910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3263910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3264910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3265910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3266910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3267910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3268910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings B = state->get<RefBindings>(); 3269910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3270910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3271910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3272910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3273910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3274910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings::Factory &RefBFactory = state->get_context<RefBindings>(); 3275910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3276910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3277910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Check if the symbol is null (or equal to any constant). 3278910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If this is the case, stop tracking the symbol. 3279910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (state->getSymVal(I.getKey())) { 3280910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3281910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3282910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3283910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3284910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3285910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3286910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3287910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3288910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3289910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3290910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3291910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseconst ProgramState * 3292910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::checkRegionChanges(const ProgramState *state, 3293910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 3294910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 3295910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> Regions) const { 3296910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3297910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3298910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3299910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3300910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3301910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3302910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3303910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3304910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3305910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3306910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (StoreManager::InvalidatedSymbols::const_iterator I=invalidated->begin(), 3307910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3308910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3309910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3310910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3311910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 3312910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->remove<RefBindings>(sym); 3313910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3314910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3315910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3316910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3317910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 33188d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 33198d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 33208d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33218d22863184419faa2348bd5148c663197bc4bb00Jordy Rosestd::pair<ExplodedNode *, const ProgramState *> 3322910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::handleAutoreleaseCounts(const ProgramState *state, 3323910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount Bd, 3324910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, ExprEngine &Eng, 3325910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 33268d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 33278d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33288d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 33298d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 33308d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(Pred, state); 33318d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 333217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!Eng.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 33338d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 33348d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33358d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 33368d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33378d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 33388d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 33398d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33408d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 33418d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 33428d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 33438d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 33448d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 33458d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 33468d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 33478d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 33488d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setCount(Cnt - ACnt); 33498d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 33508d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 33518d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 33528d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ExplodedNode *N = Bd.MakeNode(state, Pred); 33538d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (N == 0) 33548d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = 0; 33558d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(N, state); 33568d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 33578d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33588d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 33598d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 33608d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 33618d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 33628d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33638d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ExplodedNode *N = Bd.MakeNode(state, Pred)) { 33648d22863184419faa2348bd5148c663197bc4bb00Jordy Rose N->markAsSink(); 33658d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33668d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::SmallString<128> sbuf; 33678d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 33688d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 33698d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 33708d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 33718d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 33728d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3373d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3374d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3375d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 33762058956954802229bf98604e8063fa57677abff4Jordy Rose const LangOptions &LOpts = Eng.getContext().getLangOptions(); 33778d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3378d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3379d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 33808d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Eng.getBugReporter().EmitReport(report); 33818d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 33828d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair((ExplodedNode *)0, (const ProgramState *)0); 33848d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 338538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 338638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramState * 3387910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::handleSymbolDeath(const ProgramState *state, 3388910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 338938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 33905337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 339138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 339238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 339338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 339438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 339538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 339638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 339738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->remove<RefBindings>(sid); 339838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 339938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 340038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->set<RefBindings>(sid, V ^ RefVal::ErrorLeak); 340138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 340238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 340338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 3404910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::processLeaks(const ProgramState *state, 3405910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 3406910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount &Builder, 3407910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExprEngine &Eng, ExplodedNode *Pred) const { 340838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (Leaked.empty()) 340938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return Pred; 341038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 341138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 341238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *N = Builder.MakeNode(state, Pred); 341338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 341438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 341538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 341638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 341738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 341817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose const LangOptions &LOpts = Eng.getContext().getLangOptions(); 341917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = Eng.isObjCGCEnabled(); 342017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 342117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 342238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 34232058956954802229bf98604e8063fa57677abff4Jordy Rose 342417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 34252058956954802229bf98604e8063fa57677abff4Jordy Rose SummaryLog, N, *I, Eng); 342638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Eng.getBugReporter().EmitReport(report); 342738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 342838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 342938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 343038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 343138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 343238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3433910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkEndPath(EndOfFunctionNodeBuilder &Builder, 3434910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExprEngine &Eng) const { 343538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramState *state = Builder.getState(); 343638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount Bd(Builder); 343738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 34380658879cc98e8cb918e2f349a59c901f74f0de11Anna Zaks ExplodedNode *Pred = Builder.getPredecessor(); 343938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 344038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 34418d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, Eng, 34428d22863184419faa2348bd5148c663197bc4bb00Jordy Rose I->first, I->second); 34438d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 344438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 344538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 344638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 344738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 344838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 344938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 345038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) 34518d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 345238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 345338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose processLeaks(state, Leaked, Bd, Eng, Pred); 345438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 345538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 345638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3457910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 345838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 345938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 346038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::SmallString<64> buf; 346138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3462910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose out << "RetainCountChecker : Dead Symbol : " << sym->getSymbolID(); 346338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 346438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 346538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 346638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 346738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3468910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3469910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 347038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose StmtNodeBuilder &Builder = C.getNodeBuilder(); 347138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExprEngine &Eng = C.getEngine(); 347238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const Stmt *S = C.getStmt(); 347338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 347438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 347538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramState *state = C.getState(); 347638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 347738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 347838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 347938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 348038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 348138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 348238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 348338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 348438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 348538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount Bd(Builder, S, getDeadSymbolTag(Sym)); 34868d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, Eng, 34878d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Sym, *T); 34888d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 348938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 349038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 349138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 349238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 349338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 349438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 349538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 349638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 349738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 349838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(*I)) 349938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = handleSymbolDeath(state, *I, *T, Leaked); 350038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 350138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 350238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose { 350338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount Bd(Builder, S, this); 350438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Pred = processLeaks(state, Leaked, Bd, Eng, Pred); 350538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 350638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 350738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 350838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 350938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 351038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 351138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 351238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings::Factory &F = state->get_context<RefBindings>(); 351338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 351438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 351538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) 351638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 351738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 351838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 351938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose C.generateNode(state, Pred); 352038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 352138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3522d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek//===----------------------------------------------------------------------===// 3523dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose// Debug printing of refcount bindings and autorelease pools. 3524dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3525dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3526dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rosestatic void PrintPool(raw_ostream &Out, SymbolRef Sym, 3527dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const ProgramState *State) { 3528dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ' '; 3529dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (Sym) 3530dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sym->getSymbolID(); 3531dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose else 3532dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "<pool>"; 3533dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ":{"; 3534dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3535dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Get the contents of the pool. 3536dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (const ARCounts *Cnts = State->get<AutoreleasePoolContents>(Sym)) 3537dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARCounts::iterator I = Cnts->begin(), E = Cnts->end(); I != E; ++I) 3538dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '(' << I.getKey() << ',' << I.getData() << ')'; 3539dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3540dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '}'; 3541dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3542dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3543d77ba899b3ed39aa4bdba22aabc4bcd5ca6effdfBenjamin Kramerstatic bool UsesAutorelease(const ProgramState *state) { 3544dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // A state uses autorelease if it allocated an autorelease pool or if it has 3545dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // objects in the caller's autorelease pool. 3546dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose return !state->get<AutoreleaseStack>().isEmpty() || 3547dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose state->get<AutoreleasePoolContents>(SymbolRef()); 3548dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3549dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3550910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::printState(raw_ostream &Out, const ProgramState *State, 3551910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3552dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3553dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose RefBindings B = State->get<RefBindings>(); 3554dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3555dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3556dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3557dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3558dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3559dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3560dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3561dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3562dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3563dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3564dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Print the autorelease stack. 3565dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (UsesAutorelease(State)) { 3566dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL << "AR pool stack:"; 3567dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose ARStack Stack = State->get<AutoreleaseStack>(); 3568dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3569dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, SymbolRef(), State); // Print the caller's pool. 3570dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARStack::iterator I = Stack.begin(), E = Stack.end(); I != E; ++I) 3571dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, *I, State); 3572dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3573dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3574dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3575dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3576dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3577dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3578910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 35796b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 35806b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 358117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3582910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 358317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 358417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3585