RetainCountChecker.cpp revision ef94588752babc1b7c46b955e57945fc4c183db2
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" 214c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek#include "clang/AST/ParentMap.h" 22910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/StaticAnalyzer/Core/Checker.h" 23910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/StaticAnalyzer/Core/CheckerManager.h" 249b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" 259b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 26910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.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" 348fe83e1df954d72c0f4ffc15d20a5222ec151c21Benjamin Kramer#include "llvm/ADT/SmallString.h" 356ed9afc804731284b9b6d275dce7053d13d0c044Ted Kremenek#include "llvm/ADT/STLExtras.h" 360b526b454814fa693bf0b2a6748db58a65b9cb7cTed Kremenek#include "llvm/ADT/StringExtras.h" 375f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner#include <cstdarg> 382fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 392fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenekusing namespace clang; 409ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremenekusing namespace ento; 41a64e89bbfa756816d1e4a48e5d6c03edf1d7f23bTed Kremenekusing llvm::StrInStrNoCase; 424c79e55951517e9b3c06d0b7ac4bd82320f43f4bTed Kremenek 43d775c66b3a1ea17e770cf8fbf4ae37c667c1e043Ted Kremeneknamespace { 44910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// Wrapper around different kinds of node builder, so that helper functions 45910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// can have a common interface. 46ea0978568c55d97aefe260348767ee40a31ca2a4Francois Pichetclass GenericNodeBuilderRefCount { 474eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks CheckerContext *C; 48ca804539d908d3a0e8c72a0df5f1f571d29490bbTed Kremenek const ProgramPointTag *tag; 499d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenekpublic: 504eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount(CheckerContext &c, 51af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks const ProgramPointTag *t = 0) 526a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks : C(&c), tag(t){} 53031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 548bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *MakeNode(ProgramStateRef state, ExplodedNode *Pred, 55f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool MarkAsSink = false) { 560bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks return C->addTransition(state, Pred, tag, MarkAsSink); 579d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek } 589d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek}; 599d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek} // end anonymous namespace 609d9d3a67bd690eb8beaa9dab4a56c89967613083Ted Kremenek 6105cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek//===----------------------------------------------------------------------===// 62553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Primitives used for constructing summaries for function/method calls. 6305cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek//===----------------------------------------------------------------------===// 6405cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek 65553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// ArgEffect is used to summarize a function/method call's effect on a 66553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// particular argument. 67bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Roseenum ArgEffect { DoNothing, Autorelease, Dealloc, DecRef, DecRefMsg, 68f85e193739c953358c865005855253af4f68a497John McCall DecRefBridgedTransfered, 69bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Rose IncRefMsg, IncRef, MakeCollectable, MayEscape, 70f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek NewAutoreleasePool, SelfOwn, StopTracking }; 71553cf18cd44769a7624fc942493f076498527529Ted Kremenek 726b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremeneknamespace llvm { 73b77449cead63264650958c92cb30609c942cc5e9Ted Kremenektemplate <> struct FoldingSetTrait<ArgEffect> { 74b77449cead63264650958c92cb30609c942cc5e9Ted Kremenekstatic inline void Profile(const ArgEffect X, FoldingSetNodeID& ID) { 75b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ID.AddInteger((unsigned) X); 76b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek} 77553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 786b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end llvm namespace 796b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 80b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek/// ArgEffects summarizes the effects of a function/method call on all of 81b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek/// its arguments. 82b77449cead63264650958c92cb30609c942cc5e9Ted Kremenektypedef llvm::ImmutableMap<unsigned,ArgEffect> ArgEffects; 83b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek 846b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremeneknamespace { 85553cf18cd44769a7624fc942493f076498527529Ted Kremenek 86553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// RetEffect is used to summarize a function/method call's behavior with 871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// respect to its return value. 88ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetEffect { 896b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 9076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose enum Kind { NoRet, OwnedSymbol, OwnedAllocatedSymbol, 91f85e193739c953358c865005855253af4f68a497John McCall NotOwnedSymbol, GCNotOwnedSymbol, ARCNotOwnedSymbol, 9278a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek OwnedWhenTrackedReceiver }; 931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum ObjKind { CF, ObjC, AnyObj }; 952d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 966b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekprivate: 972d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek Kind K; 982d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek ObjKind O; 992d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 10076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose RetEffect(Kind k, ObjKind o = AnyObj) : K(k), O(o) {} 1011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1026b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 1032d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek Kind getKind() const { return K; } 1042d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 1052d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek ObjKind getObjKind() const { return O; } 1061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek bool isOwned() const { 10878a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek return K == OwnedSymbol || K == OwnedAllocatedSymbol || 10978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek K == OwnedWhenTrackedReceiver; 110a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek } 1111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1124df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetEffect &Other) const { 1134df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return K == Other.K && O == Other.O; 1144df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 1154df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 11678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek static RetEffect MakeOwnedWhenTrackedReceiver() { 11778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek return RetEffect(OwnedWhenTrackedReceiver, ObjC); 11878a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek } 1191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1202d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek static RetEffect MakeOwned(ObjKind o, bool isAllocated = false) { 1212d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return RetEffect(isAllocated ? OwnedAllocatedSymbol : OwnedSymbol, o); 1221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1232d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek static RetEffect MakeNotOwned(ObjKind o) { 1242d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return RetEffect(NotOwnedSymbol, o); 125e798e7c5a107ff5262005431817409a855a67922Ted Kremenek } 126e798e7c5a107ff5262005431817409a855a67922Ted Kremenek static RetEffect MakeGCNotOwned() { 127e798e7c5a107ff5262005431817409a855a67922Ted Kremenek return RetEffect(GCNotOwnedSymbol, ObjC); 128e798e7c5a107ff5262005431817409a855a67922Ted Kremenek } 129f85e193739c953358c865005855253af4f68a497John McCall static RetEffect MakeARCNotOwned() { 130f85e193739c953358c865005855253af4f68a497John McCall return RetEffect(ARCNotOwnedSymbol, ObjC); 131f85e193739c953358c865005855253af4f68a497John McCall } 132553cf18cd44769a7624fc942493f076498527529Ted Kremenek static RetEffect MakeNoRet() { 133553cf18cd44769a7624fc942493f076498527529Ted Kremenek return RetEffect(NoRet); 134a73447013c919d43f40c05451f5e4b662c043d6dTed Kremenek } 135ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 136ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void Profile(llvm::FoldingSetNodeID& ID) const { 137ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.AddInteger((unsigned) K); 138ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.AddInteger((unsigned) O); 139ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 1406b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 1411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 142b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 143b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// Reference-counting logic (typestate + counts). 144b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 1451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 146ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RefVal { 147b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 148b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek enum Kind { 149b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Owned = 0, // Owning reference. 150b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek NotOwned, // Reference is not owned by still valid (not freed). 151b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Released, // Object has been released. 152b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedOwned, // Returned object passes ownership to caller. 153b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedNotOwned, // Return object does not pass ownership to caller. 154b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_START, 155b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocNotOwned, // -dealloc called on non-owned object. 156b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocGC, // Calling -dealloc with GC enabled. 157b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorUseAfterRelease, // Object used after released. 158b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReleaseNotOwned, // Release of an object that was not owned. 159b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_LEAK_START, 160b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeak, // A memory leak due to excessive reference counts. 161b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeakReturned, // A memory leak due to the returning method not having 162b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // the correct naming conventions. 163b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorGCLeakReturned, 164b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorOverAutorelease, 165b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReturnedNotOwned 166b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek }; 167dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 168b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekprivate: 169b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind kind; 170b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind okind; 171b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Cnt; 172b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned ACnt; 173b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType T; 174dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 175b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal(Kind k, RetEffect::ObjKind o, unsigned cnt, unsigned acnt, QualType t) 176b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek : kind(k), okind(o), Cnt(cnt), ACnt(acnt), T(t) {} 177dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 178b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 179b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind getKind() const { return kind; } 180dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 181b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind getObjKind() const { return okind; } 182dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 183b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCount() const { return Cnt; } 184b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getAutoreleaseCount() const { return ACnt; } 185b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCombinedCounts() const { return Cnt + ACnt; } 186b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void clearCounts() { Cnt = 0; ACnt = 0; } 187b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setCount(unsigned i) { Cnt = i; } 188b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setAutoreleaseCount(unsigned i) { ACnt = i; } 189dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 190b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType getType() const { return T; } 191dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 192b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isOwned() const { 193b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == Owned; 194b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 195dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 196b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isNotOwned() const { 197b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == NotOwned; 198b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 199dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 200b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedOwned() const { 201b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedOwned; 202b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 203dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 204b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedNotOwned() const { 205b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedNotOwned; 206b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 207dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 208b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeOwned(RetEffect::ObjKind o, QualType t, 209b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 1) { 210b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(Owned, o, Count, 0, t); 211b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 212dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 213b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeNotOwned(RetEffect::ObjKind o, QualType t, 214b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 0) { 215b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(NotOwned, o, Count, 0, t); 216b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 217dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 218b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Comparison, profiling, and pretty-printing. 219dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 220b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool operator==(const RefVal& X) const { 221b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return kind == X.kind && Cnt == X.Cnt && T == X.T && ACnt == X.ACnt; 222b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 223dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 224b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator-(size_t i) const { 225b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount() - i, 226b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getAutoreleaseCount(), getType()); 227b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 228dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 229b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator+(size_t i) const { 230b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount() + i, 231b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getAutoreleaseCount(), getType()); 232b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 233dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 234b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator^(Kind k) const { 235b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(k, getObjKind(), getCount(), getAutoreleaseCount(), 236b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 237b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 238dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 239b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal autorelease() const { 240b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount(), getAutoreleaseCount()+1, 241b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 242b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 243dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 244b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 245b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger((unsigned) kind); 246b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(Cnt); 247b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(ACnt); 248b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.Add(T); 249b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 250dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2519c378f705405d37f49795d5e915989de774fe11fTed Kremenek void print(raw_ostream &Out) const; 252b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek}; 253b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 2549c378f705405d37f49795d5e915989de774fe11fTed Kremenekvoid RefVal::print(raw_ostream &Out) const { 255b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (!T.isNull()) 256dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "Tracked " << T.getAsString() << '/'; 257dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek switch (getKind()) { 259910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose default: llvm_unreachable("Invalid RefVal kind"); 260b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Owned: { 261b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Owned"; 262b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 263b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 264b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 265b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 266dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 267b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case NotOwned: { 268b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "NotOwned"; 269b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 270b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 271b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 272b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 273dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 274b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedOwned: { 275b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedOwned"; 276b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 277b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 278b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 279b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 280dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 281b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedNotOwned: { 282b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedNotOwned"; 283b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 284b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 285b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 286b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 287dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 288b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Released: 289b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Released"; 290b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 291dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 292b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocGC: 293b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (GC)"; 294b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 295dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 296b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocNotOwned: 297b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (not-owned)"; 298b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 299dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 300b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeak: 301b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked"; 302b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 303dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 304b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeakReturned: 305b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (Bad naming)"; 306b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 307dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 308b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorGCLeakReturned: 309b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (GC-ed at return)"; 310b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 311dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 312b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorUseAfterRelease: 313b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Use-After-Release [ERROR]"; 314b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 315dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 316b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorReleaseNotOwned: 317b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Release of Not-Owned [ERROR]"; 318b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 319dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 320b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorOverAutorelease: 321b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Over autoreleased"; 322b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 323dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 324b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorReturnedNotOwned: 325b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Non-owned object returned instead of owned"; 326b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 327b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 328dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 329b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (ACnt) { 330b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << " [ARC +" << ACnt << ']'; 331b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 332b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 333b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} //end anonymous namespace 334b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 335b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 336b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// RefBindings - State used to track object reference counts. 337b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 338b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 339b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, RefVal> RefBindings; 340b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 341b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace clang { 3429ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 34318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> 34418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenekstruct ProgramStateTrait<RefBindings> 34518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<RefBindings> { 34618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static void *GDMIndex() { 34718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static int RefBIndex = 0; 34818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek return &RefBIndex; 34918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek } 35018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek}; 351b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 3525a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} 353b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 354b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 355910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Function/Method behavior summaries. 356b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 357b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 358b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace { 359ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummary { 360ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// Args - a map of (index, ArgEffect) pairs, where index 3611bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// specifies the argument (starting from 0). This can be sparsely 3621bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// populated; arguments with no entry in Args use 'DefaultArgEffect'. 363b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects Args; 3641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3651bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// DefaultArgEffect - The default ArgEffect to apply to arguments that 3661bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// do not have an entry in Args. 3670507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect DefaultArgEffect; 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 369553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Receiver - If this summary applies to an Objective-C message expression, 370553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// this is the effect applied to the state of the receiver. 3710507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect Receiver; 3721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 373553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ret - The effect on the return value. Used to indicate if the 37476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose /// function/method call returns a new tracked symbol. 3750507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek RetEffect Ret; 3761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3776b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 378b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetainSummary(ArgEffects A, RetEffect R, ArgEffect defaultEff, 379e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect ReceiverEff) 380e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose : Args(A), DefaultArgEffect(defaultEff), Receiver(ReceiverEff), Ret(R) {} 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 382553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArg - Return the argument effect on the argument specified by 383553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// idx (starting from 0). 3841ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek ArgEffect getArg(unsigned idx) const { 385b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek if (const ArgEffect *AE = Args.lookup(idx)) 386b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return *AE; 3871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3881bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek return DefaultArgEffect; 3891ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 39011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 39111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek void addArg(ArgEffects::Factory &af, unsigned idx, ArgEffect e) { 39211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek Args = af.add(Args, idx, e); 39311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 3941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 395885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setDefaultArgEffect - Set the default argument effect. 396885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setDefaultArgEffect(ArgEffect E) { 397885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek DefaultArgEffect = E; 398885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek } 3991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 400553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getRetEffect - Returns the effect on the return value of the call. 401b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetEffect getRetEffect() const { return Ret; } 4021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 403885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setRetEffect - Set the effect of the return value of the call. 404885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setRetEffect(RetEffect E) { Ret = E; } 4051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40612b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 40712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek /// Sets the effect on the receiver of the message. 40812b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek void setReceiverEffect(ArgEffect e) { Receiver = e; } 40912b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 410553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getReceiverEffect - Returns the effect on the receiver of the call. 411553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// This is only meaningful if the summary applies to an ObjCMessageExpr*. 412b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffect getReceiverEffect() const { return Receiver; } 4134df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 4144df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// Test if two retain summaries are identical. Note that merely equivalent 4154df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// summaries are not necessarily identical (for example, if an explicit 4164df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// argument effect matches the default effect). 4174df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetainSummary &Other) const { 4184df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return Args == Other.Args && DefaultArgEffect == Other.DefaultArgEffect && 4194df54feb02d72b76249e846053d5d53d820bf832Jordy Rose Receiver == Other.Receiver && Ret == Other.Ret; 4204df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 421ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 422ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// Profile this summary for inclusion in a FoldingSet. 423ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void Profile(llvm::FoldingSetNodeID& ID) const { 424ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Args); 425ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(DefaultArgEffect); 426ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Receiver); 427ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Ret); 428ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 429ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 430ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// A retain summary is simple if it has no ArgEffects other than the default. 431ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose bool isSimple() const { 432ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return Args.isEmpty(); 433ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 4346b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 4354f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} // end anonymous namespace 4366b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 437553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 438553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for constructing summaries. 439553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 440553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4414f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 442ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryKey { 443553cf18cd44769a7624fc942493f076498527529Ted Kremenek IdentifierInfo* II; 444553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector S; 4451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 446553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(IdentifierInfo* ii, Selector s) 447553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(ii), S(s) {} 448553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4499c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, Selector s) 450553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(d ? d->getIdentifier() : 0), S(s) {} 45170b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek 4529c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, IdentifierInfo *ii, Selector s) 45370b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek : II(d ? d->getIdentifier() : ii), S(s) {} 4541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 455553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(Selector s) 456553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(0), S(s) {} 4571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4580507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek IdentifierInfo *getIdentifier() const { return II; } 459553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector getSelector() const { return S; } 460553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 4614f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} 4624f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek 4634f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace llvm { 464553cf18cd44769a7624fc942493f076498527529Ted Kremenektemplate <> struct DenseMapInfo<ObjCSummaryKey> { 465553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getEmptyKey() { 466553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getEmptyKey(), 467553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::getEmptyKey()); 468553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 470553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getTombstoneKey() { 471553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getTombstoneKey(), 4721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump DenseMapInfo<Selector>::getTombstoneKey()); 473553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 475553cf18cd44769a7624fc942493f076498527529Ted Kremenek static unsigned getHashValue(const ObjCSummaryKey &V) { 476553cf18cd44769a7624fc942493f076498527529Ted Kremenek return (DenseMapInfo<IdentifierInfo*>::getHashValue(V.getIdentifier()) 4771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump & 0x88888888) 478553cf18cd44769a7624fc942493f076498527529Ted Kremenek | (DenseMapInfo<Selector>::getHashValue(V.getSelector()) 479553cf18cd44769a7624fc942493f076498527529Ted Kremenek & 0x55555555); 480553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 482553cf18cd44769a7624fc942493f076498527529Ted Kremenek static bool isEqual(const ObjCSummaryKey& LHS, const ObjCSummaryKey& RHS) { 483553cf18cd44769a7624fc942493f076498527529Ted Kremenek return DenseMapInfo<IdentifierInfo*>::isEqual(LHS.getIdentifier(), 484553cf18cd44769a7624fc942493f076498527529Ted Kremenek RHS.getIdentifier()) && 485553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::isEqual(LHS.getSelector(), 486553cf18cd44769a7624fc942493f076498527529Ted Kremenek RHS.getSelector()); 487553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 489553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 49006159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <> 49106159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<ObjCSummaryKey> { static const bool value = true; }; 492553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end llvm namespace 4931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 494553cf18cd44769a7624fc942493f076498527529Ted Kremeneknamespace { 495ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryCache { 49693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<ObjCSummaryKey, const RetainSummary *> MapTy; 497553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy M; 498553cf18cd44769a7624fc942493f076498527529Ted Kremenekpublic: 499553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryCache() {} 5001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 50193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, IdentifierInfo *ClsName, 502a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek Selector S) { 5038711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Lookup the method using the decl for the class @interface. If we 5048711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // have no decl, lookup using the class name. 5058711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek return D ? find(D, S) : find(ClsName, S); 5068711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 5071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 50893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, Selector S) { 509553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Do a lookup with the (D,S) pair. If we find a match return 510553cf18cd44769a7624fc942493f076498527529Ted Kremenek // the iterator. 511553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey K(D, S); 512553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy::iterator I = M.find(K); 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 514553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (I != M.end() || !D) 515614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I->second; 5161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 517553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Walk the super chain. If we find a hit with a parent, we'll end 518553cf18cd44769a7624fc942493f076498527529Ted Kremenek // up returning that summary. We actually allow that key (null,S), as 519553cf18cd44769a7624fc942493f076498527529Ted Kremenek // we cache summaries for the null ObjCInterfaceDecl* to allow us to 520553cf18cd44769a7624fc942493f076498527529Ted Kremenek // generate initial summaries without having to worry about NSObject 521553cf18cd44769a7624fc942493f076498527529Ted Kremenek // being declared. 522553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: We may change this at some point. 5239c378f705405d37f49795d5e915989de774fe11fTed Kremenek for (ObjCInterfaceDecl *C=D->getSuperClass() ;; C=C->getSuperClass()) { 524553cf18cd44769a7624fc942493f076498527529Ted Kremenek if ((I = M.find(ObjCSummaryKey(C, S))) != M.end()) 525553cf18cd44769a7624fc942493f076498527529Ted Kremenek break; 5261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 527553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (!C) 528614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return NULL; 5294f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek } 5301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Cache the summary with original key to make the next lookup faster 532553cf18cd44769a7624fc942493f076498527529Ted Kremenek // and return the iterator. 53393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = I->second; 534614cc540a617978814e37d75bf5066926b921a0aTed Kremenek M[K] = Summ; 535614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return Summ; 536553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5380507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *find(IdentifierInfo* II, Selector S) { 539553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: Class method lookup. Right now we dont' have a good way 540553cf18cd44769a7624fc942493f076498527529Ted Kremenek // of going between IdentifierInfo* and the class hierarchy. 541614cc540a617978814e37d75bf5066926b921a0aTed Kremenek MapTy::iterator I = M.find(ObjCSummaryKey(II, S)); 5421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 543614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (I == M.end()) 544614cc540a617978814e37d75bf5066926b921a0aTed Kremenek I = M.find(ObjCSummaryKey(S)); 5451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 546614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I == M.end() ? NULL : I->second; 547553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](ObjCSummaryKey K) { 550553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[K]; 551553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 55393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](Selector S) { 554553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[ ObjCSummaryKey(S) ]; 555553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 557553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end anonymous namespace 558553cf18cd44769a7624fc942493f076498527529Ted Kremenek 559553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 560553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for managing collections of summaries. 561553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 562553cf18cd44769a7624fc942493f076498527529Ted Kremenek 5634f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 564ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummaryManager { 565d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 566d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 567d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Typedefs. 568d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 57093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<const FunctionDecl*, const RetainSummary *> 571d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy; 5721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5734f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek typedef ObjCSummaryCache ObjCMethodSummariesTy; 5741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 575ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose typedef llvm::FoldingSetNodeWrapper<RetainSummary> CachedSummaryNode; 576ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 577d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 578d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Data. 579d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 581553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ctx - The ASTContext object for the analyzed ASTs. 5829c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &Ctx; 583179064eb831125630c296556dd6d67e67f716143Ted Kremenek 584553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// GCEnabled - Records whether or not the analyzed code runs in GC mode. 585377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek const bool GCEnabled; 5861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 587f85e193739c953358c865005855253af4f68a497John McCall /// Records whether or not the analyzed code runs in ARC mode. 588f85e193739c953358c865005855253af4f68a497John McCall const bool ARCEnabled; 589f85e193739c953358c865005855253af4f68a497John McCall 590553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// FuncSummaries - A map from FunctionDecls to summaries. 5911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump FuncSummariesTy FuncSummaries; 5921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 593553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCClassMethodSummaries - A map from selectors (for instance methods) 594553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// to summaries. 5951f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCClassMethodSummaries; 596d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 597553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCMethodSummaries - A map from selectors to summaries. 5981f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCMethodSummaries; 599d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 600553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// BPAlloc - A BumpPtrAllocator used for allocating summaries, ArgEffects, 601553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// and all other data used by the checker. 602d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek llvm::BumpPtrAllocator BPAlloc; 6031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 604b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek /// AF - A factory for ArgEffects objects. 6051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ArgEffects::Factory AF; 6061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 607553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ScratchArgs - A holding buffer for construct ArgEffects. 6080507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffects ScratchArgs; 6091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 610ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// ObjCAllocRetE - Default return effect for methods returning Objective-C 611ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// objects. 612ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek RetEffect ObjCAllocRetE; 613547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek 6141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// ObjCInitRetE - Default return effect for init methods returning 615ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek /// Objective-C objects. 616547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek RetEffect ObjCInitRetE; 6171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 618ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// SimpleSummaries - Used for uniquing summaries that don't have special 619ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// effects. 620ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSet<CachedSummaryNode> SimpleSummaries; 6211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 622d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 623d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Methods. 624d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 6251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 626553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArgEffects - Returns a persistent ArgEffects object based on the 627553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// data in ScratchArgs. 628b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects getArgEffects(); 62900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 6301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum UnaryFuncKind { cfretain, cfrelease, cfmakecollectable }; 6311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 632896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekpublic: 63378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek RetEffect getObjAllocRetEffect() const { return ObjCAllocRetE; } 63493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek 6350507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getUnarySummary(const FunctionType* FT, 63693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek UnaryFuncKind func); 6371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6380507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryCreateRule(const FunctionDecl *FD); 6390507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryGetRule(const FunctionDecl *FD); 6400507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFCreateGetRuleSummary(const FunctionDecl *FD); 6411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 642ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(const RetainSummary &OldSumm); 643706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 644ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(RetEffect RetEff, 64593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect ReceiverEff = DoNothing, 64693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect DefaultEff = MayEscape) { 647ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummary Summ(getArgEffects(), RetEff, DefaultEff, ReceiverEff); 648ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(Summ); 6499c32d08925045b32d7c39516e35d860159252e1dTed Kremenek } 6501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 651ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getDefaultSummary() { 652ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 653ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose DoNothing, MayEscape); 654ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 655706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 656ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentStopSummary() { 657ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 658ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose StopTracking, StopTracking); 6591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 660b309525445c8ec3d36e49568382029efc2740554Ted Kremenek 6611f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeClassMethodSummaries(); 6621f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeMethodSummaries(); 663896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekprivate: 66493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectClsMethSummary(Selector S, const RetainSummary *Summ) { 665553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCClassMethodSummaries[S] = Summ; 666553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 66893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectMethSummary(Selector S, const RetainSummary *Summ) { 669553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCMethodSummaries[S] = Summ; 670553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6713aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek 672a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek void addClassMethSummary(const char* Cls, const char* name, 673a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek const RetainSummary *Summ, bool isNullary = true) { 6743aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 675a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek Selector S = isNullary ? GetNullarySelector(name, Ctx) 676a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek : GetUnarySelector(name, Ctx); 6773aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6783aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek } 6791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6806c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek void addInstMethSummary(const char* Cls, const char* nullaryName, 68193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ) { 6826c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6836c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6846c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek ObjCMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6856c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek } 6861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 687de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector generateSelector(va_list argp) { 6885f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<IdentifierInfo*, 10> II; 689de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6909e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek while (const char* s = va_arg(argp, const char*)) 6919e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek II.push_back(&Ctx.Idents.get(s)); 692de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return Ctx.Selectors.getSelector(II.size(), &II[0]); 694de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 6951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 696de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addMethodSummary(IdentifierInfo *ClsII, ObjCMethodSummariesTy& Summaries, 69793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * Summ, va_list argp) { 698de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector S = generateSelector(argp); 699de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Summaries[ObjCSummaryKey(ClsII, S)] = Summ; 70070a733e64e2379a654631a14fa29e46761d5f80dTed Kremenek } 7011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addInstMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 703af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_list argp; 704af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_start(argp, Summ); 705de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls), ObjCMethodSummaries, Summ, argp); 7061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump va_end(argp); 707af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek } 7081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 710de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 711de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 712de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls),ObjCClassMethodSummaries, Summ, argp); 713de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 714de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(IdentifierInfo *II, const RetainSummary * Summ, ...) { 717de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 718de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 719de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(II, ObjCClassMethodSummaries, Summ, argp); 720de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 721de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 722de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7236b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 7241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7259c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummaryManager(ASTContext &ctx, bool gcenabled, bool usesARC) 726179064eb831125630c296556dd6d67e67f716143Ted Kremenek : Ctx(ctx), 727f85e193739c953358c865005855253af4f68a497John McCall GCEnabled(gcenabled), 728f85e193739c953358c865005855253af4f68a497John McCall ARCEnabled(usesARC), 729f85e193739c953358c865005855253af4f68a497John McCall AF(BPAlloc), ScratchArgs(AF.getEmptyMap()), 730f85e193739c953358c865005855253af4f68a497John McCall ObjCAllocRetE(gcenabled 731f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 732f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 733f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwned(RetEffect::ObjC, true))), 734f85e193739c953358c865005855253af4f68a497John McCall ObjCInitRetE(gcenabled 735f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 736f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 737ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose : RetEffect::MakeOwnedWhenTrackedReceiver())) { 738553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeClassMethodSummaries(); 739553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeMethodSummaries(); 740553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 7411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7420507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getSummary(const FunctionDecl *FD); 7431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 744f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *getMethodSummary(Selector S, IdentifierInfo *ClsName, 745f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCInterfaceDecl *ID, 746f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, 747f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose QualType RetTy, 748f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries); 749f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 75093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 7518bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state, 75293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const LocationContext *LC); 753dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 7540507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 75593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCInterfaceDecl *ID) { 756f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose return getMethodSummary(msg.getSelector(), 0, ID, msg.getMethodDecl(), 757f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose msg.getType(Ctx), ObjCMethodSummaries); 7588711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 7591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 76093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getClassMethodSummary(const ObjCMessage &msg) { 761432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const ObjCInterfaceDecl *Class = 0; 762432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis if (!msg.isInstanceMessage()) 763432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis Class = msg.getReceiverInterface(); 76404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 765f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose return getMethodSummary(msg.getSelector(), Class->getIdentifier(), 766f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Class, msg.getMethodDecl(), msg.getType(Ctx), 767f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCClassMethodSummaries); 768fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek } 769552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek 770552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// getMethodSummary - This version of getMethodSummary is used to query 771552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// the summary for the current method being analyzed. 77293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getMethodSummary(const ObjCMethodDecl *MD) { 773a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek // FIXME: Eventually this should be unneeded. 774a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID = MD->getClassInterface(); 77570a6576c9c8d21ff2361574f4937a2e73bd57779Ted Kremenek Selector S = MD->getSelector(); 776552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek IdentifierInfo *ClsName = ID->getIdentifier(); 777552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek QualType ResultTy = MD->getResultType(); 7781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 779f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy *CachedSummaries; 780552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek if (MD->isInstanceMethod()) 781f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCMethodSummaries; 782552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek else 783f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCClassMethodSummaries; 784f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 785f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose return getMethodSummary(S, ClsName, ID, MD, ResultTy, *CachedSummaries); 786552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek } 7871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 788f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *getStandardMethodSummary(const ObjCMethodDecl *MD, 78993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Selector S, QualType RetTy); 790a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek 79193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7924dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD); 7934dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 79493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7954dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD); 7964dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 797d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek bool isGCEnabled() const { return GCEnabled; } 7981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 799f85e193739c953358c865005855253af4f68a497John McCall bool isARCEnabled() const { return ARCEnabled; } 800f85e193739c953358c865005855253af4f68a497John McCall 801f85e193739c953358c865005855253af4f68a497John McCall bool isARCorGCEnabled() const { return GCEnabled || ARCEnabled; } 8026b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 8031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8040fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// Used to avoid allocating long-term (BPAlloc'd) memory for default retain 8050fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// summaries. If a function or method looks like it has a default summary, but 8060fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// it has annotations, the annotations are added to the stack-based template 8070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// and then copied into managed memory. 8080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Roseclass RetainSummaryTemplate { 8090fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &Manager; 81093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *&RealSummary; 8110fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary ScratchSummary; 8120fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose bool Accessed; 8130fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rosepublic: 814e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetainSummaryTemplate(const RetainSummary *&real, const RetainSummary &base, 815e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetainSummaryManager &mgr) 816e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose : Manager(mgr), RealSummary(real), ScratchSummary(real ? *real : base), 81793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Accessed(false) {} 8180fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8190fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose ~RetainSummaryTemplate() { 82093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek if (Accessed) 821ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RealSummary = Manager.getPersistentSummary(ScratchSummary); 8220fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8230fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8240fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary &operator*() { 8250fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 82693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return ScratchSummary; 8270fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8280fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8290fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *operator->() { 8300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 83193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return &ScratchSummary; 8320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8330fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose}; 8340fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8356b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end anonymous namespace 8366b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 8376b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8386b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek// Implementation of checker data structures. 8396b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8406b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 841b77449cead63264650958c92cb30609c942cc5e9Ted KremenekArgEffects RetainSummaryManager::getArgEffects() { 842b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects AE = ScratchArgs; 8433baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.getEmptyMap(); 844b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return AE; 84500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 84600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 84793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 848ef94588752babc1b7c46b955e57945fc4c183db2Jordy RoseRetainSummaryManager::getPersistentSummary(const RetainSummary &OldSumm) { 849ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose // Unique "simple" summaries -- those without ArgEffects. 850ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (OldSumm.isSimple()) { 851ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSetNodeID ID; 852ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose OldSumm.Profile(ID); 853ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 854ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void *Pos; 855ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose CachedSummaryNode *N = SimpleSummaries.FindNodeOrInsertPos(ID, Pos); 856ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 857ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (!N) { 858ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose N = (CachedSummaryNode *) BPAlloc.Allocate<CachedSummaryNode>(); 859ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (N) CachedSummaryNode(OldSumm); 860ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose SimpleSummaries.InsertNode(N, Pos); 861ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 862ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 863ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return &N->getValue(); 864ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 865ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 86693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 867ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (Summ) RetainSummary(OldSumm); 86800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek return Summ; 86900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 87000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 871d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 872d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for functions (largely uses of Core Foundation). 873d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 87400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 8759c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRetain(const FunctionDecl *FD, StringRef FName) { 876b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Retain"); 8771261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8781261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 8799c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRelease(const FunctionDecl *FD, StringRef FName) { 880b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Release"); 8811261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8821261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 88376c506fba2359296d1f19e64998bd11d7b864563Jordy Rosestatic bool isMakeCollectable(const FunctionDecl *FD, StringRef FName) { 88476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Remove FunctionDecl parameter. 88576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Is it really okay if MakeCollectable isn't a suffix? 88676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return FName.find("MakeCollectable") != StringRef::npos; 88776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 88876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 88993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * RetainSummaryManager::getSummary(const FunctionDecl *FD) { 890891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 891d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 892d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 893891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 894891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 895e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 89693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *S = 0; 8971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 89837d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 8991261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 9001261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 9011261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 9021261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 9031261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 9049ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // For C++ methods, generate an implicit "stop" summary as well. We 9059ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // can relax this once we have a clear policy for C++ methods and 9069ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // ownership attributes. 9079ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek if (isa<CXXMethodDecl>(FD)) { 9089ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek S = getPersistentStopSummary(); 9099ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek break; 9109ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek } 9111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 912183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 91399890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 914183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 91548c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 91648c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 91748c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 918b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 919b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 9201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 921bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 922bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 923b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 9241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9251261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 9261261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 9271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9281261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 9291261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 930008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 931e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 932b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer if (FName == "pthread_create") { 933b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of: <rdar://problem/7299394>. This will be addressed 934b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // better with IPA. 935b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 936b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 937b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 938b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 939b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 940b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 941b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 942b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 943b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 944b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 945b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 946b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 947b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 948b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 949b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 950b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 951b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 952b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 953b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 954b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 9553baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 956b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 957b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 958b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 959b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 960b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 9613baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 962b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 963b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 964b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 965b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 966b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 967b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 968b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 969b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 9703baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 971b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 972b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 973b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 974b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 975b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 976b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 9773baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 978b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 979b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 980b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 981b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 982b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 983b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 984b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 985b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 9863baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 987b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 988b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 9891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 990b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 991b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 992b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 99361991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 99461991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Enable this code once the semantics of NSDeallocateObject are resolved 99561991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // for GC. <rdar://problem/6619988> 99661991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#if 0 99761991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Handle: NSDeallocateObject(id anObject); 99861991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // This method does allow 'nil' (although we don't check it now). 9991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (strcmp(FName, "NSDeallocateObject") == 0) { 100061991903335144605031c3597a5c99e1565b0bd4Ted Kremenek return RetTy == Ctx.VoidTy 100161991903335144605031c3597a5c99e1565b0bd4Ted Kremenek ? getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, Dealloc) 100261991903335144605031c3597a5c99e1565b0bd4Ted Kremenek : getPersistentStopSummary(); 100361991903335144605031c3597a5c99e1565b0bd4Ted Kremenek } 100461991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#endif 10051261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10061261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (RetTy->isPointerType()) { 10071261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 100878acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 10091261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10101261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 101176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 10121261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 10131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 10147df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10151261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 101637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 101737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10181261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10191261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 102078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 10211261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10221261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 10231261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 10247df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10251261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 102637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 102737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10281261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10291261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 103078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 103178acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 103278acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 10337df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1034706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1035706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 10361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10371261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 103837d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10391261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10401261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 10411261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 10421261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1043e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1044b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1045e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1046bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 10471261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 10481261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1049b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 10506818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 10516818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 10526818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 10536818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 10546818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 10566818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 10571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 10586818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 10596818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10606818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1061c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1062c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1063c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1064c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1065e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1066e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1067e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1068e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1069c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 10706818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 10711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10726818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 10731261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 107464e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 107537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 107637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 10771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10784dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 10794df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(S, FD); 10801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1081d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 10821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 10832fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 10842fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 108593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 10867df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 10877df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 108886ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 10891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1090d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 109100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 109200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 109393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 10946ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 10956ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 10966ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 10971261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 10981261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 109972564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 11001261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 11011261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 11021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1103b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 110576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1106377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 110776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 110876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 110976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 1110940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 111176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 111276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 111376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 111400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 111500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 111693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11179c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1118b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11202d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 112100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 112200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 112393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11249c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 11251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 11262d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 11272d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 112800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 112900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 11306b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1131d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1132d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1133d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 11344dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 113593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 11364dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 11374dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 11384dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11394dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 1140ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummaryTemplate Template(Summ, *getDefaultSummary(), *this); 11414df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 114211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 114311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 114411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 114598b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 114611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 114711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 11484df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 11490fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 11504df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 11514df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 11520fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 115311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 115411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 115511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1156b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 11571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11584dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 115978acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 116040b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 11610fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 11624dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 116340b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 11640fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1165b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 11666041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>()) { 11670fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 11686041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11696041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11700fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 11716041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11724df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (RetTy->getAs<PointerType>()) { 117340b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 11740fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 11754dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1176d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11770fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1178d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 11794dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 11804dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 11814dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11824dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 118393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 118493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD) { 11854dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 11864dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11874dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 1188ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummaryTemplate Template(Summ, *getDefaultSummary(), *this); 11896d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 11901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 119112b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 119212b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 119311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 11940fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 119511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 119611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 119711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 119811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1199491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1200491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 120111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 120211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 120311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 120411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12050fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 120611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 120711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 12080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 120911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 121012b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 121112b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 12124dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 121378acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 121440b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 12150fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 12166d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 12174dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 12186041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>()) { 12190fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 12206041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 12216041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12236d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 12240fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 12256217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 12260fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 12271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12286041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 12296041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 12300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 12316041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 12320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 12336041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12344dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 12354dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 123693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1237f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy RoseRetainSummaryManager::getStandardMethodSummary(const ObjCMethodDecl *MD, 1238f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Selector S, QualType RetTy) { 12398ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek 1240fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek if (MD) { 1241376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Scan the method decl for 'void*' arguments. These should be treated 1242376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // as 'StopTracking' because they are often used with delegates. 1243376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Delegates are a frequent form of false positives with the retain 1244376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // count checker. 1245376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek unsigned i = 0; 1246491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator I = MD->param_begin(), 1247376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek E = MD->param_end(); I != E; ++I, ++i) 1248491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis if (const ParmVarDecl *PD = *I) { 1249376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek QualType Ty = Ctx.getCanonicalType(PD->getType()); 1250a4923eb7c4b04d360cb2747641a5e92818edf804Douglas Gregor if (Ty.getLocalUnqualifiedType() == Ctx.VoidPtrTy) 12513baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, i, StopTracking); 1252376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 1253376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 12541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1255e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Any special effects? 12568ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 1257e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetEffect ResultEff = RetEffect::MakeNoRet(); 1258e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose 1259e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Check the method family, and apply any default annotations. 1260e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (MD ? MD->getMethodFamily() : S.getMethodFamily()) { 1261e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_None: 1262e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_performSelector: 1263e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Assume all Objective-C methods follow Cocoa Memory Management rules. 1264e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // FIXME: Does the non-threaded performSelector family really belong here? 1265e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // The selector could be, say, @selector(copy). 1266e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1267e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::ObjC); 1268e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) { 1269e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // ObjCMethodDecl currently doesn't consider CF objects as valid return 1270e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // values for alloc, new, copy, or mutableCopy, so we have to 1271e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // double-check with the selector. This is ugly, but there aren't that 1272e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // many Objective-C methods that return CF objects, right? 1273e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (MD) { 1274e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (S.getMethodFamily()) { 1275e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1276e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1277e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1278e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1279e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1280e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1281e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose default: 1282e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1283e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1284e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1285e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } else { 1286e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1287e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1288e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1289e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1290e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_init: 1291e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCInitRetE; 1292e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1293e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1294e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1295e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1296e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1297e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1298e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1299e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCAllocRetE; 1300e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) 1301e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1302e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1303e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_autorelease: 1304e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Autorelease; 1305e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1306e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retain: 1307e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = IncRefMsg; 1308e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1309e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_release: 1310e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1311e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1312e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_dealloc: 1313e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Dealloc; 1314e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1315e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_self: 1316e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // -self is handled specially by the ExprEngine to propagate the receiver. 1317e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1318e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retainCount: 1319e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_finalize: 1320e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // These methods don't return objects. 1321e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1322e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 13231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13248ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 13258ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 13268ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 13278ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 13288ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 13298ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek const std::string &str = S.getAsString(); 13308ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek assert(!str.empty()); 1331e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer if (StrInStrNoCase(str, "delegate:") != StringRef::npos) 1332e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ReceiverEff = StopTracking; 13338ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 13341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1335e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing && 1336e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff.getKind() == RetEffect::NoRet) 133793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 13381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1339e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose return getPersistentSummary(ResultEff, ReceiverEff, MayEscape); 1340250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1341250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 134293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1343432424d67641d609e4990d791baa782fc161027eArgyrios KyrtzidisRetainSummaryManager::getInstanceMethodSummary(const ObjCMessage &msg, 13448bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state, 1345b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek const LocationContext *LC) { 1346b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1347b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // We need the type-information of the tracked receiver object 1348b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Retrieve it from the state. 1349432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const Expr *Receiver = msg.getInstanceReceiver(); 13509c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID = 0; 1351b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1352b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: Is this really working as expected? There are cases where 1353b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we just use the 'ID' from the message expression. 135404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor SVal receiverV; 135504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 13568f326751df18e78bdb7edf786a842def8a4f41e3Ted Kremenek if (Receiver) { 13575eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek receiverV = state->getSValAsScalarOrLoc(Receiver, LC); 1358dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 135904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Eventually replace the use of state->get<RefBindings> with 136004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // a generic API for reasoning about the Objective-C types of symbolic 136104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // objects. 136204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (SymbolRef Sym = receiverV.getAsLocSymbol()) 136304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const RefVal *T = state->get<RefBindings>(Sym)) 1364dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek if (const ObjCObjectPointerType* PT = 1365b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 136604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 1367dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 136804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: this is a hack. This may or may not be the actual method 136904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // that is called. 137004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (!ID) { 137104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const ObjCObjectPointerType *PT = 137204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Receiver->getType()->getAs<ObjCObjectPointerType>()) 137304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 137404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } 137504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } else { 137604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Hack for 'super'. 1377432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis ID = msg.getReceiverInterface(); 1378b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 137904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1380b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1381b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 13824df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return getInstanceMethodSummary(msg, ID); 1383b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1384b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 138593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1386f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy RoseRetainSummaryManager::getMethodSummary(Selector S, IdentifierInfo *ClsName, 1387f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCInterfaceDecl *ID, 1388f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, QualType RetTy, 1389f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries) { 13901bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 13918711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 1392f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *Summ = CachedSummaries.find(ID, ClsName, S); 13931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1394614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1395f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Summ = getStandardMethodSummary(MD, S, RetTy); 13964df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1397614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 13984df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 13994df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1400614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 1401f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries[ObjCSummaryKey(ID, ClsName, S)] = Summ; 1402614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 14031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1404e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1405c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1406c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 14071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1408ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 14091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 14106fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 14112d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 14121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14136d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 14143baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 14156fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 14166fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 14176fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 14181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1419de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // Create the summaries for [NSObject performSelector...]. We treat 1420de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // these as 'stop tracking' for the arguments because they are often 1421de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // used for delegates that can release the object. When we have better 1422de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // inter-procedural analysis we can potentially do something better. This 1423de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // workaround is to remove false positives. 142493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = 1425012614ecf78442368ec82ee30efb3bc047b413e6Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, StopTracking); 1426de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek IdentifierInfo *NSObjectII = &Ctx.Idents.get("NSObject"); 1427de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1428de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", NULL); 1429de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1430de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", "inModes", NULL); 1431de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1432de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1433de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1434de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1435de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1436de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1437de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1438de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1439de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorInBackground", 1440de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", NULL); 14419c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 14429c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 14431f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 14441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 14461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1447c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1448c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 144993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1450ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1451ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1452ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1453ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1454ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1455ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 14561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1457c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 145893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 145993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *CFAllocSumm = 1460a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 14611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14623c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1463500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 146493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1465553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 14661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14673c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1468500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1469553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 14701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1471299e8158d63d69830cca0187f4003cba1e66081fTed Kremenek // Create the "drain" selector. 1472500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, isGCEnabled() ? DoNothing : DecRef); 1473553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); 14741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1475f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1476500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1477f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 14783c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 14793c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1480500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1481553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 14821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1483f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek // Specially handle NSAutoreleasePool. 14846c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek addInstMethSummary("NSAutoreleasePool", "init", 1485500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose getPersistentSummary(NoRet, NewAutoreleasePool)); 14861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 148889e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 148989e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 149089e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 149189e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 14923aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 149393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 149478a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 149578a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 14961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 149799d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 149899d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 14993aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#if 0 150078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1501af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 150378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1504af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 15053aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#endif 15061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1507179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1508179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 150999d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 151099d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 151199d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 15121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 151378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#if 0 151478a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1515af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 151778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1518af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 151978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#endif 15201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1521ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // Don't track allocated autorelease pools yet, as it is okay to prematurely 1522ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1523ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1524a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek addClassMethSummary("NSAutoreleasePool", "allocWithZone", NoTrackYet, false); 1525553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1526767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1527767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1528767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1529767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1530767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1531767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1532211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1533a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1534a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1535a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1536767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1537a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 15381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1539a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1540211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1541b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1542b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1543d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 15444d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek// AutoreleaseBindings - State used to track objects in autorelease pools. 15456d34893fc886f4153f104de8880876764981cb7fTed Kremenek//===----------------------------------------------------------------------===// 15466d34893fc886f4153f104de8880876764981cb7fTed Kremenek 15474d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, unsigned> ARCounts; 15484d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, ARCounts> ARPoolContents; 15494d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableList<SymbolRef> ARStack; 1550f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek 15514d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenekstatic int AutoRCIndex = 0; 15526d34893fc886f4153f104de8880876764981cb7fTed Kremenekstatic int AutoRBIndex = 0; 15536d34893fc886f4153f104de8880876764981cb7fTed Kremenek 1554ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleasePoolContents {}; } 1555ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleaseStack {}; } 15564d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 15576d34893fc886f4153f104de8880876764981cb7fTed Kremeneknamespace clang { 15589ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 155918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleaseStack> 156018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARStack> { 15619c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRBIndex; } 15624d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15634d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 156418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleasePoolContents> 156518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARPoolContents> { 15669c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRCIndex; } 15674d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15685a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 15694d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek} // end clang namespace 15706d34893fc886f4153f104de8880876764981cb7fTed Kremenek 15718bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic SymbolRef GetCurrentAutoreleasePool(ProgramStateRef state) { 15727037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARStack stack = state->get<AutoreleaseStack>(); 15737037ab8f15950e594642adf77a56d299667debe7Ted Kremenek return stack.isEmpty() ? SymbolRef() : stack.getHead(); 15747037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 15757037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 15768bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic ProgramStateRef 15778bef8238181a30e52dea380789a7e2d760eac532Ted KremenekSendAutorelease(ProgramStateRef state, 157818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ARCounts::Factory &F, 157918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek SymbolRef sym) { 15807037ab8f15950e594642adf77a56d299667debe7Ted Kremenek SymbolRef pool = GetCurrentAutoreleasePool(state); 1581b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const ARCounts *cnts = state->get<AutoreleasePoolContents>(pool); 15827037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARCounts newCnts(0); 15831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15847037ab8f15950e594642adf77a56d299667debe7Ted Kremenek if (cnts) { 15857037ab8f15950e594642adf77a56d299667debe7Ted Kremenek const unsigned *cnt = (*cnts).lookup(sym); 15863baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(*cnts, sym, cnt ? *cnt + 1 : 1); 15877037ab8f15950e594642adf77a56d299667debe7Ted Kremenek } 15887037ab8f15950e594642adf77a56d299667debe7Ted Kremenek else 15893baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(F.getEmptyMap(), sym, 1); 15901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1591b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek return state->set<AutoreleasePoolContents>(pool, newCnts); 15927037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 15937037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 15941392261ff4418a070fb919cb4832b76b468b6faaTed Kremenek//===----------------------------------------------------------------------===// 1595c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1596c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1597c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1598ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1599ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1600ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1601c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1602c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 16031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 16041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1605ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1606c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 160735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 160835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : BugType(name, "Memory (Core Foundation/Objective-C)") {} 1609c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1611c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 161235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 16131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1614c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1615c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1617ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1618c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 161935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 162135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1622c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1624c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1626ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1627c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 162835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 16291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 163035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1631bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1632bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1633b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1634c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1636ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1637c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 163835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 163935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 16401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1641c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1642369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 16431499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1644c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1646ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1647c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 164835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 164935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 16501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1651c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1652c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 165300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 16541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1656ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1657369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 165835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 165935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 16601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1661369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1662eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1663369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1664369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 16651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1666ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1667e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 166835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 166935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 16701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1671e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 16725b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1673e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1674e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1675e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 16761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1677ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1678c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const bool isReturn; 1679c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 168035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose Leak(StringRef name, bool isRet) 1681db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose : CFRefBug(name), isReturn(isRet) { 1682db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1683db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1684db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 1685c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 168735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 16881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1689c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1690c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1692ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class LeakAtReturn : public Leak { 1693c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 169435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose LeakAtReturn(StringRef name) 169535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Leak(name, true) {} 1696c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1698ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class LeakWithinFunction : public Leak { 1699c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 170035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose LeakWithinFunction(StringRef name) 170135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Leak(name, false) {} 17021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 17031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1704c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1705c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1706c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 17071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1708dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks class CFRefReportVisitor : public BugReporterVisitor { 170923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1710dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1711ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 171235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 171323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1714dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 171535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 171635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1717dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 171823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1719dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1720dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1721dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1722dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1723dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 172423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 172523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 172623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 172723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 172823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 172923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 173023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 173123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 173223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 173323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 173423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 173523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 173635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1737ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 173835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 173923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 174023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 174123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 174223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1743dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1744dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1745e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 17462058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 174735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1748c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17492058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17502058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17512058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1752edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 175323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 17542058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17552058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1756dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1757eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 17582058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17592058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17602058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1761edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 17622058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17632058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1764dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 17651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1766e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1767edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1768edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1769e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1770c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1771640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1772c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1773c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1774eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1775ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1776c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 177723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1778c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17792058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17802058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17816a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx); 17821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1783590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1784590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1785590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1786590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 17871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 17885216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 17895216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 17902058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 17912058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1792f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 17931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1794e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 17957f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 17962058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 179735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 179835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 17991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18007f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 18012058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 180235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 180335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18057f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 18062058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 180735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 180835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 180935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 181035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 181135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 181235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 181335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 181435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 181535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18167f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1817c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 181835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1819f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 182035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1821c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1822e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1823910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18245f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1825c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18265f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1827c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1828c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 18291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1830c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1831c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1832c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 18334c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenekstatic bool isPropertyAccess(const Stmt *S, ParentMap &PM) { 18344c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek unsigned maxDepth = 4; 18354c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek while (S && maxDepth) { 18364c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek if (const PseudoObjectExpr *PO = dyn_cast<PseudoObjectExpr>(S)) { 18374c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek if (!isa<ObjCMessageExpr>(PO->getSyntacticForm())) 18384c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return true; 18394c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return false; 18404c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek } 18414c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek S = PM.getParent(S); 18424c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek --maxDepth; 18434c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek } 18444c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return false; 18454c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek} 18464c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek 1847dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1848dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1849dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1850dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 18511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1852f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<StmtPoint>(N->getLocation())) 18532033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 18541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18558966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 18568bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef PrevSt = PrevN->getState(); 18578bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef CurrSt = N->getState(); 18585eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = N->getLocationContext(); 18591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const RefVal* CurrT = CurrSt->get<RefBindings>(Sym); 1861c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 18621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1863b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 1864b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal *PrevT = PrevSt->get<RefBindings>(Sym); 18651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1866c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1867c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1868c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1869c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 18701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1871c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1872c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1873c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 1874f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 18751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18761a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (isa<ObjCArrayLiteral>(S)) { 18771a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSArray literal is an object with a +0 retain count"; 18781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 18791a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else if (isa<ObjCDictionaryLiteral>(S)) { 18801a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSDictionary literal is an object with a +0 retain count"; 1881c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 18821a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 18831a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 18841a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Get the name of the callee (if it is available). 18851a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee(), LCtx); 18861a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 18871a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "Call to function '" << *FD << '\''; 18881a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else 18891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "function call"; 18901a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 18911a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 18921a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(isa<ObjCMessageExpr>(S)); 18931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // The message expression may have between written directly or as 18941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // a property access. Lazily determine which case we are looking at. 18951a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << (isPropertyAccess(S, N->getParentMap()) ? "Property" : "Method"); 18961a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 18971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18981a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 18991a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns a Core Foundation object with a "; 19001a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19011a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19021a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 19031a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns an Objective-C object with a "; 19041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.isOwned()) { 19071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+1 retain count"; 19081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19091a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (GCEnabled) { 19101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 19111a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << ". " 19121a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek "Core Foundation objects are not automatically garbage collected."; 19131a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19141a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19151a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19161a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.isNotOwned()); 19171a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+0 retain count"; 1918c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1919cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1921220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 1922220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 1923c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 1924cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1926c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 1927c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 19285f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 19291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1930ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 1931ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 1932c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 1933c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 1934f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19365f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1937c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 1938c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 1939c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 19401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19415f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 1942c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 19431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1944c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 1945c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 19465eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI, LCtx).getAsLocSymbol() != Sym) 1947c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 19481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1949c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 1950c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 1951c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1952c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 195404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 19555eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver, LCtx) 19565eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek .getAsLocSymbol() == Sym) { 1957c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 1958c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 1959c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1960c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19611c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 19621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1963c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 1964c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 1965c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 19661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1967c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 196835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 1969c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 1970c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 1971c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 1972c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 1973c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 1974f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 1975c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 1976f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 1977f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 1978c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1980c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 1981c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 1982c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 1983f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19845eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = 19855eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee(), LCtx); 19869c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 19871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 198835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 1989c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 1990c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 19911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1992b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "In GC mode a call to '" << *FD 1993c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 1994c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 19951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1996c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 1997c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 1998c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 1999c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 2000c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2001c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2002c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 2003c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 2004c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 20053eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 20061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 2007b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "When GC is not enabled a call to '" << *FD 2008c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 20091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2010c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 2011c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2012c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 2015c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 2016c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 20171ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 20181ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 20191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2020f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 2021f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 2022f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 2023f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 20241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2025264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 2026eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 2027f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 2028f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 20291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2030c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 2031c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 2032c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2033c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 20341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2035c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 2036c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 20371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2038c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 203935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 204074b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << " The object is not eligible for garbage collection until " 204174b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "the retain count reaches 0 again."; 2042c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2044c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20461ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2047c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 20481ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 20491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2050c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 205174b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose // Autoreleases can be applied after marking a node ReturnedOwned. 205274b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose if (CurrV.getAutoreleaseCount()) 205374b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose return NULL; 205474b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose 205574b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << "Object returned to caller as an owning reference (single " 205674b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "retain count transferred to caller)"; 2057c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2059c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2060f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2061c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2063c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2064c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2065c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2067c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 20685f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2069c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 20701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2071c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 207235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2073c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2074c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2075c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2076c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2077c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2078c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2079c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2080c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2081c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2082c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2083c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2084c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2085c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 20871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2088c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2089c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 20902033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 2091f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 2092220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2093220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 20949c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 20951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2096c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2097c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 20981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 20995f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 21009c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 21015eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp, LCtx).getAsLocSymbol() == Sym) { 2102c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2103c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2104c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2106c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2107c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2108c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2109c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 2110ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class FindUniqueBinding : 2111c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public StoreManager::BindingsHandler { 2112c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym; 2113c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* Binding; 2114c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool First; 21151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2116c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 2117c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek FindUniqueBinding(SymbolRef sym) : Sym(sym), Binding(0), First(true) {} 21181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2119c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool HandleBinding(StoreManager& SMgr, Store store, const MemRegion* R, 2120c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SVal val) { 21211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SymbolRef SymV = val.getAsSymbol(); 2123c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!SymV || SymV != Sym) 2124c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return true; 21251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2126c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (Binding) { 2127c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek First = false; 2128c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 2129c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2130c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2131c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Binding = R; 21321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return true; 2134c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2136c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek operator bool() { return First && Binding; } 21370507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const MemRegion *getRegion() { return Binding; } 21381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 2139c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 21409e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek 2141e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// Find the first node in the current function context that referred to the 2142e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// tracked symbol and the memory location that value was stored to. Note, the 2143e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// value is only reported if the allocation occurred in the same function as 2144e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// the leak. 2145c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 214618c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2147c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 21489c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 21491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 2150e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks const LocationContext *LeakContext = N->getLocationContext(); 21511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2152c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 21538bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St = N->getState(); 2154c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefBindings B = St->get<RefBindings>(); 21551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2156c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!B.lookup(Sym)) 2157940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 21581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2159c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek FindUniqueBinding FB(Sym); 21601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 21611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 21621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2163e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // Allocation node, is the last node in the current context in which the 2164e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // symbol was tracked. 2165e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() == LeakContext) 2166e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks Last = N; 2167e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 21681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 21691ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 21701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2171e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // If allocation happened in a function different from the leak node context, 2172e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // do not report the binding. 2173e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() != LeakContext) { 2174e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks FirstBinding = 0; 2175e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks } 2176e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 2177c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 21786b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 21796b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2180c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 218123f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 218223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 218323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 218476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 218523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2186c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2187fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2188c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 218923f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 219023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 219123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 21921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21938966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2194c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 219576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 21961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2197c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2198c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2199c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 22009c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2201c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 22021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2203c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2204f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 22051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22064fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 22071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2208c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2209c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2210c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 22119c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 22124fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 22131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2214c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2215c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 22161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2217f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 22181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2219f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2220f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2221f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2222f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2223f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2224f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 22251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2226c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 2227c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const RefVal* RV = EndN->getState()->get<RefBindings>(Sym); 22281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2229c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2230c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 22315b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2232c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2233d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2234d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2235d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek os << " is returned from a method whose name ('" 2236d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << MD->getSelector().getAsString() 2237d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 22385b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose " This violates the naming convention rules" 2239f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " given in the Memory Management Guide for Cocoa"; 2240d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2241d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2242d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2243b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek os << " is returned from a function whose name ('" 2244a59d20b135bfde058a5a69045bab5ec4e2553f74Benjamin Kramer << *FD 2245d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 2246b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek " convention rules given in the Memory Management Guide for Core" 2247f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " Foundation"; 2248d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2249c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2250e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 22519c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2252e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 225382f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 225482f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 225582f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 225682f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2257e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2258c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2259abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2260f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 22611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2262c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2263c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2264cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 22652058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 22662058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 22672058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 22686a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx) 22692058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 22701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2271fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2272c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2273c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2274c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2275c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2276c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2277c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2278c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 22799c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 22801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22816a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const SourceManager& SMgr = Ctx.getSourceManager(); 2282590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2283c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 22846a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks GetAllocationSite(Ctx.getStateManager(), getErrorNode(), sym); 22851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2286c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2287c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 2288590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks const Stmt *AllocStmt = cast<PostStmt>(P).getStmt(); 2289590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2290590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2291c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2292c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2293c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2294dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 22952058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2296dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2297212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << "of an object"; 22981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2299c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2300c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2301212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << " stored into '" << AllocBinding->getString() << '\''; 2302dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 23032058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2304c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2305c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2306c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2307c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2308c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2309c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2310d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2311910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 23129c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 231338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 23149c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 231538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::EndPath, 23166704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2317f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 2318294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostStmt<CallExpr>, 2319537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose check::PostStmt<CXXConstructExpr>, 23201a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCArrayLiteral>, 23211a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCDictionaryLiteral>, 2322294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostObjCMessage, 2323f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 23246704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 232576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 232676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 23276f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 23286f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 23296f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 23306f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 23316f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 233238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 233338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 233438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 233538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 233638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 233738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23386f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> Summaries; 23396f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> SummariesGC; 2340b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 2341e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose mutable ARCounts::Factory ARCountFactory; 2342e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 23439c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 23449c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 23459c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23462f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2347910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 234838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2349910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 235038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 235138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 235238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23539c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 23549c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 23559c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 23569c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 23579c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 23589c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 23599c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 23609c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 23619c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 23629c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 23639c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 23641ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23651ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 23661ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 23671ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 23681ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 23691ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23709c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 23719c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 23729c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 23739c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 23741ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23759c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 23769c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 23779c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 23789c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23799c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 23809c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 23819c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 23829c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 23839c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 23849c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 23859c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23869c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 23871ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 23881ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 238917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 239017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 239117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2392db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2393db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunctionGC.reset(new LeakWithinFunction("Leak of object when " 2394db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "using garbage " 2395db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "collection")); 239617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2397db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2398db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2399e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2400db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunction.reset(new LeakWithinFunction("Leak of object when " 2401db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "not using garbage " 2402db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "collection (GC) in " 2403db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "dual GC/non-GC " 2404db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "code")); 2405db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2406db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunction.reset(new LeakWithinFunction("Leak")); 2407db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2408db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 240917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunction.get(); 2410db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2411db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2412db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 241317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakAtReturnBug(const LangOptions &LOpts, bool GCEnabled) const { 241417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2415db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturnGC) 2416db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturnGC.reset(new LeakAtReturn("Leak of returned object when " 2417db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "using garbage collection")); 241817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2419db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2420db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2421e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2422db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturn.reset(new LeakAtReturn("Leak of returned object when " 2423db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "not using garbage collection " 2424db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "(GC) in dual GC/non-GC code")); 2425db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2426db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturn.reset(new LeakAtReturn("Leak of returned object")); 2427db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2428db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 242917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturn.get(); 2430db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2431db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2432db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 243317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(ASTContext &Ctx, 243417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 243517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // FIXME: We don't support ARC being turned on and off during one analysis. 243617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // (nor, for that matter, do we support changing ASTContexts) 24374e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie bool ARCEnabled = (bool)Ctx.getLangOpts().ObjCAutoRefCount; 243817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 243917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!SummariesGC) 2440b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose SummariesGC.reset(new RetainSummaryManager(Ctx, true, ARCEnabled)); 244117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 244217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(SummariesGC->isARCEnabled() == ARCEnabled); 2443b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *SummariesGC; 2444b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } else { 244517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!Summaries) 2446b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose Summaries.reset(new RetainSummaryManager(Ctx, false, ARCEnabled)); 244717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 244817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(Summaries->isARCEnabled() == ARCEnabled); 2449b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *Summaries; 2450b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2451b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2452b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 245317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(CheckerContext &C) const { 245417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return getSummaryManager(C.getASTContext(), C.isObjCGCEnabled()); 245517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 245617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 24578bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void printState(raw_ostream &Out, ProgramStateRef State, 2458dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const char *NL, const char *Sep) const; 2459dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 2460390909c89c98ab1807e15e033a72e975f866fb23Anna Zaks void checkBind(SVal loc, SVal val, const Stmt *S, CheckerContext &C) const; 2461ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const; 2462ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const CastExpr *CE, CheckerContext &C) const; 2463f85e193739c953358c865005855253af4f68a497John McCall 2464294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostStmt(const CallExpr *CE, CheckerContext &C) const; 2465537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose void checkPostStmt(const CXXConstructExpr *CE, CheckerContext &C) const; 24661a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCArrayLiteral *AL, CheckerContext &C) const; 24671a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCDictionaryLiteral *DL, CheckerContext &C) const; 2468294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostObjCMessage(const ObjCMessage &Msg, CheckerContext &C) const; 24691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 2470294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkSummary(const RetainSummary &Summ, const CallOrObjCMessage &Call, 2471e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2472294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 247376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 247476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 24758bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond, 2476ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 24776704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 24788bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 24798bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek checkRegionChanges(ProgramStateRef state, 2480537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 2481537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 248266c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 248366c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks const CallOrObjCMessage *Call) const; 2484ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 24858bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool wantsRegionChangeUpdate(ProgramStateRef state) const { 24862f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2487ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2488294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2489f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2490f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2491f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 24928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek SymbolRef Sym, ProgramStateRef state) const; 2493f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 249438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 2495af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks void checkEndPath(CheckerContext &C) const; 249638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 24978bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef updateSymbol(ProgramStateRef state, SymbolRef sym, 249817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 249917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CheckerContext &C) const; 2500e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 25018bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void processNonLeakError(ProgramStateRef St, SourceRange ErrorRange, 2502294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2503294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 25041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void processObjCLiterals(CheckerContext &C, const Expr *Ex) const; 2506294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 250738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 250838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25098bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef handleSymbolDeath(ProgramStateRef state, 251038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef sid, RefVal V, 251138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const; 251238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25138bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ExplodedNode *, ProgramStateRef > 25148bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek handleAutoreleaseCounts(ProgramStateRef state, 25158d22863184419faa2348bd5148c663197bc4bb00Jordy Rose GenericNodeBuilderRefCount Bd, ExplodedNode *Pred, 25166a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, SymbolRef Sym, RefVal V) const; 25178d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 25188bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *processLeaks(ProgramStateRef state, 251938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 252038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount &Builder, 25216a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 252238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2523d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2524d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2525d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 25266704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 25276704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 25288bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 25296704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 25308bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek StopTrackingCallback(ProgramStateRef st) : state(st) {} 25318bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return state; } 25326704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25336704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 25346704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 25356704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 25366704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 25376704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 25386704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 25396704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2540910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2541910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2542910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 25436704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2544910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2545910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2546dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2547910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2548dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2549469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 255038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2551dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 25528bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 255338cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 25545eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek cast<BlockDataRegion>(state->getSVal(BE, 25555eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsRegion()); 2556dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 255738cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 255838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2559dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 256038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 256138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2562dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 256367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 256467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 256567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 25665f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 256739ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2568c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2569dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 257067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 257167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion *VR = *I; 257267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 257367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 257467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 257567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 257667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2577dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 257867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 257967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 258067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 25810bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 258238cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 258338cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2584910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2585910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2586f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2587f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2588f85e193739c953358c865005855253af4f68a497John McCall return; 2589f85e193739c953358c865005855253af4f68a497John McCall 259071c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2591f85e193739c953358c865005855253af4f68a497John McCall 2592f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2593f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2594f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2595f85e193739c953358c865005855253af4f68a497John McCall return; 2596f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2597f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2598f85e193739c953358c865005855253af4f68a497John McCall break; 2599f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2600f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2601f85e193739c953358c865005855253af4f68a497John McCall break; 2602f85e193739c953358c865005855253af4f68a497John McCall } 2603f85e193739c953358c865005855253af4f68a497John McCall 26048bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26055eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CE, C.getLocationContext()).getAsLocSymbol(); 2606f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2607f85e193739c953358c865005855253af4f68a497John McCall return; 2608f85e193739c953358c865005855253af4f68a497John McCall const RefVal* T = state->get<RefBindings>(Sym); 2609f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2610f85e193739c953358c865005855253af4f68a497John McCall return; 2611f85e193739c953358c865005855253af4f68a497John McCall 2612f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 261317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2614f85e193739c953358c865005855253af4f68a497John McCall 2615f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2616e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2617e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2618f85e193739c953358c865005855253af4f68a497John McCall return; 2619f85e193739c953358c865005855253af4f68a497John McCall } 2620f85e193739c953358c865005855253af4f68a497John McCall 26210bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 2622f85e193739c953358c865005855253af4f68a497John McCall} 2623f85e193739c953358c865005855253af4f68a497John McCall 2624910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CallExpr *CE, 2625910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2626294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Get the callee. 26278bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2628294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Callee = CE->getCallee(); 26295eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal L = state->getSVal(Callee, C.getLocationContext()); 2630294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 263117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 263293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = 0; 2633294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2634294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Better support for blocks. For now we stop tracking anything 2635294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // that is passed to blocks. 2636294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Need to handle variables that are "captured" by the block. 2637294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (dyn_cast_or_null<BlockDataRegion>(L.getAsRegion())) { 2638294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getPersistentStopSummary(); 2639294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const FunctionDecl *FD = L.getAsFunctionDecl()) { 2640294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getSummary(FD); 2641294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const CXXMemberCallExpr *me = dyn_cast<CXXMemberCallExpr>(CE)) { 2642294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const CXXMethodDecl *MD = me->getMethodDecl()) 2643294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getSummary(MD); 2644294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2645294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2646294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 264793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Summ = Summaries.getDefaultSummary(); 2648294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 26495eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(CE, state, C.getLocationContext()), C); 2650294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2651294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2652910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CXXConstructExpr *CE, 2653910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2654537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const CXXConstructorDecl *Ctor = CE->getConstructor(); 2655537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Ctor) 2656537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2657537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 265817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 265993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = Summaries.getSummary(Ctor); 2660537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 2661537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose // If we didn't get a summary, this constructor doesn't affect retain counts. 2662537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Summ) 2663537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2664537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 26658bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26665eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(CE, state, C.getLocationContext()), C); 2667537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose} 2668537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 26691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::processObjCLiterals(CheckerContext &C, 26701a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Expr *Ex) const { 26711a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ProgramStateRef state = C.getState(); 26721a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const ExplodedNode *pred = C.getPredecessor(); 26731a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek for (Stmt::const_child_iterator it = Ex->child_begin(), et = Ex->child_end() ; 26741a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek it != et ; ++it) { 26751a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Stmt *child = *it; 26761a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal V = state->getSVal(child, pred->getLocationContext()); 26771a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = V.getAsSymbol()) 26781a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const RefVal* T = state->get<RefBindings>(sym)) { 26791a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek RefVal::Kind hasErr = (RefVal::Kind) 0; 26801a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = updateSymbol(state, sym, *T, MayEscape, hasErr, C); 26811a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (hasErr) { 26821a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processNonLeakError(state, child->getSourceRange(), hasErr, sym, C); 26831a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek return; 26841a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26851a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26861a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26871a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26881a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Return the object as autoreleased. 26891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // RetEffect RE = RetEffect::MakeNotOwned(RetEffect::ObjC); 26901a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = 26911a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state->getSVal(Ex, pred->getLocationContext()).getAsSymbol()) { 26921a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek QualType ResultTy = Ex->getType(); 26931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = state->set<RefBindings>(sym, RefVal::makeNotOwned(RetEffect::ObjC, 26941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ResultTy)); 26951a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26961a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26971a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek C.addTransition(state); 26981a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 26991a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27001a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCArrayLiteral *AL, 27011a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27021a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all values. 27031a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, AL); 27041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCDictionaryLiteral *DL, 27071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27081a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all keys and values. 27091a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, DL); 27101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27111a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 2712910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostObjCMessage(const ObjCMessage &Msg, 2713910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 27148bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2715294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 271617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2717b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 271893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ; 2719294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Msg.isInstanceMessage()) { 2720a2a860306e3697fcf7a12c5ba59551ca60578968Anna Zaks const LocationContext *LC = C.getLocationContext(); 2721294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getInstanceMethodSummary(Msg, state, LC); 2722294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 2723294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getClassMethodSummary(Msg); 2724294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2725294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2726294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // If we didn't get a summary, this message doesn't affect retain counts. 2727294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 2728294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2729294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 27305eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(Msg, state, C.getLocationContext()), C); 2731294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2732294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2733910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2734910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2735910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// While the the return type can be queried directly from RetEx, when 2736910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2737910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2738910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2739910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2740910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2741910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2742910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2743910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2744910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2745910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2746910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2747910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2748910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2749910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2750910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2751910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2752910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2753910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2754910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2755910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2756910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2757910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2758910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2759910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2760910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2761910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 2762910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const CallOrObjCMessage &CallOrMsg, 2763910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 27648bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2765294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2766294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2767294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2768294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2769294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2770294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2771294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2772537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2773294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2774294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 2775294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RefBindings::data_type *T = state->get<RefBindings>(Sym)) { 277617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2777294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2778294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2779294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2780294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2781294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2782294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2783294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2784294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2785294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2786294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2787294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 2788e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (!hasErr && CallOrMsg.isObjCMessage()) { 278939ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2790e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose SVal Receiver = CallOrMsg.getInstanceMessageReceiver(LC); 2791e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (SymbolRef Sym = Receiver.getAsLocSymbol()) { 2792294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const RefVal *T = state->get<RefBindings>(Sym)) { 2793294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ReceiverIsTracked = true; 279417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 279517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose hasErr, C); 2796294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2797e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose ErrorRange = CallOrMsg.getReceiverSourceRange(); 2798294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2799294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2800294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2801294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2802294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2803294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2804294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2805294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2806294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2807294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2808294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2809294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2810294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2811294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2812294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2813294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2814b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 281517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2816b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2817294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2818294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2819294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2820294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2821294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 28227530c034c0c71a64c5a9173206d9742ae847af8bDavid Blaikie llvm_unreachable("Unhandled RetEffect."); 2823294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2824294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2825294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2826294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2827294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2828294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2829294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 28305eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 28315eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsSymbol(); 2832294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2833294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2834294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2835294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use the result type from callOrMsg as it automatically adjusts 2836294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 2837294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = CallOrMsg.getResultType(C.getASTContext()); 2838294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeOwned(RE.getObjKind(), 2839294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2840294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2841294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2842294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // *not* fail. (The code below is out-of-date, though.) 2843294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#if 0 2844294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedAllocatedSymbol) { 2845294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool isFeasible; 2846294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state.assume(loc::SymbolVal(Sym), true, isFeasible); 2847294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose assert(isFeasible && "Cannot assume fresh symbol is non-null."); 2848294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2849294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#endif 2850294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2851294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2852294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2853294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2854294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2855294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2856294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2857294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 28585eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(Ex, C.getLocationContext()).getAsSymbol(); 2859294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2860294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2861294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2862294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2863294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 2864294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeNotOwned(RE.getObjKind(), 2865294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2866294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2867294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2868294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2869294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2870294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2871294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2872294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2873294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2874294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2875294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2876294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 28770bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks NewNode = C.addTransition(state); 2878294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2879294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 28809c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 28819c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 28829c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 28839c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 28849c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 28859c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 28869c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2887ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 28889c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2889294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2890294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2891e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 28928bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 28938bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::updateSymbol(ProgramStateRef state, SymbolRef sym, 2894910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2895910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2896e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2897910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 289817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 289917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 29004e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie IgnoreRetainMsg = (bool)C.getASTContext().getLangOpts().ObjCAutoRefCount; 290117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2902e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2903e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: break; 290417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case IncRefMsg: E = IgnoreRetainMsg ? DoNothing : IncRef; break; 290517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case DecRefMsg: E = IgnoreRetainMsg ? DoNothing : DecRef; break; 290617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case MakeCollectable: E = C.isObjCGCEnabled() ? DecRef : DoNothing; break; 290717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case NewAutoreleasePool: E = C.isObjCGCEnabled() ? DoNothing : 290817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose NewAutoreleasePool; break; 2909e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2910e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2911e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 291217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2913e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2914e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2915e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2916e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2917e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2918e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2919e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2920e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2921e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 2922e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2923e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2924e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2925e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 292617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2927e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2928e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2929e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2930e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2931e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2932e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2933e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2934e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2935e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2936e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2937e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2938e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 2939e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2940e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2941e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2942e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2943e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2944e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2945e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2946e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2947e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case NewAutoreleasePool: 294817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!C.isObjCGCEnabled()); 2949e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->add<AutoreleaseStack>(sym); 2950e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2951e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 2952e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 2953e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2954e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2955e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2956e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2957e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2958e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2959e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 2960e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2961e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2962e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 296317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 2964e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2965e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2966e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 2967e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose state = SendAutorelease(state, ARCountFactory, sym); 2968e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 2969e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2970e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2971e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 2972e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->remove<RefBindings>(sym); 2973e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2974e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 2975e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2976e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2977e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 2978e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2979e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2980e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 2981e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2982e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 2983e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 298417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 2985e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 2986e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2987e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2988e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2989e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2990e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case SelfOwn: 2991e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2992e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2993e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 2994e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 2995e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2996e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2997e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 2998e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 2999e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3000e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3001e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 3002e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 3003e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 3004e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 3005e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3006e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3007e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3008e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 3009e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() > 0) 3010e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3011e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose else { 3012e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 3013e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3014e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3015e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3016e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3017e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3018e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 301917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3020e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 3021e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3022e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3023e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3024e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3025e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3026e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 3027e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 3028e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 30298bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::processNonLeakError(ProgramStateRef St, 3030910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 3031910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 3032910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 3033910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3034294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 3035294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 3036294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 3037294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3038294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 3039294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 3040294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 3041294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 3042294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 3043d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 3044d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 3045d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 3046294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3047294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 3048d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 3049d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 3050d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 3051294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3052294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 3053d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 3054d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 3055d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 3056294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3057294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 3058d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 3059d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 3060d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 3061294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3062294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3063294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3064d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 30654e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOpts(), 306617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 306717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 3068294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 3069294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.EmitReport(report); 3070294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 3071294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3072910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3073910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 3074910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3075910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3076910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 307776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 30788bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3079b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *FD = C.getCalleeDecl(CE); 308076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 308176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 308276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 308376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 308476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 308576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 308676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 308776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 308876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 308976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 309076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 309176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 309276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 309376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 309476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 309576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 309676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 309776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 309876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 309976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 310076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3101b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks QualType ResultTy = CE->getCallReturnType(); 310276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 310376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 310476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 310576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 310676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 310776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 310876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 310976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 311076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 311176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 311276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 311376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 311476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 311576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 311676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 311776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 311876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 31195eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = C.getLocationContext(); 31205eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal RetVal = state->getSVal(CE->getArg(0), LCtx); 312176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 312276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 312376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 31245d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 31253133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek SVal RetVal = SVB.getConjuredSymbolVal(0, CE, LCtx, ResultTy, Count); 312676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 31275eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal, false); 312876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3129294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3130294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3131294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3132294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3133294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 3134294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefBindings::data_type *Binding = 0; 3135294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 3136294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Binding = state->get<RefBindings>(Sym); 313776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3138294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 31395d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 31403133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek state = state->invalidateRegions(ArgRegion, CE, Count, LCtx); 314176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3142294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3143294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 3144294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, *Binding); 3145294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3146294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 31470bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 314876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 314976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 315076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3151910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3152910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3153910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3154f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3155e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek// Return true if the current LocationContext has no caller context. 3156e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenekstatic bool inTopFrame(CheckerContext &C) { 3157e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek const LocationContext *LC = C.getLocationContext(); 3158e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return LC->getParent() == 0; 3159e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek} 3160e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3161910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3162910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3163e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3164e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // Only adjust the reference count if this is the top-level call frame, 3165e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // and not the result of inlining. In the future, we should do 3166e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // better checking even for inlined calls, and see if they match 3167e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // with their expected semantics (e.g., the method should return a retained 3168e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // object, etc.). 3169e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek if (!inTopFrame(C)) 3170e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return; 3171e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3172f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3173f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3174f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3175f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 31768bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 31775eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = 31785eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state->getSValAsScalarOrLoc(RetE, C.getLocationContext()).getAsLocSymbol(); 3179f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3180f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3181f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3182f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 3183f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const RefVal *T = state->get<RefBindings>(Sym); 3184f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3185f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3186f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3187f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3188f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3189f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3190f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3191f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3192f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3193f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3194f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3195f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3196f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3197f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3198f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3199f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3200f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3201f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3202f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3203f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3204f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3205f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3206f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3207f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3208f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3209f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3210f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3211f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3212f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3213f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3214f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3215f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 3216f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 32170bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *Pred = C.addTransition(state); 3218f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3219f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3220f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3221f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3222f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3223f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3224f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3225f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3226f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3227f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3228f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3229910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 32304eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, &AutoreleaseTag); 32316a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, Sym, X); 3232f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3233f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 32348d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!Pred) 3235f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3236f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3237f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 3238f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose T = state->get<RefBindings>(Sym); 3239f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3240f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3241f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3242f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 324317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3244f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 3245f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3246f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3247f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Unlike regular functions, /all/ ObjC methods are assumed to always 3248f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // follow Cocoa retain-count conventions, not just those with special 3249f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // names or attributes. 3250b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 3251f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RetEffect RE = Summ ? Summ->getRetEffect() : RetEffect::MakeNoRet(); 3252f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3253f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3254f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3255f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 3256f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<CXXMethodDecl>(FD)) 3257b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (const RetainSummary *Summ = Summaries.getSummary(FD)) 3258f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, Summ->getRetEffect(), X, 3259f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose Sym, state); 3260f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3261f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3262f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3263910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3264910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3265910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3266910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3267910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 32688bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state) const { 3269f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3270f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3271f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3272f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 327317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3274f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3275f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3276f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3277f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3278f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3279f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3280f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3281f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3282f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3283f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3284f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3285f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3286f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3287f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3288f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3289f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3290f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 3291f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 3292f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3293f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3294910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 32950bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnOwnLeakTag); 3296f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 32974e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = C.getASTContext().getLangOpts(); 329817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3299f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 330017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 330117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 33026a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks N, Sym, C); 3303f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3304f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3305f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3306f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3307f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3308f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3309f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3310f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 3311f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X ^ RefVal::ErrorReturnedNotOwned); 3312f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3313f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3314910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 33150bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnNotOwnedTag); 3316f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3317d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3318d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3319d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3320f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3321d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 33224e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie C.getASTContext().getLangOpts(), 332317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3324f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3325f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3326f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3327f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3328f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3329f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33308d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3331910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3332910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3333910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3334390909c89c98ab1807e15e033a72e975f866fb23Anna Zaksvoid RetainCountChecker::checkBind(SVal loc, SVal val, const Stmt *S, 3335910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3336910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3337910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3338910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3339910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3340910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3341910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3342910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3343910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3344910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 33458bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3346910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3347910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (loc::MemRegionVal *regionLoc = dyn_cast<loc::MemRegionVal>(&loc)) { 3348910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3349910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3350910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3351910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3352910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3353910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3354910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = (state == (state->bindLoc(*regionLoc, val))); 3355910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3356910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3357910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3358910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3359910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3360910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3361910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3362910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3363910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3364910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3365910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3366910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 33670bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 3368910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3369910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 33708bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef RetainCountChecker::evalAssume(ProgramStateRef state, 3371910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3372910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3373910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3374910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3375910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3376910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3377910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3378910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3379910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3380910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings B = state->get<RefBindings>(); 3381910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3382910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3383910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3384910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3385910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3386910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings::Factory &RefBFactory = state->get_context<RefBindings>(); 3387910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3388910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3389910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Check if the symbol is null (or equal to any constant). 3390910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If this is the case, stop tracking the symbol. 3391910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (state->getSymVal(I.getKey())) { 3392910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3393910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3394910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3395910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3396910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3397910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3398910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3399910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3400910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3401910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3402910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34038bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 34048bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::checkRegionChanges(ProgramStateRef state, 3405910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 3406910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 340766c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 340866c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks const CallOrObjCMessage *Call) const { 3409910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3410910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3411910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3412910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3413910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3414910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3415910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3416910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3417910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3418910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3419910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (StoreManager::InvalidatedSymbols::const_iterator I=invalidated->begin(), 3420910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3421910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3422910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3423910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3424910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 3425910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->remove<RefBindings>(sym); 3426910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3427910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3428910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3429910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3430910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 34318d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 34328d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 34338d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34348bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstd::pair<ExplodedNode *, ProgramStateRef > 34358bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleAutoreleaseCounts(ProgramStateRef state, 3436910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount Bd, 34376a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred, 34386a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 3439910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 34408d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 34418d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34428d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 34438d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 34448d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(Pred, state); 34458d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34466a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks assert(!Ctx.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 34478d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 34488d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34498d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 34508d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34518d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 34528d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 34538d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34548d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 34558d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 34568d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 34578d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 34588d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 34598d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 34608d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 34618d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 34628d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setCount(Cnt - ACnt); 34638d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 34648d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 34658d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 34668d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ExplodedNode *N = Bd.MakeNode(state, Pred); 34678d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (N == 0) 34688d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = 0; 34698d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(N, state); 34708d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 34718d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34728d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 34738d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 34748d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 34758d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 34768d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3477f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks if (ExplodedNode *N = Bd.MakeNode(state, Pred, true)) { 3478f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<128> sbuf; 34798d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 34808d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 34818d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 34828d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 34838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 34848d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3485d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3486d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3487d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 34884e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 34898d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3490d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3491d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 34926a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 34938d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 34948d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34958bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek return std::make_pair((ExplodedNode *)0, (ProgramStateRef )0); 34968d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 349738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 34988bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 34998bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleSymbolDeath(ProgramStateRef state, 3500910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 350138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 35025337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 350338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 350438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 350538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 350638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 350738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 350838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 350938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->remove<RefBindings>(sid); 351038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 351138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 351238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->set<RefBindings>(sid, V ^ RefVal::ErrorLeak); 351338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 351438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 351538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 35168bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::processLeaks(ProgramStateRef state, 3517910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 3518910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount &Builder, 35196a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 35206a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred) const { 352138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (Leaked.empty()) 352238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return Pred; 352338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 352438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 352538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *N = Builder.MakeNode(state, Pred); 352638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 352738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 352838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 352938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 353038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35314e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35326a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks bool GCEnabled = Ctx.isObjCGCEnabled(); 353317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 353417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 353538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 35362058956954802229bf98604e8063fa57677abff4Jordy Rose 353717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 35386a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks SummaryLog, N, *I, Ctx); 35396a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 354038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 354138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 354238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 354338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 354438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 354538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3546af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaksvoid RetainCountChecker::checkEndPath(CheckerContext &Ctx) const { 35478bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Ctx.getState(); 3548af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks GenericNodeBuilderRefCount Bd(Ctx); 354938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 3550af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred = Ctx.getPredecessor(); 355138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 355238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 35536a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, Ctx, 35548d22863184419faa2348bd5148c663197bc4bb00Jordy Rose I->first, I->second); 35558d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 355638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 355738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 355838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35590cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // If the current LocationContext has a parent, don't check for leaks. 35600cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // We will do that later. 35610cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // FIXME: we should instead check for imblances of the retain/releases, 35620cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // and suggest annotations. 35630cf3d471546251b12bdceff360f66c079c40526cTed Kremenek if (Ctx.getLocationContext()->getParent()) 35640cf3d471546251b12bdceff360f66c079c40526cTed Kremenek return; 35650cf3d471546251b12bdceff360f66c079c40526cTed Kremenek 356638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 356738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 356838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) 35708d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 357138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35726a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks processLeaks(state, Leaked, Bd, Ctx, Pred); 357338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 357438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3576910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 357738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 357838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 3579f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<64> buf; 358038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3581f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks out << "RetainCountChecker : Dead Symbol : "; 3582f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks sym->dumpToStream(out); 358338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 358438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 358538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 358638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 358738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3588910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3589910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 359038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 359138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 359338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 359438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 359538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 359638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 359738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 359838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 359938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 360038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 360138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 36024eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, getDeadSymbolTag(Sym)); 36036a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, 36048d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Sym, *T); 36058d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 360638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 360738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 360838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 360938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 361038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 361138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 361238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 361338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 361438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 361538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(*I)) 361638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = handleSymbolDeath(state, *I, *T, Leaked); 361738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 361838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 361938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose { 36204eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, this); 36216a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Pred = processLeaks(state, Leaked, Bd, C, Pred); 362238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 362338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 362438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 362538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 362638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 362738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 362838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 362938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings::Factory &F = state->get_context<RefBindings>(); 363038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 363138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 363238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) 363338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 363438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 363538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 36360bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state, Pred); 363738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 363838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3639d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek//===----------------------------------------------------------------------===// 3640dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose// Debug printing of refcount bindings and autorelease pools. 3641dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3642dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3643dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rosestatic void PrintPool(raw_ostream &Out, SymbolRef Sym, 36448bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State) { 3645dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ' '; 3646dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (Sym) 3647f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks Sym->dumpToStream(Out); 3648dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose else 3649dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "<pool>"; 3650dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ":{"; 3651dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3652dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Get the contents of the pool. 3653dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (const ARCounts *Cnts = State->get<AutoreleasePoolContents>(Sym)) 3654dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARCounts::iterator I = Cnts->begin(), E = Cnts->end(); I != E; ++I) 3655dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '(' << I.getKey() << ',' << I.getData() << ')'; 3656dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3657dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '}'; 3658dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3659dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 36608bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic bool UsesAutorelease(ProgramStateRef state) { 3661dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // A state uses autorelease if it allocated an autorelease pool or if it has 3662dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // objects in the caller's autorelease pool. 3663dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose return !state->get<AutoreleaseStack>().isEmpty() || 3664dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose state->get<AutoreleasePoolContents>(SymbolRef()); 3665dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3666dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 36678bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::printState(raw_ostream &Out, ProgramStateRef State, 3668910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3669dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3670dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose RefBindings B = State->get<RefBindings>(); 3671dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3672dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3673dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3674dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3675dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3676dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3677dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3678dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3679dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3680dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3681dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Print the autorelease stack. 3682dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (UsesAutorelease(State)) { 3683dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL << "AR pool stack:"; 3684dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose ARStack Stack = State->get<AutoreleaseStack>(); 3685dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3686dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, SymbolRef(), State); // Print the caller's pool. 3687dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARStack::iterator I = Stack.begin(), E = Stack.end(); I != E; ++I) 3688dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, *I, State); 3689dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3690dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3691dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3692dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3693dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3694dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3695910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 36966b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 36976b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 369817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3699910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 370017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 370117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3702