RetainCountChecker.cpp revision 50571a9fd8871c722e8655c7c2c3b2871a0d14c1
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) { 47628b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer typedef std::pair<IdentifierInfo*, Selector> PairTy; 47728b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer return DenseMapInfo<PairTy>::getHashValue(PairTy(V.getIdentifier(), 47828b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer V.getSelector())); 479553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 481553cf18cd44769a7624fc942493f076498527529Ted Kremenek static bool isEqual(const ObjCSummaryKey& LHS, const ObjCSummaryKey& RHS) { 48228b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer return LHS.getIdentifier() == RHS.getIdentifier() && 48328b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer LHS.getSelector() == RHS.getSelector(); 484553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 486553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 48706159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <> 48806159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<ObjCSummaryKey> { static const bool value = true; }; 489553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end llvm namespace 4901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 491553cf18cd44769a7624fc942493f076498527529Ted Kremeneknamespace { 492ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryCache { 49393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<ObjCSummaryKey, const RetainSummary *> MapTy; 494553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy M; 495553cf18cd44769a7624fc942493f076498527529Ted Kremenekpublic: 496553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryCache() {} 4971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 49893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, IdentifierInfo *ClsName, 499a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek Selector S) { 5008711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Lookup the method using the decl for the class @interface. If we 5018711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // have no decl, lookup using the class name. 5028711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek return D ? find(D, S) : find(ClsName, S); 5038711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 5041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 50593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, Selector S) { 506553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Do a lookup with the (D,S) pair. If we find a match return 507553cf18cd44769a7624fc942493f076498527529Ted Kremenek // the iterator. 508553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey K(D, S); 509553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy::iterator I = M.find(K); 5101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 511553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (I != M.end() || !D) 512614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I->second; 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 514553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Walk the super chain. If we find a hit with a parent, we'll end 515553cf18cd44769a7624fc942493f076498527529Ted Kremenek // up returning that summary. We actually allow that key (null,S), as 516553cf18cd44769a7624fc942493f076498527529Ted Kremenek // we cache summaries for the null ObjCInterfaceDecl* to allow us to 517553cf18cd44769a7624fc942493f076498527529Ted Kremenek // generate initial summaries without having to worry about NSObject 518553cf18cd44769a7624fc942493f076498527529Ted Kremenek // being declared. 519553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: We may change this at some point. 5209c378f705405d37f49795d5e915989de774fe11fTed Kremenek for (ObjCInterfaceDecl *C=D->getSuperClass() ;; C=C->getSuperClass()) { 521553cf18cd44769a7624fc942493f076498527529Ted Kremenek if ((I = M.find(ObjCSummaryKey(C, S))) != M.end()) 522553cf18cd44769a7624fc942493f076498527529Ted Kremenek break; 5231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 524553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (!C) 525614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return NULL; 5264f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek } 5271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Cache the summary with original key to make the next lookup faster 529553cf18cd44769a7624fc942493f076498527529Ted Kremenek // and return the iterator. 53093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = I->second; 531614cc540a617978814e37d75bf5066926b921a0aTed Kremenek M[K] = Summ; 532614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return Summ; 533553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5350507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *find(IdentifierInfo* II, Selector S) { 536553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: Class method lookup. Right now we dont' have a good way 537553cf18cd44769a7624fc942493f076498527529Ted Kremenek // of going between IdentifierInfo* and the class hierarchy. 538614cc540a617978814e37d75bf5066926b921a0aTed Kremenek MapTy::iterator I = M.find(ObjCSummaryKey(II, S)); 5391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 540614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (I == M.end()) 541614cc540a617978814e37d75bf5066926b921a0aTed Kremenek I = M.find(ObjCSummaryKey(S)); 5421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 543614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I == M.end() ? NULL : I->second; 544553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](ObjCSummaryKey K) { 547553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[K]; 548553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 55093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](Selector S) { 551553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[ ObjCSummaryKey(S) ]; 552553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 554553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end anonymous namespace 555553cf18cd44769a7624fc942493f076498527529Ted Kremenek 556553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 557553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for managing collections of summaries. 558553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 559553cf18cd44769a7624fc942493f076498527529Ted Kremenek 5604f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 561ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummaryManager { 562d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 563d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 564d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Typedefs. 565d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<const FunctionDecl*, const RetainSummary *> 568d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy; 5691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5704f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek typedef ObjCSummaryCache ObjCMethodSummariesTy; 5711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 572ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose typedef llvm::FoldingSetNodeWrapper<RetainSummary> CachedSummaryNode; 573ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 574d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 575d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Data. 576d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 578553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ctx - The ASTContext object for the analyzed ASTs. 5799c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &Ctx; 580179064eb831125630c296556dd6d67e67f716143Ted Kremenek 581553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// GCEnabled - Records whether or not the analyzed code runs in GC mode. 582377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek const bool GCEnabled; 5831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 584f85e193739c953358c865005855253af4f68a497John McCall /// Records whether or not the analyzed code runs in ARC mode. 585f85e193739c953358c865005855253af4f68a497John McCall const bool ARCEnabled; 586f85e193739c953358c865005855253af4f68a497John McCall 587553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// FuncSummaries - A map from FunctionDecls to summaries. 5881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump FuncSummariesTy FuncSummaries; 5891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 590553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCClassMethodSummaries - A map from selectors (for instance methods) 591553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// to summaries. 5921f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCClassMethodSummaries; 593d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 594553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCMethodSummaries - A map from selectors to summaries. 5951f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCMethodSummaries; 596d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 597553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// BPAlloc - A BumpPtrAllocator used for allocating summaries, ArgEffects, 598553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// and all other data used by the checker. 599d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek llvm::BumpPtrAllocator BPAlloc; 6001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 601b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek /// AF - A factory for ArgEffects objects. 6021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ArgEffects::Factory AF; 6031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 604553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ScratchArgs - A holding buffer for construct ArgEffects. 6050507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffects ScratchArgs; 6061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 607ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// ObjCAllocRetE - Default return effect for methods returning Objective-C 608ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// objects. 609ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek RetEffect ObjCAllocRetE; 610547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek 6111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// ObjCInitRetE - Default return effect for init methods returning 612ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek /// Objective-C objects. 613547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek RetEffect ObjCInitRetE; 6141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 615ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// SimpleSummaries - Used for uniquing summaries that don't have special 616ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// effects. 617ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSet<CachedSummaryNode> SimpleSummaries; 6181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 619d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 620d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Methods. 621d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 6221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 623553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArgEffects - Returns a persistent ArgEffects object based on the 624553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// data in ScratchArgs. 625b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects getArgEffects(); 62600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 6271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum UnaryFuncKind { cfretain, cfrelease, cfmakecollectable }; 6281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 629896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekpublic: 63078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek RetEffect getObjAllocRetEffect() const { return ObjCAllocRetE; } 63193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek 6320507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getUnarySummary(const FunctionType* FT, 63393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek UnaryFuncKind func); 6341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6350507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryCreateRule(const FunctionDecl *FD); 6360507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryGetRule(const FunctionDecl *FD); 6370507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFCreateGetRuleSummary(const FunctionDecl *FD); 6381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 639ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(const RetainSummary &OldSumm); 640706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 641ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(RetEffect RetEff, 64293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect ReceiverEff = DoNothing, 64393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect DefaultEff = MayEscape) { 644ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummary Summ(getArgEffects(), RetEff, DefaultEff, ReceiverEff); 645ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(Summ); 6469c32d08925045b32d7c39516e35d860159252e1dTed Kremenek } 6471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 648c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek const RetainSummary *getDoNothingSummary() { 649c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 650c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } 651c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek 652ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getDefaultSummary() { 653ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 654ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose DoNothing, MayEscape); 655ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 656706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 657ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentStopSummary() { 658ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 659ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose StopTracking, StopTracking); 6601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 661b309525445c8ec3d36e49568382029efc2740554Ted Kremenek 6621f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeClassMethodSummaries(); 6631f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeMethodSummaries(); 664896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekprivate: 66593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectClsMethSummary(Selector S, const RetainSummary *Summ) { 666553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCClassMethodSummaries[S] = Summ; 667553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 66993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectMethSummary(Selector S, const RetainSummary *Summ) { 670553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCMethodSummaries[S] = Summ; 671553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6723aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek 673a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek void addClassMethSummary(const char* Cls, const char* name, 674a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek const RetainSummary *Summ, bool isNullary = true) { 6753aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 676a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek Selector S = isNullary ? GetNullarySelector(name, Ctx) 677a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek : GetUnarySelector(name, Ctx); 6783aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6793aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek } 6801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6816c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek void addInstMethSummary(const char* Cls, const char* nullaryName, 68293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ) { 6836c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6846c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6856c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek ObjCMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6866c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek } 6871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 688de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector generateSelector(va_list argp) { 6895f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<IdentifierInfo*, 10> II; 690de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6919e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek while (const char* s = va_arg(argp, const char*)) 6929e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek II.push_back(&Ctx.Idents.get(s)); 693de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return Ctx.Selectors.getSelector(II.size(), &II[0]); 695de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 6961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 697de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addMethodSummary(IdentifierInfo *ClsII, ObjCMethodSummariesTy& Summaries, 69893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * Summ, va_list argp) { 699de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector S = generateSelector(argp); 700de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Summaries[ObjCSummaryKey(ClsII, S)] = Summ; 70170a733e64e2379a654631a14fa29e46761d5f80dTed Kremenek } 7021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addInstMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 704af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_list argp; 705af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_start(argp, Summ); 706de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls), ObjCMethodSummaries, Summ, argp); 7071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump va_end(argp); 708af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek } 7091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 711de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 712de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 713de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls),ObjCClassMethodSummaries, Summ, argp); 714de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 715de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(IdentifierInfo *II, const RetainSummary * Summ, ...) { 718de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 719de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 720de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(II, ObjCClassMethodSummaries, Summ, argp); 721de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 722de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 723de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7246b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 7251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7269c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummaryManager(ASTContext &ctx, bool gcenabled, bool usesARC) 727179064eb831125630c296556dd6d67e67f716143Ted Kremenek : Ctx(ctx), 728f85e193739c953358c865005855253af4f68a497John McCall GCEnabled(gcenabled), 729f85e193739c953358c865005855253af4f68a497John McCall ARCEnabled(usesARC), 730f85e193739c953358c865005855253af4f68a497John McCall AF(BPAlloc), ScratchArgs(AF.getEmptyMap()), 731f85e193739c953358c865005855253af4f68a497John McCall ObjCAllocRetE(gcenabled 732f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 733f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 734f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwned(RetEffect::ObjC, true))), 735f85e193739c953358c865005855253af4f68a497John McCall ObjCInitRetE(gcenabled 736f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 737f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 738ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose : RetEffect::MakeOwnedWhenTrackedReceiver())) { 739553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeClassMethodSummaries(); 740553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeMethodSummaries(); 741553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 7421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 74358822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks const RetainSummary *getSummary(const FunctionDecl *FD, 74458822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks const CallOrObjCMessage *CME = 0); 7451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 746f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *getMethodSummary(Selector S, IdentifierInfo *ClsName, 747f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCInterfaceDecl *ID, 748f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, 749f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose QualType RetTy, 750f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries); 751f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 75293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 7538bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state, 75493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const LocationContext *LC); 755dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 7560507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 75793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCInterfaceDecl *ID) { 758f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose return getMethodSummary(msg.getSelector(), 0, ID, msg.getMethodDecl(), 759f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose msg.getType(Ctx), ObjCMethodSummaries); 7608711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 7611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 76293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getClassMethodSummary(const ObjCMessage &msg) { 763432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const ObjCInterfaceDecl *Class = 0; 764432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis if (!msg.isInstanceMessage()) 765432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis Class = msg.getReceiverInterface(); 76604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 767f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose return getMethodSummary(msg.getSelector(), Class->getIdentifier(), 768f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Class, msg.getMethodDecl(), msg.getType(Ctx), 769f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCClassMethodSummaries); 770fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek } 771552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek 772552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// getMethodSummary - This version of getMethodSummary is used to query 773552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// the summary for the current method being analyzed. 77493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getMethodSummary(const ObjCMethodDecl *MD) { 775a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek // FIXME: Eventually this should be unneeded. 776a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID = MD->getClassInterface(); 77770a6576c9c8d21ff2361574f4937a2e73bd57779Ted Kremenek Selector S = MD->getSelector(); 778552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek IdentifierInfo *ClsName = ID->getIdentifier(); 779552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek QualType ResultTy = MD->getResultType(); 7801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 781f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy *CachedSummaries; 782552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek if (MD->isInstanceMethod()) 783f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCMethodSummaries; 784552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek else 785f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCClassMethodSummaries; 786f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 787f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose return getMethodSummary(S, ClsName, ID, MD, ResultTy, *CachedSummaries); 788552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek } 7891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 790f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *getStandardMethodSummary(const ObjCMethodDecl *MD, 79193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Selector S, QualType RetTy); 792a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek 79393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7944dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD); 7954dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 79693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7974dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD); 7984dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 799d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek bool isGCEnabled() const { return GCEnabled; } 8001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 801f85e193739c953358c865005855253af4f68a497John McCall bool isARCEnabled() const { return ARCEnabled; } 802f85e193739c953358c865005855253af4f68a497John McCall 803f85e193739c953358c865005855253af4f68a497John McCall bool isARCorGCEnabled() const { return GCEnabled || ARCEnabled; } 8046b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 8051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8060fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// Used to avoid allocating long-term (BPAlloc'd) memory for default retain 8070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// summaries. If a function or method looks like it has a default summary, but 8080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// it has annotations, the annotations are added to the stack-based template 8090fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// and then copied into managed memory. 8100fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Roseclass RetainSummaryTemplate { 8110fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &Manager; 81293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *&RealSummary; 8130fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary ScratchSummary; 8140fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose bool Accessed; 8150fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rosepublic: 816e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetainSummaryTemplate(const RetainSummary *&real, const RetainSummary &base, 817e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetainSummaryManager &mgr) 818e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose : Manager(mgr), RealSummary(real), ScratchSummary(real ? *real : base), 81993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Accessed(false) {} 8200fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8210fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose ~RetainSummaryTemplate() { 82293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek if (Accessed) 823ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RealSummary = Manager.getPersistentSummary(ScratchSummary); 8240fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8250fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8260fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary &operator*() { 8270fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 82893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return ScratchSummary; 8290fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8310fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *operator->() { 8320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 83393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return &ScratchSummary; 8340fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8350fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose}; 8360fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8376b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end anonymous namespace 8386b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 8396b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8406b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek// Implementation of checker data structures. 8416b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8426b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 843b77449cead63264650958c92cb30609c942cc5e9Ted KremenekArgEffects RetainSummaryManager::getArgEffects() { 844b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects AE = ScratchArgs; 8453baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.getEmptyMap(); 846b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return AE; 84700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 84800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 84993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 850ef94588752babc1b7c46b955e57945fc4c183db2Jordy RoseRetainSummaryManager::getPersistentSummary(const RetainSummary &OldSumm) { 851ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose // Unique "simple" summaries -- those without ArgEffects. 852ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (OldSumm.isSimple()) { 853ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSetNodeID ID; 854ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose OldSumm.Profile(ID); 855ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 856ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void *Pos; 857ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose CachedSummaryNode *N = SimpleSummaries.FindNodeOrInsertPos(ID, Pos); 858ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 859ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (!N) { 860ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose N = (CachedSummaryNode *) BPAlloc.Allocate<CachedSummaryNode>(); 861ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (N) CachedSummaryNode(OldSumm); 862ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose SimpleSummaries.InsertNode(N, Pos); 863ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 864ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 865ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return &N->getValue(); 866ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 867ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 86893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 869ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (Summ) RetainSummary(OldSumm); 87000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek return Summ; 87100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 87200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 873d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 874d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for functions (largely uses of Core Foundation). 875d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 87600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 8779c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRetain(const FunctionDecl *FD, StringRef FName) { 878b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Retain"); 8791261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8801261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 8819c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRelease(const FunctionDecl *FD, StringRef FName) { 882b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Release"); 8831261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8841261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 88576c506fba2359296d1f19e64998bd11d7b864563Jordy Rosestatic bool isMakeCollectable(const FunctionDecl *FD, StringRef FName) { 88676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Remove FunctionDecl parameter. 88776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Is it really okay if MakeCollectable isn't a suffix? 88876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return FName.find("MakeCollectable") != StringRef::npos; 88976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 89076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 89158822c403cc8855adeecba92248612ee08dc1f3aAnna Zaksconst RetainSummary * 89258822c403cc8855adeecba92248612ee08dc1f3aAnna ZaksRetainSummaryManager::getSummary(const FunctionDecl *FD, 89358822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks const CallOrObjCMessage *CME) { 894891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 895d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 896d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 897891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 898891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 899e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 90093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *S = 0; 9011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 90237d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 9031261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 9041261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 9051261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 9061261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 9071261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 9089ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // For C++ methods, generate an implicit "stop" summary as well. We 9099ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // can relax this once we have a clear policy for C++ methods and 9109ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // ownership attributes. 9119ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek if (isa<CXXMethodDecl>(FD)) { 9129ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek S = getPersistentStopSummary(); 9139ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek break; 9149ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek } 9151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 916183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 91799890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 918183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 91948c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 92048c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 92148c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 922b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 923b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 9241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 925bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 926bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 927b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 9281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9291261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 9301261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 9311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9321261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 9331261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 934008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 935e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 936befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek if (FName == "pthread_create" || FName == "pthread_setspecific") { 937befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // Part of: <rdar://problem/7299394> and <rdar://problem/11282706>. 938befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // This will be addressed better with IPA. 939b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 940b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 941b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 942b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 943b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 944b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 945b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 946b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 947b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 948537dd3a8c87765245aad792a3356852a87380a30Ted Kremenek FName == "IORegistryEntrySearchCFProperty" || 949b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 950b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 951b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 952b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 953b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 954b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 955b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 956b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 957b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 958b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 959b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 9603baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 961b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 962b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 963b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 964b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 965b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 9663baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 967b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 968b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 969b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 970b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 971b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 972b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 973b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 974b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 9753baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 976b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 977b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 978b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 979b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 980b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 981b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 9823baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 983b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 984b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 985b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 986b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 987b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 988b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 989b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 990b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 9913baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 992b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 99306911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek } else if (FName == "dispatch_set_context") { 99406911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // <rdar://problem/11059275> - The analyzer currently doesn't have 99506911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // a good way to reason about the finalizer function for libdispatch. 99606911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // If we pass a context object that is memory managed, stop tracking it. 99706911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // FIXME: this hack should possibly go away once we can handle 99806911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // libdispatch finalizers. 99906911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 100006911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1001c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } else if (FName.startswith("NSLog")) { 1002c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek S = getDoNothingSummary(); 100362a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks } else if (FName.startswith("NS") && 100462a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks (FName.find("Insert") != StringRef::npos)) { 100562a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // Whitelist NSXXInsertXX, for example NSMapInsertIfAbsent, since they can 100662a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // be deallocated by NSMapRemove. (radar://11152419) 100762a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 100862a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 2, StopTracking); 100962a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 101058822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks } else if (CME && CME->hasNonZeroCallbackArg()) { 101141a669a30074dcc221ba199e5dde484cc33adba1Anna Zaks // Allow objects to escape through callbacks. radar://10973977 101241a669a30074dcc221ba199e5dde484cc33adba1Anna Zaks S = getPersistentStopSummary(); 1013b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 10141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1015b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 1016b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 1017b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 101861991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 101961991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Enable this code once the semantics of NSDeallocateObject are resolved 102061991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // for GC. <rdar://problem/6619988> 102161991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#if 0 102261991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Handle: NSDeallocateObject(id anObject); 102361991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // This method does allow 'nil' (although we don't check it now). 10241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (strcmp(FName, "NSDeallocateObject") == 0) { 102561991903335144605031c3597a5c99e1565b0bd4Ted Kremenek return RetTy == Ctx.VoidTy 102661991903335144605031c3597a5c99e1565b0bd4Ted Kremenek ? getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, Dealloc) 102761991903335144605031c3597a5c99e1565b0bd4Ted Kremenek : getPersistentStopSummary(); 102861991903335144605031c3597a5c99e1565b0bd4Ted Kremenek } 102961991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#endif 10301261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10311261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (RetTy->isPointerType()) { 10321261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 103378acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 10341261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10351261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 103676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 10371261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 10381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 10397df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10401261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 104137d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 104237d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10431261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10441261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 104578acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 10461261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10471261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 10481261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 10497df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10501261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 105137d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 105237d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10531261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10541261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 105578acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 105678acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 105778acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 10587df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1059706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1060706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 10611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10621261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 106337d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10641261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10651261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 10661261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 10671261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1068e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1069b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1070e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1071bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 10721261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 10731261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1074b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 10756818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 10766818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 10776818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 10786818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 10796818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 10816818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 10821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 10836818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 10846818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10856818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1086c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1087c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1088c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1089c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1090e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1091e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1092e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1093e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1094c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 10956818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 10961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10976818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 10981261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 109964e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 110037d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 110137d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 11021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11034dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 11044df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(S, FD); 11051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1106d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 11071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 11082fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 11092fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 111093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11117df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 11127df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 111386ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 11141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1115d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 111600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 111700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 111893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11196ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 11206ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 11216ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 11221261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 11231261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 112472564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 11251261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 11261261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 11271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1128b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 113076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1131377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 113276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 113376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 113476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 1135940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 113676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 113776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 113876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 113900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 114000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 114193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11429c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1143b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11452d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 114600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 114700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 114893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11499c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 11501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 11512d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 11522d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 115300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 115400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 11556b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1156d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1157d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1158d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 11594dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 116093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 11614dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 11624dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 11634dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11644dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 1165ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummaryTemplate Template(Summ, *getDefaultSummary(), *this); 11664df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 116711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 116811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 116911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 117098b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 117111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 117211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 11734df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 11740fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 11754df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 11764df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 11770fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 117811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 117911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 118011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1181b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 11821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11834dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 118478acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 118540b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 11860fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 11874dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 118840b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 11890fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1190b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 11916041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>()) { 11920fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 11936041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11946041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11950fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 11966041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11974df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (RetTy->getAs<PointerType>()) { 119840b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 11990fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 12004dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1201d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 12020fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1203d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 12044dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 12054dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 12064dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 12074dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 120893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 120993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD) { 12104dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 12114dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 12124dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 1213ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummaryTemplate Template(Summ, *getDefaultSummary(), *this); 12146d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 12151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 121612b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 121712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 121811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12190fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 122011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 122111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 122211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 122311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1224491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1225491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 122611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 122711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 122811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 122911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 123111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 123211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 12330fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 123411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 123512b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 123612b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 12374dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 123878acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 123940b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 12400fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 12416d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 12424dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 12436041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>()) { 12440fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 12456041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 12466041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12486d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 12490fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 12506217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 12510fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 12521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12536041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 12546041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 12550fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 12566041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 12570fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 12586041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12594dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 12604dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 126193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1262f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy RoseRetainSummaryManager::getStandardMethodSummary(const ObjCMethodDecl *MD, 1263f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Selector S, QualType RetTy) { 12648ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek 1265fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek if (MD) { 1266376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Scan the method decl for 'void*' arguments. These should be treated 1267376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // as 'StopTracking' because they are often used with delegates. 1268376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Delegates are a frequent form of false positives with the retain 1269376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // count checker. 1270376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek unsigned i = 0; 1271491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator I = MD->param_begin(), 1272376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek E = MD->param_end(); I != E; ++I, ++i) 1273491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis if (const ParmVarDecl *PD = *I) { 1274376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek QualType Ty = Ctx.getCanonicalType(PD->getType()); 1275a4923eb7c4b04d360cb2747641a5e92818edf804Douglas Gregor if (Ty.getLocalUnqualifiedType() == Ctx.VoidPtrTy) 12763baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, i, StopTracking); 1277376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 1278376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 12791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1280e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Any special effects? 12818ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 1282e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetEffect ResultEff = RetEffect::MakeNoRet(); 1283e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose 1284e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Check the method family, and apply any default annotations. 1285e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (MD ? MD->getMethodFamily() : S.getMethodFamily()) { 1286e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_None: 1287e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_performSelector: 1288e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Assume all Objective-C methods follow Cocoa Memory Management rules. 1289e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // FIXME: Does the non-threaded performSelector family really belong here? 1290e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // The selector could be, say, @selector(copy). 1291e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1292e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::ObjC); 1293e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) { 1294e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // ObjCMethodDecl currently doesn't consider CF objects as valid return 1295e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // values for alloc, new, copy, or mutableCopy, so we have to 1296e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // double-check with the selector. This is ugly, but there aren't that 1297e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // many Objective-C methods that return CF objects, right? 1298e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (MD) { 1299e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (S.getMethodFamily()) { 1300e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1301e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1302e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1303e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1304e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1305e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1306e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose default: 1307e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1308e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1309e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1310e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } else { 1311e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1312e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1313e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1314e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1315e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_init: 1316e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCInitRetE; 1317e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1318e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1319e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1320e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1321e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1322e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1323e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1324e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCAllocRetE; 1325e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) 1326e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1327e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1328e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_autorelease: 1329e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Autorelease; 1330e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1331e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retain: 1332e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = IncRefMsg; 1333e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1334e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_release: 1335e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1336e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1337e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_dealloc: 1338e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Dealloc; 1339e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1340e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_self: 1341e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // -self is handled specially by the ExprEngine to propagate the receiver. 1342e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1343e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retainCount: 1344e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_finalize: 1345e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // These methods don't return objects. 1346e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1347e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 13481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13498ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 13508ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 13518ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 13528ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 13538ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 135450571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose for (unsigned i = 0, e = S.getNumArgs(); i != e; ++i) { 135550571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose StringRef Slot = S.getNameForSlot(i); 135650571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (Slot.substr(Slot.size() - 8).equals_lower("delegate")) { 135750571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (ResultEff == ObjCInitRetE) 135850571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose ResultEff = RetEffect::MakeNoRet(); 135950571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose else 136050571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose ReceiverEff = StopTracking; 136150571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 136250571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 13638ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 13641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1365e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing && 1366e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff.getKind() == RetEffect::NoRet) 136793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 13681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1369e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose return getPersistentSummary(ResultEff, ReceiverEff, MayEscape); 1370250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1371250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 137293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1373432424d67641d609e4990d791baa782fc161027eArgyrios KyrtzidisRetainSummaryManager::getInstanceMethodSummary(const ObjCMessage &msg, 13748bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state, 1375b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek const LocationContext *LC) { 1376b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1377b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // We need the type-information of the tracked receiver object 1378b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Retrieve it from the state. 1379432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const Expr *Receiver = msg.getInstanceReceiver(); 13809c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID = 0; 1381b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1382b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: Is this really working as expected? There are cases where 1383b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we just use the 'ID' from the message expression. 138404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor SVal receiverV; 138504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 13868f326751df18e78bdb7edf786a842def8a4f41e3Ted Kremenek if (Receiver) { 13875eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek receiverV = state->getSValAsScalarOrLoc(Receiver, LC); 1388dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 138904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Eventually replace the use of state->get<RefBindings> with 139004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // a generic API for reasoning about the Objective-C types of symbolic 139104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // objects. 139204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (SymbolRef Sym = receiverV.getAsLocSymbol()) 139304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const RefVal *T = state->get<RefBindings>(Sym)) 1394dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek if (const ObjCObjectPointerType* PT = 1395b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 139604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 1397dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 139804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: this is a hack. This may or may not be the actual method 139904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // that is called. 140004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (!ID) { 140104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const ObjCObjectPointerType *PT = 140204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Receiver->getType()->getAs<ObjCObjectPointerType>()) 140304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 140404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } 140504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } else { 140604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Hack for 'super'. 1407432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis ID = msg.getReceiverInterface(); 1408b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 140904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1410b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1411b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 14124df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return getInstanceMethodSummary(msg, ID); 1413b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1414b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 141593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1416f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy RoseRetainSummaryManager::getMethodSummary(Selector S, IdentifierInfo *ClsName, 1417f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCInterfaceDecl *ID, 1418f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, QualType RetTy, 1419f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries) { 14201bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 14218711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 1422f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *Summ = CachedSummaries.find(ID, ClsName, S); 14231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1424614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1425f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Summ = getStandardMethodSummary(MD, S, RetTy); 14264df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1427614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 14284df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 14294df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1430614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 1431f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries[ObjCSummaryKey(ID, ClsName, S)] = Summ; 1432614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 14331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1434e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1435c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1436c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 14371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1438ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 14391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 14406fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 14412d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 14421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14436d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 14443baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 14456fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 14466fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 14476fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 14481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1449de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // Create the summaries for [NSObject performSelector...]. We treat 1450de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // these as 'stop tracking' for the arguments because they are often 1451de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // used for delegates that can release the object. When we have better 1452de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // inter-procedural analysis we can potentially do something better. This 1453de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // workaround is to remove false positives. 145493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = 1455012614ecf78442368ec82ee30efb3bc047b413e6Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, StopTracking); 1456de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek IdentifierInfo *NSObjectII = &Ctx.Idents.get("NSObject"); 1457de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1458de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", NULL); 1459de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1460de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", "inModes", NULL); 1461de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1462de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1463de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1464de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1465de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1466de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1467de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1468de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1469de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorInBackground", 1470de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", NULL); 14719c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 14729c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 14731f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 14741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 14761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1477c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1478c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 147993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1480ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1481ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1482ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1483ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1484ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1485ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 14861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1487c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 148893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 148993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *CFAllocSumm = 1490a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 14911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14923c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1493500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 149493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1495553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 14961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14973c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1498500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1499553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 15001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1501299e8158d63d69830cca0187f4003cba1e66081fTed Kremenek // Create the "drain" selector. 1502500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, isGCEnabled() ? DoNothing : DecRef); 1503553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); 15041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1505f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1506500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1507f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 15083c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 15093c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1510500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1511553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 15121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1513f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek // Specially handle NSAutoreleasePool. 15146c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek addInstMethSummary("NSAutoreleasePool", "init", 1515500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose getPersistentSummary(NoRet, NewAutoreleasePool)); 15161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 151889e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 151989e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 152089e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 152189e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 15223aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 152393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 152478a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 152578a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 15261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 152799d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 152899d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 15293aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#if 0 153078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1531af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 153378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1534af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 15353aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#endif 15361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1537179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1538179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 153999d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 154099d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 154199d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 15421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 154378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#if 0 154478a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1545af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 154778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1548af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 154978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#endif 15501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1551ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // Don't track allocated autorelease pools yet, as it is okay to prematurely 1552ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1553ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1554a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek addClassMethSummary("NSAutoreleasePool", "allocWithZone", NoTrackYet, false); 1555553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1556767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1557767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1558767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1559767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1560767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1561767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1562211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1563a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1564a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1565a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1566767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1567a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 15681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1569a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1570211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1571b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1572b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1573d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 15744d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek// AutoreleaseBindings - State used to track objects in autorelease pools. 15756d34893fc886f4153f104de8880876764981cb7fTed Kremenek//===----------------------------------------------------------------------===// 15766d34893fc886f4153f104de8880876764981cb7fTed Kremenek 15774d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, unsigned> ARCounts; 15784d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, ARCounts> ARPoolContents; 15794d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableList<SymbolRef> ARStack; 1580f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek 15814d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenekstatic int AutoRCIndex = 0; 15826d34893fc886f4153f104de8880876764981cb7fTed Kremenekstatic int AutoRBIndex = 0; 15836d34893fc886f4153f104de8880876764981cb7fTed Kremenek 1584ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleasePoolContents {}; } 1585ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleaseStack {}; } 15864d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 15876d34893fc886f4153f104de8880876764981cb7fTed Kremeneknamespace clang { 15889ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 158918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleaseStack> 159018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARStack> { 15919c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRBIndex; } 15924d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15934d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 159418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleasePoolContents> 159518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARPoolContents> { 15969c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRCIndex; } 15974d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15985a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 15994d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek} // end clang namespace 16006d34893fc886f4153f104de8880876764981cb7fTed Kremenek 16018bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic SymbolRef GetCurrentAutoreleasePool(ProgramStateRef state) { 16027037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARStack stack = state->get<AutoreleaseStack>(); 16037037ab8f15950e594642adf77a56d299667debe7Ted Kremenek return stack.isEmpty() ? SymbolRef() : stack.getHead(); 16047037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 16057037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 16068bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic ProgramStateRef 16078bef8238181a30e52dea380789a7e2d760eac532Ted KremenekSendAutorelease(ProgramStateRef state, 160818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ARCounts::Factory &F, 160918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek SymbolRef sym) { 16107037ab8f15950e594642adf77a56d299667debe7Ted Kremenek SymbolRef pool = GetCurrentAutoreleasePool(state); 1611b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const ARCounts *cnts = state->get<AutoreleasePoolContents>(pool); 16127037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARCounts newCnts(0); 16131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 16147037ab8f15950e594642adf77a56d299667debe7Ted Kremenek if (cnts) { 16157037ab8f15950e594642adf77a56d299667debe7Ted Kremenek const unsigned *cnt = (*cnts).lookup(sym); 16163baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(*cnts, sym, cnt ? *cnt + 1 : 1); 16177037ab8f15950e594642adf77a56d299667debe7Ted Kremenek } 16187037ab8f15950e594642adf77a56d299667debe7Ted Kremenek else 16193baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(F.getEmptyMap(), sym, 1); 16201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1621b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek return state->set<AutoreleasePoolContents>(pool, newCnts); 16227037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 16237037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 16241392261ff4418a070fb919cb4832b76b468b6faaTed Kremenek//===----------------------------------------------------------------------===// 1625c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1626c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1627c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1628ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1629ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1630ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1631c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1632c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 16331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 16341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1635ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1636c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 163735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 16386fd4505ad67a186da8cc26fdb493c93fe4937555Ted Kremenek : BugType(name, categories::MemoryCoreFoundationObjectiveC) {} 1639c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1641c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 164235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 16431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1644c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1645c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1647ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1648c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 164935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 165135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1652c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1654c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1656ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1657c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 165835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 16591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 166035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1661bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1662bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1663b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1664c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1666ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1667c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 166835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 166935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 16701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1671c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1672369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 16731499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1674c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1676ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1677c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 167835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 167935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 16801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1681c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1682c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 168300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 16841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1686ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1687369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 168835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 168935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 16901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1691369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1692eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1693369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1694369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 16951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1696ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1697e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 169835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 169935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 17001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1701e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 17025b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1703e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1704e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1705e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 17061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1707ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1708facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer public: 1709facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer Leak(StringRef name) 1710facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer : CFRefBug(name) { 1711db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1712db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1713db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 17141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 171535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 17161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1717c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1718c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1720c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1721c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1722c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 17231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1724011534973e83db51f49098871186238fc64d5f54Jordy Rose class CFRefReportVisitor : public BugReporterVisitorImpl<CFRefReportVisitor> { 172523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1726dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1727ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 172835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 172923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1730dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 173135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 173235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1733dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 173423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1735dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1736dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1737dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1738dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1739dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 174023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 174123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 174223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 174323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 174423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 174523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 174623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 174723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 174823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 174923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 175023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 175123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 175235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1753ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 175435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 175523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 175623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 175723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 175823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1759011534973e83db51f49098871186238fc64d5f54Jordy Rose 1760011534973e83db51f49098871186238fc64d5f54Jordy Rose virtual BugReporterVisitor *clone() const { 1761011534973e83db51f49098871186238fc64d5f54Jordy Rose // The curiously-recurring template pattern only works for one level of 1762011534973e83db51f49098871186238fc64d5f54Jordy Rose // subclassing. Rather than make a new template base for 1763011534973e83db51f49098871186238fc64d5f54Jordy Rose // CFRefReportVisitor, we simply override clone() to do the right thing. 1764011534973e83db51f49098871186238fc64d5f54Jordy Rose // This could be trouble someday if BugReporterVisitorImpl is ever 1765011534973e83db51f49098871186238fc64d5f54Jordy Rose // used for something else besides a convenient implementation of clone(). 1766011534973e83db51f49098871186238fc64d5f54Jordy Rose return new CFRefLeakReportVisitor(*this); 1767011534973e83db51f49098871186238fc64d5f54Jordy Rose } 1768dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1769dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1770e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 17712058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 177235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1773c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17742058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17752058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17762058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1777edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 177823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 17792058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17802058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1781dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1782eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 17832058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17842058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17852058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1786edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 17872058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17882058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1789dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 17901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1791e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1792edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1793edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1794e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1795c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1796640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1797c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1798c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1799eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1800ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1801c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 180223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1803c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 18042058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 18052058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 18066a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx); 18071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1808590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1809590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1810590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1811590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 18121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 18135216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 18145216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 18152058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 18162058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1817f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 18181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1819e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 18207f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 18212058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 182235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 182335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18257f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 18262058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 182735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 182835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18307f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 18312058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 183235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 183335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 183435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 183535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 183635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 183735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 183835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 183935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 184035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18417f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1842c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 184335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1844f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 184535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1846c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1847e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1848910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18495f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1850c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18515f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1852c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1853c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 18541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1855c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1856c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1857c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 185870fdbc366da85880aae5baebd3351e993ca05603Jordy Rosestatic bool isNumericLiteralExpression(const Expr *E) { 185970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // FIXME: This set of cases was copied from SemaExprObjC. 186070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose return isa<IntegerLiteral>(E) || 186170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CharacterLiteral>(E) || 186270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<FloatingLiteral>(E) || 186370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<ObjCBoolLiteralExpr>(E) || 186470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CXXBoolLiteralExpr>(E); 186570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 186670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 18674c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenekstatic bool isPropertyAccess(const Stmt *S, ParentMap &PM) { 18684c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek unsigned maxDepth = 4; 18694c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek while (S && maxDepth) { 18704c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek if (const PseudoObjectExpr *PO = dyn_cast<PseudoObjectExpr>(S)) { 18714c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek if (!isa<ObjCMessageExpr>(PO->getSyntacticForm())) 18724c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return true; 18734c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return false; 18744c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek } 18754c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek S = PM.getParent(S); 18764c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek --maxDepth; 18774c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek } 18784c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return false; 18794c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek} 18804c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek 1881dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1882dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1883dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1884dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 18851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1886f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<StmtPoint>(N->getLocation())) 18872033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 18881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18898966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 18908bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef PrevSt = PrevN->getState(); 18918bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef CurrSt = N->getState(); 18925eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = N->getLocationContext(); 18931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const RefVal* CurrT = CurrSt->get<RefBindings>(Sym); 1895c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 18961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1897b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 1898b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal *PrevT = PrevSt->get<RefBindings>(Sym); 18991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1900c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1901c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1902c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1903c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 19041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1905c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1906c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1907c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 1908f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (isa<ObjCArrayLiteral>(S)) { 19111a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSArray literal is an object with a +0 retain count"; 19121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 19131a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else if (isa<ObjCDictionaryLiteral>(S)) { 19141a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSDictionary literal is an object with a +0 retain count"; 1915c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 191670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else if (const ObjCBoxedExpr *BL = dyn_cast<ObjCBoxedExpr>(S)) { 191770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (isNumericLiteralExpression(BL->getSubExpr())) 191870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "NSNumber literal is an object with a +0 retain count"; 191970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else { 192070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ObjCInterfaceDecl *BoxClass = 0; 192170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (const ObjCMethodDecl *Method = BL->getBoxingMethod()) 192270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose BoxClass = Method->getClassInterface(); 192370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 192470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // We should always be able to find the boxing class interface, 192570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // but consider this future-proofing. 192670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (BoxClass) 192770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << *BoxClass << " b"; 192870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else 192970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "B"; 193070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 193170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "oxed expression produces an object with a +0 retain count"; 193270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 193370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 19341a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19351a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 19361a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Get the name of the callee (if it is available). 19371a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee(), LCtx); 19381a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 19391a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "Call to function '" << *FD << '\''; 19401a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else 19411a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "function call"; 19421a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19431a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19441a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(isa<ObjCMessageExpr>(S)); 19451a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // The message expression may have between written directly or as 19461a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // a property access. Lazily determine which case we are looking at. 19471a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << (isPropertyAccess(S, N->getParentMap()) ? "Property" : "Method"); 19481a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19501a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 19511a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns a Core Foundation object with a "; 19521a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19531a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19541a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 19551a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns an Objective-C object with a "; 19561a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19581a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.isOwned()) { 19591a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+1 retain count"; 19601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19611a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (GCEnabled) { 19621a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 19631a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << ". " 19641a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek "Core Foundation objects are not automatically garbage collected."; 19651a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19661a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19671a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19681a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.isNotOwned()); 19691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+0 retain count"; 1970c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1971cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1973220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 1974220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 1975c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 1976cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1978c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 1979c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 19805f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 19811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1982ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 1983ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 1984c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 1985c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 1986f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19885f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1989c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 1990c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 1991c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 19921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19935f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 1994c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 19951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1996c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 1997c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 19985eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI, LCtx).getAsLocSymbol() != Sym) 1999c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 20001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2001c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 2002c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 2003c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2004c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 200604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 20075eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver, LCtx) 20085eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek .getAsLocSymbol() == Sym) { 2009c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 2010c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 2011c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2012c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20131c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 20141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2015c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 2016c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 2017c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 20181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2019c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 202035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 2021c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2022c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 2023c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 2024c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 2025c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2026f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 2027c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 2028f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 2029f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 2030c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2032c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 2033c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 2034c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 2035f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 20365eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = 20375eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee(), LCtx); 20389c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 20391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 204035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 2041c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2042c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 20431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2044b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "In GC mode a call to '" << *FD 2045c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 2046c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 20471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2048c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2049c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 2050c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 2051c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 2052c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2053c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2054c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 2055c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 2056c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 20573eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 20581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 2059b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "When GC is not enabled a call to '" << *FD 2060c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 20611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2062c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 2063c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2064c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 2067c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 2068c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 20691ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 20701ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 20711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2072f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 2073f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 2074f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 2075f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 20761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2077264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 2078eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 2079f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 2080f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 20811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2082c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 2083c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 2084c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2085c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 20861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2087c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 2088c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 20891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2090c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 209135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 209274b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << " The object is not eligible for garbage collection until " 209374b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "the retain count reaches 0 again."; 2094c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2096c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20981ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2099c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 21001ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 21011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2102c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 210374b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose // Autoreleases can be applied after marking a node ReturnedOwned. 210474b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose if (CurrV.getAutoreleaseCount()) 210574b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose return NULL; 210674b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose 210774b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << "Object returned to caller as an owning reference (single " 210874b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "retain count transferred to caller)"; 2109c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2111c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2112f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2113c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2115c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2116c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2117c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2119c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 21205f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2121c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 21221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2123c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 212435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2125c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2126c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2127c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2128c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2129c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2130c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2131c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2132c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2133c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2134c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2135c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2136c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2137c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 21391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2140c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2141c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 21422033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 2143f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 2144220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2145220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 21469c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 21471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2148c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2149c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 21501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 21515f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 21529c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 21535eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp, LCtx).getAsLocSymbol() == Sym) { 2154c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2155c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2156c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2158c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2159c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2160c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2161e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// Find the first node in the current function context that referred to the 2162e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// tracked symbol and the memory location that value was stored to. Note, the 2163e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// value is only reported if the allocation occurred in the same function as 2164e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// the leak. 2165c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 216618c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2167c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 21689c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 21691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 2170e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks const LocationContext *LeakContext = N->getLocationContext(); 21711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2172c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 21738bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St = N->getState(); 2174c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefBindings B = St->get<RefBindings>(); 21751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2176c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!B.lookup(Sym)) 2177940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 21781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 217927b867ea1c9cb4b40f9b817c303d6df3ee753da9Anna Zaks StoreManager::FindUniqueBinding FB(Sym); 21801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 21811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 21821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2183e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // Allocation node, is the last node in the current context in which the 2184e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // symbol was tracked. 2185e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() == LeakContext) 2186e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks Last = N; 2187e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 21881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 21891ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 21901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2191e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // If allocation happened in a function different from the leak node context, 2192e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // do not report the binding. 2193e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() != LeakContext) { 2194e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks FirstBinding = 0; 2195e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks } 2196e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 2197c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 21986b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 21996b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2200c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 220123f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 220223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 220323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 220476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 220523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2206c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2207fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2208c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 220923f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 221023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 221123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 22121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22138966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2214c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 221576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 22161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2217c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2218c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2219c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 22209c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2221c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 22221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2223c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2224f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 22251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22264fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 22271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2228c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2229c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2230c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 22319c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 22324fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 22331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2234c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2235c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 22361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2237f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 22381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2239f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2240f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2241f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2242f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2243f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2244f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 22451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2246c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 2247c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const RefVal* RV = EndN->getState()->get<RefBindings>(Sym); 22481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2249c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2250c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 22515b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2252c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2253d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2254d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2255d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek os << " is returned from a method whose name ('" 2256d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << MD->getSelector().getAsString() 2257d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 22585b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose " This violates the naming convention rules" 2259f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " given in the Memory Management Guide for Cocoa"; 2260d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2261d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2262d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2263b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek os << " is returned from a function whose name ('" 2264a59d20b135bfde058a5a69045bab5ec4e2553f74Benjamin Kramer << *FD 2265d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 2266b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek " convention rules given in the Memory Management Guide for Core" 2267f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " Foundation"; 2268d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2269c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2270e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 22719c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2272e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 227382f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 227482f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 227582f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 227682f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2277e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2278c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2279abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2280f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 22811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2282c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2283c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2284cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 22852058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 22862058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 22872058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 22886a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx) 22892058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 22901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2291fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2292c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2293c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2294c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2295c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2296c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2297c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2298c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 22999c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 23001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23016a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const SourceManager& SMgr = Ctx.getSourceManager(); 2302590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2303c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 23046a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks GetAllocationSite(Ctx.getStateManager(), getErrorNode(), sym); 23051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2306c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2307c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 2308590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks const Stmt *AllocStmt = cast<PostStmt>(P).getStmt(); 2309590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2310590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2311c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2312c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2313c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2314dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 23152058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2316dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2317212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << "of an object"; 23181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2319c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2320c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2321212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << " stored into '" << AllocBinding->getString() << '\''; 2322dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 23232058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2324c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2325c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2326c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2327c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2328c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2329c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2330d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2331910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 23329c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 233338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 23349c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 233538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::EndPath, 23366704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2337f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 2338294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostStmt<CallExpr>, 2339537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose check::PostStmt<CXXConstructExpr>, 23401a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCArrayLiteral>, 23411a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCDictionaryLiteral>, 234270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose check::PostStmt<ObjCBoxedExpr>, 2343294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostObjCMessage, 2344f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 23456704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 234676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 234776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 23486f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 23496f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 23506f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 23516f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 23526f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 235338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 235438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 235538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 235638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 235738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 235838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23596f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> Summaries; 23606f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> SummariesGC; 2361b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 2362e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose mutable ARCounts::Factory ARCountFactory; 2363e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 23649c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 23659c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 23669c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23672f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2368910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 236938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2370910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 237138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 237238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 237338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23749c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 23759c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 23769c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 23779c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 23789c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 23799c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 23809c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 23819c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 23829c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 23839c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 23849c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 23851ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23861ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 23871ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 23881ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 23891ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 23901ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23919c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 23929c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 23939c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 23949c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 23951ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23969c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 23979c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 23989c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 23999c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 24019c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 24029c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 24039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 24049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 24059c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 24069c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24079c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 24081ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 24091ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 241017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 241117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 241217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2413db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2414facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunctionGC.reset(new Leak("Leak of object when using " 2415facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 241617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2417db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2418db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2419e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2420facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak of object when not using " 2421facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in " 2422facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "dual GC/non-GC code")); 2423db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2424facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak")); 2425db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2426db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 242717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunction.get(); 2428db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2429db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2430db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 243117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakAtReturnBug(const LangOptions &LOpts, bool GCEnabled) const { 243217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2433db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturnGC) 2434facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturnGC.reset(new Leak("Leak of returned object when using " 2435facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 243617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2437db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2438db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2439e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2440facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object when not using " 2441facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in dual " 2442facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "GC/non-GC code")); 2443db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2444facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object")); 2445db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2446db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 244717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturn.get(); 2448db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2449db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2450db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 245117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(ASTContext &Ctx, 245217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 245317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // FIXME: We don't support ARC being turned on and off during one analysis. 245417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // (nor, for that matter, do we support changing ASTContexts) 24554e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie bool ARCEnabled = (bool)Ctx.getLangOpts().ObjCAutoRefCount; 245617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 245717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!SummariesGC) 2458b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose SummariesGC.reset(new RetainSummaryManager(Ctx, true, ARCEnabled)); 245917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 246017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(SummariesGC->isARCEnabled() == ARCEnabled); 2461b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *SummariesGC; 2462b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } else { 246317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!Summaries) 2464b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose Summaries.reset(new RetainSummaryManager(Ctx, false, ARCEnabled)); 246517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 246617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(Summaries->isARCEnabled() == ARCEnabled); 2467b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *Summaries; 2468b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2469b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2470b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 247117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(CheckerContext &C) const { 247217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return getSummaryManager(C.getASTContext(), C.isObjCGCEnabled()); 247317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 247417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 24758bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void printState(raw_ostream &Out, ProgramStateRef State, 2476dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const char *NL, const char *Sep) const; 2477dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 2478390909c89c98ab1807e15e033a72e975f866fb23Anna Zaks void checkBind(SVal loc, SVal val, const Stmt *S, CheckerContext &C) const; 2479ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const; 2480ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const CastExpr *CE, CheckerContext &C) const; 2481f85e193739c953358c865005855253af4f68a497John McCall 2482294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostStmt(const CallExpr *CE, CheckerContext &C) const; 2483537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose void checkPostStmt(const CXXConstructExpr *CE, CheckerContext &C) const; 24841a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCArrayLiteral *AL, CheckerContext &C) const; 24851a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCDictionaryLiteral *DL, CheckerContext &C) const; 248670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose void checkPostStmt(const ObjCBoxedExpr *BE, CheckerContext &C) const; 248770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2488294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostObjCMessage(const ObjCMessage &Msg, CheckerContext &C) const; 24891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 2490294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkSummary(const RetainSummary &Summ, const CallOrObjCMessage &Call, 2491e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2492294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 249376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 249476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 24958bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond, 2496ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 24976704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 24988bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 24998bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek checkRegionChanges(ProgramStateRef state, 2500537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 2501537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 250266c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 250366c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks const CallOrObjCMessage *Call) const; 2504ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 25058bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool wantsRegionChangeUpdate(ProgramStateRef state) const { 25062f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2507ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2508294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2509f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2510f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2511f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 25128bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek SymbolRef Sym, ProgramStateRef state) const; 2513f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 251438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 2515af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks void checkEndPath(CheckerContext &C) const; 251638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25178bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef updateSymbol(ProgramStateRef state, SymbolRef sym, 251817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 251917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CheckerContext &C) const; 2520e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 25218bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void processNonLeakError(ProgramStateRef St, SourceRange ErrorRange, 2522294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2523294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 25241a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25251a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void processObjCLiterals(CheckerContext &C, const Expr *Ex) const; 2526294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 252738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 252838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25298bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef handleSymbolDeath(ProgramStateRef state, 253038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef sid, RefVal V, 253138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const; 253238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25338bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ExplodedNode *, ProgramStateRef > 25348bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek handleAutoreleaseCounts(ProgramStateRef state, 25358d22863184419faa2348bd5148c663197bc4bb00Jordy Rose GenericNodeBuilderRefCount Bd, ExplodedNode *Pred, 25366a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, SymbolRef Sym, RefVal V) const; 25378d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 25388bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *processLeaks(ProgramStateRef state, 253938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 254038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount &Builder, 25416a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 254238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2543d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2544d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2545d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 25466704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 25476704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 25488bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 25496704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 25508bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek StopTrackingCallback(ProgramStateRef st) : state(st) {} 25518bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return state; } 25526704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25536704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 25546704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 25556704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 25566704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 25576704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 25586704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 25596704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2560910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2561910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2562910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 25636704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2564910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2565910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2566dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2567910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2568dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2569469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 257038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2571dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 25728bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 257338cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 25745eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek cast<BlockDataRegion>(state->getSVal(BE, 25755eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsRegion()); 2576dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 257738cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 257838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2579dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 258138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2582dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 258467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 258567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 25865f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 258739ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2588c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2589dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 259067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 259167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion *VR = *I; 259267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 259367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 259467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 259567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 259667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2597dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 259867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 259967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 260067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 26010bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 260238cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 260338cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2604910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2605910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2606f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2607f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2608f85e193739c953358c865005855253af4f68a497John McCall return; 2609f85e193739c953358c865005855253af4f68a497John McCall 261071c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2611f85e193739c953358c865005855253af4f68a497John McCall 2612f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2613f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2614f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2615f85e193739c953358c865005855253af4f68a497John McCall return; 2616f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2617f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2618f85e193739c953358c865005855253af4f68a497John McCall break; 2619f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2620f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2621f85e193739c953358c865005855253af4f68a497John McCall break; 2622f85e193739c953358c865005855253af4f68a497John McCall } 2623f85e193739c953358c865005855253af4f68a497John McCall 26248bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26255eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CE, C.getLocationContext()).getAsLocSymbol(); 2626f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2627f85e193739c953358c865005855253af4f68a497John McCall return; 2628f85e193739c953358c865005855253af4f68a497John McCall const RefVal* T = state->get<RefBindings>(Sym); 2629f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2630f85e193739c953358c865005855253af4f68a497John McCall return; 2631f85e193739c953358c865005855253af4f68a497John McCall 2632f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 263317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2634f85e193739c953358c865005855253af4f68a497John McCall 2635f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2636e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2637e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2638f85e193739c953358c865005855253af4f68a497John McCall return; 2639f85e193739c953358c865005855253af4f68a497John McCall } 2640f85e193739c953358c865005855253af4f68a497John McCall 26410bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 2642f85e193739c953358c865005855253af4f68a497John McCall} 2643f85e193739c953358c865005855253af4f68a497John McCall 2644910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CallExpr *CE, 2645910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2646514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek if (C.wasInlined) 2647514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek return; 2648514f2c9dcb9e04b52929c5b141a6fe88bd68b33fTed Kremenek 2649294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Get the callee. 26508bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2651294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Callee = CE->getCallee(); 26525eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal L = state->getSVal(Callee, C.getLocationContext()); 2653294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 265417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 265593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = 0; 2656294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2657294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Better support for blocks. For now we stop tracking anything 2658294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // that is passed to blocks. 2659294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Need to handle variables that are "captured" by the block. 2660294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (dyn_cast_or_null<BlockDataRegion>(L.getAsRegion())) { 2661294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getPersistentStopSummary(); 2662294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const FunctionDecl *FD = L.getAsFunctionDecl()) { 266358822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks CallOrObjCMessage CME(CE, state, C.getLocationContext()); 266458822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks Summ = Summaries.getSummary(FD, &CME); 2665294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const CXXMemberCallExpr *me = dyn_cast<CXXMemberCallExpr>(CE)) { 266658822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks if (const CXXMethodDecl *MD = me->getMethodDecl()) { 266758822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks CallOrObjCMessage CME(CE, state, C.getLocationContext()); 266858822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks Summ = Summaries.getSummary(MD, &CME); 266958822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks } 2670294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2671294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2672294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 267393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Summ = Summaries.getDefaultSummary(); 2674294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 26755eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(CE, state, C.getLocationContext()), C); 2676294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2677294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2678910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CXXConstructExpr *CE, 2679910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2680537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const CXXConstructorDecl *Ctor = CE->getConstructor(); 2681537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Ctor) 2682537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2683537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 268417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 268558822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks ProgramStateRef state = C.getState(); 268658822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks CallOrObjCMessage CME(CE, state, C.getLocationContext()); 268758822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks const RetainSummary *Summ = Summaries.getSummary(Ctor, &CME); 2688537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 2689537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose // If we didn't get a summary, this constructor doesn't affect retain counts. 2690537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Summ) 2691537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2692537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 26935eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(CE, state, C.getLocationContext()), C); 2694537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose} 2695537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 26961a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::processObjCLiterals(CheckerContext &C, 26971a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Expr *Ex) const { 26981a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ProgramStateRef state = C.getState(); 26991a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const ExplodedNode *pred = C.getPredecessor(); 27001a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek for (Stmt::const_child_iterator it = Ex->child_begin(), et = Ex->child_end() ; 27011a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek it != et ; ++it) { 27021a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Stmt *child = *it; 27031a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal V = state->getSVal(child, pred->getLocationContext()); 27041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = V.getAsSymbol()) 27051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const RefVal* T = state->get<RefBindings>(sym)) { 27061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek RefVal::Kind hasErr = (RefVal::Kind) 0; 27071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = updateSymbol(state, sym, *T, MayEscape, hasErr, C); 27081a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (hasErr) { 27091a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processNonLeakError(state, child->getSourceRange(), hasErr, sym, C); 27101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek return; 27111a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27121a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27131a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27141a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27151a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Return the object as autoreleased. 27161a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // RetEffect RE = RetEffect::MakeNotOwned(RetEffect::ObjC); 27171a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = 27181a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state->getSVal(Ex, pred->getLocationContext()).getAsSymbol()) { 27191a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek QualType ResultTy = Ex->getType(); 27201a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = state->set<RefBindings>(sym, RefVal::makeNotOwned(RetEffect::ObjC, 27211a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ResultTy)); 27221a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27231a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27241a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek C.addTransition(state); 27251a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27261a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27271a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCArrayLiteral *AL, 27281a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27291a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all values. 27301a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, AL); 27311a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27321a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27331a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCDictionaryLiteral *DL, 27341a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27351a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all keys and values. 27361a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, DL); 27371a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27381a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 273970fdbc366da85880aae5baebd3351e993ca05603Jordy Rosevoid RetainCountChecker::checkPostStmt(const ObjCBoxedExpr *Ex, 274070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose CheckerContext &C) const { 274170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ExplodedNode *Pred = C.getPredecessor(); 274270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const LocationContext *LCtx = Pred->getLocationContext(); 274370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose ProgramStateRef State = Pred->getState(); 274470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 274570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (SymbolRef Sym = State->getSVal(Ex, LCtx).getAsSymbol()) { 274670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose QualType ResultTy = Ex->getType(); 274770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose State = State->set<RefBindings>(Sym, RefVal::makeNotOwned(RetEffect::ObjC, 274870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose ResultTy)); 274970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 275070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 275170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose C.addTransition(State); 275270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 275370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2754910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostObjCMessage(const ObjCMessage &Msg, 2755910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 27568bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2757294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 275817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2759b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 276093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ; 2761294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Msg.isInstanceMessage()) { 2762a2a860306e3697fcf7a12c5ba59551ca60578968Anna Zaks const LocationContext *LC = C.getLocationContext(); 2763294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getInstanceMethodSummary(Msg, state, LC); 2764294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 2765294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getClassMethodSummary(Msg); 2766294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2767294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2768294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // If we didn't get a summary, this message doesn't affect retain counts. 2769294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 2770294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2771294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 27725eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(Msg, state, C.getLocationContext()), C); 2773294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2774294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2775910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2776910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2777910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// While the the return type can be queried directly from RetEx, when 2778910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2779910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2780910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2781910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2782910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2783910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2784910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2785910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2786910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2787910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2788910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2789910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2790910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2791910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2792910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2793910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2794910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2795910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2796910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2797910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2798910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2799910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2800910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2801910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2802910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2803910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 2804910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const CallOrObjCMessage &CallOrMsg, 2805910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 28068bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2807294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2808294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2809294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2810294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2811294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2812294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2813294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2814537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2815294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2816294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 2817294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RefBindings::data_type *T = state->get<RefBindings>(Sym)) { 281817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2819294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2820294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2821294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2822294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2823294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2824294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2825294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2826294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2827294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2828294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2829294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 2830e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (!hasErr && CallOrMsg.isObjCMessage()) { 283139ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2832e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose SVal Receiver = CallOrMsg.getInstanceMessageReceiver(LC); 2833e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (SymbolRef Sym = Receiver.getAsLocSymbol()) { 2834294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const RefVal *T = state->get<RefBindings>(Sym)) { 2835294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ReceiverIsTracked = true; 283617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 283717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose hasErr, C); 2838294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2839e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose ErrorRange = CallOrMsg.getReceiverSourceRange(); 2840294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2841294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2842294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2843294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2844294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2845294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2846294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2847294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2848294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2849294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2850294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2851294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2852294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2853294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2854294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2855294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2856b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 285717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2858b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2859294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2860294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2861294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2862294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2863294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 28647530c034c0c71a64c5a9173206d9742ae847af8bDavid Blaikie llvm_unreachable("Unhandled RetEffect."); 2865294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2866294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2867294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2868294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2869294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2870294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2871294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 28725eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 28735eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsSymbol(); 2874294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2875294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2876294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2877294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use the result type from callOrMsg as it automatically adjusts 2878294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 2879294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = CallOrMsg.getResultType(C.getASTContext()); 2880294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeOwned(RE.getObjKind(), 2881294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2882294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2883294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2884294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // *not* fail. (The code below is out-of-date, though.) 2885294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#if 0 2886294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedAllocatedSymbol) { 2887294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool isFeasible; 2888294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state.assume(loc::SymbolVal(Sym), true, isFeasible); 2889294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose assert(isFeasible && "Cannot assume fresh symbol is non-null."); 2890294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2891294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#endif 2892294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2893294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2894294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2895294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2896294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2897294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2898294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2899294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 29005eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(Ex, C.getLocationContext()).getAsSymbol(); 2901294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2902294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2903294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2904294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2905294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 2906294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeNotOwned(RE.getObjKind(), 2907294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2908294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2909294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2910294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2911294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2912294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2913294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2914294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2915294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2916294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2917294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2918294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 29190bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks NewNode = C.addTransition(state); 2920294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2921294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 29229c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 29239c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 29249c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 29259c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 29269c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 29279c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 29289c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2929ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 29309c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2931294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2932294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2933e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 29348bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 29358bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::updateSymbol(ProgramStateRef state, SymbolRef sym, 2936910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2937910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2938e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2939910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 294017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 294117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 29424e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie IgnoreRetainMsg = (bool)C.getASTContext().getLangOpts().ObjCAutoRefCount; 294317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2944e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2945e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: break; 294617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case IncRefMsg: E = IgnoreRetainMsg ? DoNothing : IncRef; break; 294717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case DecRefMsg: E = IgnoreRetainMsg ? DoNothing : DecRef; break; 294817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case MakeCollectable: E = C.isObjCGCEnabled() ? DecRef : DoNothing; break; 294917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case NewAutoreleasePool: E = C.isObjCGCEnabled() ? DoNothing : 295017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose NewAutoreleasePool; break; 2951e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2952e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2953e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 295417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2955e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2956e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2957e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2958e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2959e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2960e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2961e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2962e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2963e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 2964e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2965e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2966e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2967e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 296817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2969e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2970e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2971e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2972e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2973e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2974e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2975e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2976e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2977e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2978e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2979e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2980e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 2981e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2982e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2983e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2984e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2985e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2986e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2987e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2988e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2989e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case NewAutoreleasePool: 299017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!C.isObjCGCEnabled()); 2991e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->add<AutoreleaseStack>(sym); 2992e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2993e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 2994e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 2995e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2996e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2997e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2998e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2999e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 3000e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3001e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 3002e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 3003e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3004e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 300517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 3006e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 3007e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3008e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 3009e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose state = SendAutorelease(state, ARCountFactory, sym); 3010e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 3011e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3012e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3013e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 3014e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->remove<RefBindings>(sym); 3015e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3016e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 3017e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3018e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3019e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 3020e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3021e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 3022e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 3023e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3024e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3025e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 302617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3027e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 3028e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3029e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3030e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3031e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3032e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case SelfOwn: 3033e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 3034e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 3035e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 3036e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 3037e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3038e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3039e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 3040e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 3041e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3042e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3043e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 3044e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 3045e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 3046e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 3047e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3048e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3049e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3050e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 3051e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() > 0) 3052e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3053e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose else { 3054e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 3055e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3056e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3057e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3058e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3059e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3060e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 306117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3062e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 3063e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3064e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3065e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3066e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3067e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3068e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 3069e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 3070e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 30718bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::processNonLeakError(ProgramStateRef St, 3072910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 3073910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 3074910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 3075910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3076294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 3077294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 3078294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 3079294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3080294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 3081294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 3082294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 3083294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 3084294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 3085d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 3086d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 3087d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 3088294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3089294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 3090d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 3091d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 3092d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 3093294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3094294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 3095d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 3096d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 3097d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 3098294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3099294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 3100d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 3101d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 3102d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 3103294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3104294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3105294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3106d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 31074e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOpts(), 310817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 310917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 3110294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 3111294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.EmitReport(report); 3112294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 3113294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3114910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3115910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 3116910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3117910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3118910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 311976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 31208bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3121b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *FD = C.getCalleeDecl(CE); 312276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 312376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 312476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 312576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 312676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 312776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 312876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 312976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 313076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 313176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 313276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 313376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 313476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 313576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 313676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 313776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 313876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 313976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 314076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 314176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 314276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3143b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks QualType ResultTy = CE->getCallReturnType(); 314476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 314576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 314676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 314776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 314876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 314976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 315076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 315176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 315276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 315376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 315476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 315576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 315676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 315776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 315876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 315976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 316076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 31615eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = C.getLocationContext(); 31625eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal RetVal = state->getSVal(CE->getArg(0), LCtx); 316376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 316476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 316576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 31665d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 31673133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek SVal RetVal = SVB.getConjuredSymbolVal(0, CE, LCtx, ResultTy, Count); 316876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 31695eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal, false); 317076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3171294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3172294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3173294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3174294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3175294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 3176294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefBindings::data_type *Binding = 0; 3177294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 3178294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Binding = state->get<RefBindings>(Sym); 317976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3180294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 31815d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 31823133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek state = state->invalidateRegions(ArgRegion, CE, Count, LCtx); 318376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3184294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3185294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 3186294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, *Binding); 3187294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3188294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 31890bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 319076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 319176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 319276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3193910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3194910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3195910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3196f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3197e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek// Return true if the current LocationContext has no caller context. 3198e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenekstatic bool inTopFrame(CheckerContext &C) { 3199e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek const LocationContext *LC = C.getLocationContext(); 3200e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return LC->getParent() == 0; 3201e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek} 3202e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3203910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3204910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3205e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3206e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // Only adjust the reference count if this is the top-level call frame, 3207e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // and not the result of inlining. In the future, we should do 3208e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // better checking even for inlined calls, and see if they match 3209e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // with their expected semantics (e.g., the method should return a retained 3210e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // object, etc.). 3211e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek if (!inTopFrame(C)) 3212e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return; 3213e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3214f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3215f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3216f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3217f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32188bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 32195eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = 32205eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state->getSValAsScalarOrLoc(RetE, C.getLocationContext()).getAsLocSymbol(); 3221f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3222f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3223f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3224f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 3225f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const RefVal *T = state->get<RefBindings>(Sym); 3226f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3227f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3228f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3229f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3230f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3231f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3232f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3233f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3234f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3235f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3236f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3237f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3238f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3239f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3240f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3241f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3242f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3243f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3244f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3245f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3246f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3247f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3248f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3249f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3250f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3251f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3252f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3253f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3254f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3255f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3256f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3257f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 3258f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 32590bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *Pred = C.addTransition(state); 3260f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3261f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3262f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3263f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3264f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3265f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3266f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3267f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3268f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3269f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3270f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3271910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 32724eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, &AutoreleaseTag); 32736a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, Sym, X); 3274f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3275f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 32768d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!Pred) 3277f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3278f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3279f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 3280f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose T = state->get<RefBindings>(Sym); 3281f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3282f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3283f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3284f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 328517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3286f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 3287f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3288f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3289f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Unlike regular functions, /all/ ObjC methods are assumed to always 3290f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // follow Cocoa retain-count conventions, not just those with special 3291f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // names or attributes. 3292b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 3293f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RetEffect RE = Summ ? Summ->getRetEffect() : RetEffect::MakeNoRet(); 3294f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3295f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3296f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3297f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 3298f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<CXXMethodDecl>(FD)) 329958822c403cc8855adeecba92248612ee08dc1f3aAnna Zaks if (const RetainSummary *Summ = Summaries.getSummary(FD, 0)) 3300f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, Summ->getRetEffect(), X, 3301f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose Sym, state); 3302f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3303f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3304f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3305910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3306910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3307910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3308910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3309910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 33108bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state) const { 3311f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3312f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3313f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3314f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 331517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3316f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3317f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3318f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3319f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3320f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3321f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3322f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3323f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3324f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3325f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3326f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3327f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3328f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3329f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3330f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3331f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3332f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 3333f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 3334f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3335f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3336910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 33370bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnOwnLeakTag); 3338f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 33394e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = C.getASTContext().getLangOpts(); 334017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3341f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 334217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 334317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 33446a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks N, Sym, C); 3345f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3346f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3347f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3348f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3349f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3350f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3351f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3352f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 3353f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X ^ RefVal::ErrorReturnedNotOwned); 3354f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3355f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3356910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 33570bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnNotOwnedTag); 3358f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3359d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3360d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3361d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3362f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3363d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 33644e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie C.getASTContext().getLangOpts(), 336517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3366f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3367f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3368f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3369f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3370f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3371f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33728d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3373910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3374910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3375910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3376390909c89c98ab1807e15e033a72e975f866fb23Anna Zaksvoid RetainCountChecker::checkBind(SVal loc, SVal val, const Stmt *S, 3377910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3378910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3379910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3380910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3381910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3382910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3383910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3384910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3385910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3386910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 33878bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3388910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3389910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (loc::MemRegionVal *regionLoc = dyn_cast<loc::MemRegionVal>(&loc)) { 3390910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3391910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3392910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3393910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3394910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3395910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3396e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // Do this only if we know that the store is not supposed to generate the 3397e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // same state. 3398e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks SVal StoredVal = state->getSVal(regionLoc->getRegion()); 3399e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks if (StoredVal != val) 3400e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks escapes = (state == (state->bindLoc(*regionLoc, val))); 3401910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3402de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek if (!escapes) { 3403de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // Case 4: We do not currently model what happens when a symbol is 3404de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // assigned to a struct field, so be conservative here and let the symbol 3405de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // go. TODO: This could definitely be improved upon. 3406de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek escapes = !isa<VarRegion>(regionLoc->getRegion()); 3407de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek } 3408910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3409910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3410910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3411910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3412910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3413910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3414910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3415910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3416910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3417910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3418910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 34190bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 3420910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3421910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34228bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef RetainCountChecker::evalAssume(ProgramStateRef state, 3423910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3424910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3425910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3426910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3427910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3428910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3429910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3430910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3431910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3432910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings B = state->get<RefBindings>(); 3433910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3434910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3435910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3436910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3437910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3438910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings::Factory &RefBFactory = state->get_context<RefBindings>(); 3439910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3440910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3441910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Check if the symbol is null (or equal to any constant). 3442910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If this is the case, stop tracking the symbol. 3443910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (state->getSymVal(I.getKey())) { 3444910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3445910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3446910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3447910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3448910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3449910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3450910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3451910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3452910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3453910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3454910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34558bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 34568bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::checkRegionChanges(ProgramStateRef state, 3457910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 3458910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 345966c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 346066c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks const CallOrObjCMessage *Call) const { 3461910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3462910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3463910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3464910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3465910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3466910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3467910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3468910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3469910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3470910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3471910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (StoreManager::InvalidatedSymbols::const_iterator I=invalidated->begin(), 3472910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3473910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3474910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3475910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3476910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 3477910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->remove<RefBindings>(sym); 3478910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3479910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3480910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3481910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3482910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 34838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 34848d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 34858d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34868bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstd::pair<ExplodedNode *, ProgramStateRef > 34878bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleAutoreleaseCounts(ProgramStateRef state, 3488910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount Bd, 34896a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred, 34906a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 3491910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 34928d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 34938d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34948d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 34958d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 34968d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(Pred, state); 34978d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34986a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks assert(!Ctx.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 34998d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 35008d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35018d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 35028d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35038d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 35048d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 35058d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35068d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 35078d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 35088d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 35098d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 35108d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 35118d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 35128d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 35138d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 35148d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setCount(Cnt - ACnt); 35158d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 35168d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35178d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 35188d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ExplodedNode *N = Bd.MakeNode(state, Pred); 35198d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (N == 0) 35208d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = 0; 35218d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(N, state); 35228d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35238d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35248d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 35258d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 35268d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 35278d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 35288d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3529f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks if (ExplodedNode *N = Bd.MakeNode(state, Pred, true)) { 3530f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<128> sbuf; 35318d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 35328d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 35338d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 35348d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 35358d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 35368d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3537d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3538d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3539d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 35404e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35418d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3542d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3543d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 35446a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 35458d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35468d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35478bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek return std::make_pair((ExplodedNode *)0, (ProgramStateRef )0); 35488d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 354938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35508bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 35518bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleSymbolDeath(ProgramStateRef state, 3552910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 355338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 35545337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 355538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 355638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 355738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 355838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 355938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 356138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->remove<RefBindings>(sid); 356238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 356438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->set<RefBindings>(sid, V ^ RefVal::ErrorLeak); 356538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 356638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 35688bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::processLeaks(ProgramStateRef state, 3569910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 3570910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount &Builder, 35716a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 35726a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred) const { 357338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (Leaked.empty()) 357438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return Pred; 357538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 357738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *N = Builder.MakeNode(state, Pred); 357838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 358038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 358138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 358238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35834e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35846a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks bool GCEnabled = Ctx.isObjCGCEnabled(); 358517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 358617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 358738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 35882058956954802229bf98604e8063fa57677abff4Jordy Rose 358917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 35906a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks SummaryLog, N, *I, Ctx); 35916a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 359238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 359338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 359438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 359538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 359638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 359738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3598af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaksvoid RetainCountChecker::checkEndPath(CheckerContext &Ctx) const { 35998bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Ctx.getState(); 3600af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks GenericNodeBuilderRefCount Bd(Ctx); 360138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 3602af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred = Ctx.getPredecessor(); 360338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 360438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 36056a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, Ctx, 36068d22863184419faa2348bd5148c663197bc4bb00Jordy Rose I->first, I->second); 36078d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 360838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 360938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 361038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36110cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // If the current LocationContext has a parent, don't check for leaks. 36120cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // We will do that later. 36130cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // FIXME: we should instead check for imblances of the retain/releases, 36140cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // and suggest annotations. 36150cf3d471546251b12bdceff360f66c079c40526cTed Kremenek if (Ctx.getLocationContext()->getParent()) 36160cf3d471546251b12bdceff360f66c079c40526cTed Kremenek return; 36170cf3d471546251b12bdceff360f66c079c40526cTed Kremenek 361838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 361938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 362038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 362138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) 36228d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 362338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36246a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks processLeaks(state, Leaked, Bd, Ctx, Pred); 362538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 362638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 362738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3628910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 362938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 363038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 3631f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<64> buf; 363238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3633f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks out << "RetainCountChecker : Dead Symbol : "; 3634f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks sym->dumpToStream(out); 363538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 363638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 363738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 363838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 363938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3640910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3641910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 364238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 364338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36448bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 364538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 364638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 364738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 364838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 364938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 365038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 365138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 365238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 365338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 36544eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, getDeadSymbolTag(Sym)); 36556a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, 36568d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Sym, *T); 36578d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 365838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 365938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 366038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 366138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 366238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 366338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 366438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 366538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 366638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 366738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(*I)) 366838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = handleSymbolDeath(state, *I, *T, Leaked); 366938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 367038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose { 36724eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, this); 36736a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Pred = processLeaks(state, Leaked, Bd, C, Pred); 367438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 367538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 367738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 367838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 367938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 368038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 368138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings::Factory &F = state->get_context<RefBindings>(); 368238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 368338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 368438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) 368538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 368638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 368738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 36880bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state, Pred); 368938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 369038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3691d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek//===----------------------------------------------------------------------===// 3692dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose// Debug printing of refcount bindings and autorelease pools. 3693dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3694dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3695dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rosestatic void PrintPool(raw_ostream &Out, SymbolRef Sym, 36968bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State) { 3697dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ' '; 3698dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (Sym) 3699f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks Sym->dumpToStream(Out); 3700dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose else 3701dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "<pool>"; 3702dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ":{"; 3703dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3704dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Get the contents of the pool. 3705dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (const ARCounts *Cnts = State->get<AutoreleasePoolContents>(Sym)) 3706dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARCounts::iterator I = Cnts->begin(), E = Cnts->end(); I != E; ++I) 3707dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '(' << I.getKey() << ',' << I.getData() << ')'; 3708dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3709dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '}'; 3710dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3711dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 37128bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic bool UsesAutorelease(ProgramStateRef state) { 3713dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // A state uses autorelease if it allocated an autorelease pool or if it has 3714dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // objects in the caller's autorelease pool. 3715dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose return !state->get<AutoreleaseStack>().isEmpty() || 3716dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose state->get<AutoreleasePoolContents>(SymbolRef()); 3717dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3718dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 37198bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::printState(raw_ostream &Out, ProgramStateRef State, 3720910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3721dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3722dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose RefBindings B = State->get<RefBindings>(); 3723dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3724dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3725dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3726dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3727dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3728dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3729dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3730dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3731dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3732dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3733dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Print the autorelease stack. 3734dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (UsesAutorelease(State)) { 3735dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL << "AR pool stack:"; 3736dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose ARStack Stack = State->get<AutoreleaseStack>(); 3737dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3738dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, SymbolRef(), State); // Print the caller's pool. 3739dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARStack::iterator I = Stack.begin(), E = Stack.end(); I != E; ++I) 3740dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, *I, State); 3741dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3742dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3743dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3744dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3745dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3746dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3747910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 37486b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 37496b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 375017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3751910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 375217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 375317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3754