RetainCountChecker.cpp revision 74b7b2b42dd710ccea78d86a47c979d4b2af7093
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 } 1356b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 1361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 137b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 138b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// Reference-counting logic (typestate + counts). 139b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 1401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 141ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RefVal { 142b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 143b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek enum Kind { 144b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Owned = 0, // Owning reference. 145b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek NotOwned, // Reference is not owned by still valid (not freed). 146b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Released, // Object has been released. 147b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedOwned, // Returned object passes ownership to caller. 148b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedNotOwned, // Return object does not pass ownership to caller. 149b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_START, 150b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocNotOwned, // -dealloc called on non-owned object. 151b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocGC, // Calling -dealloc with GC enabled. 152b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorUseAfterRelease, // Object used after released. 153b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReleaseNotOwned, // Release of an object that was not owned. 154b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_LEAK_START, 155b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeak, // A memory leak due to excessive reference counts. 156b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeakReturned, // A memory leak due to the returning method not having 157b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // the correct naming conventions. 158b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorGCLeakReturned, 159b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorOverAutorelease, 160b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReturnedNotOwned 161b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek }; 162dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 163b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekprivate: 164b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind kind; 165b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind okind; 166b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Cnt; 167b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned ACnt; 168b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType T; 169dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 170b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal(Kind k, RetEffect::ObjKind o, unsigned cnt, unsigned acnt, QualType t) 171b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek : kind(k), okind(o), Cnt(cnt), ACnt(acnt), T(t) {} 172dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 173b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 174b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind getKind() const { return kind; } 175dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 176b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind getObjKind() const { return okind; } 177dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 178b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCount() const { return Cnt; } 179b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getAutoreleaseCount() const { return ACnt; } 180b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCombinedCounts() const { return Cnt + ACnt; } 181b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void clearCounts() { Cnt = 0; ACnt = 0; } 182b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setCount(unsigned i) { Cnt = i; } 183b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setAutoreleaseCount(unsigned i) { ACnt = i; } 184dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 185b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType getType() const { return T; } 186dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 187b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isOwned() const { 188b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == Owned; 189b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 190dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 191b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isNotOwned() const { 192b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == NotOwned; 193b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 194dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 195b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedOwned() const { 196b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedOwned; 197b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 198dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 199b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedNotOwned() const { 200b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedNotOwned; 201b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 202dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 203b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeOwned(RetEffect::ObjKind o, QualType t, 204b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 1) { 205b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(Owned, o, Count, 0, t); 206b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 207dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 208b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeNotOwned(RetEffect::ObjKind o, QualType t, 209b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 0) { 210b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(NotOwned, o, Count, 0, t); 211b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 212dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 213b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Comparison, profiling, and pretty-printing. 214dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 215b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool operator==(const RefVal& X) const { 216b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return kind == X.kind && Cnt == X.Cnt && T == X.T && ACnt == X.ACnt; 217b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 218dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 219b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator-(size_t i) const { 220b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount() - i, 221b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getAutoreleaseCount(), getType()); 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^(Kind k) const { 230b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(k, getObjKind(), getCount(), getAutoreleaseCount(), 231b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 232b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 233dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 234b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal autorelease() const { 235b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount(), getAutoreleaseCount()+1, 236b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 237b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 238dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 239b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 240b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger((unsigned) kind); 241b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(Cnt); 242b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(ACnt); 243b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.Add(T); 244b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 245dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2469c378f705405d37f49795d5e915989de774fe11fTed Kremenek void print(raw_ostream &Out) const; 247b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek}; 248b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 2499c378f705405d37f49795d5e915989de774fe11fTed Kremenekvoid RefVal::print(raw_ostream &Out) const { 250b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (!T.isNull()) 251dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "Tracked " << T.getAsString() << '/'; 252dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 253b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek switch (getKind()) { 254910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose default: llvm_unreachable("Invalid RefVal kind"); 255b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Owned: { 256b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Owned"; 257b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 258b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 259b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 260b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 261dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 262b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case NotOwned: { 263b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "NotOwned"; 264b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 265b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 266b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 267b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 268dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 269b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedOwned: { 270b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedOwned"; 271b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 272b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 273b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 274b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 275dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 276b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedNotOwned: { 277b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedNotOwned"; 278b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 279b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 280b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 281b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 282dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 283b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Released: 284b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Released"; 285b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 286dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 287b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocGC: 288b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (GC)"; 289b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 290dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 291b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocNotOwned: 292b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (not-owned)"; 293b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 294dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 295b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeak: 296b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked"; 297b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 298dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 299b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeakReturned: 300b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (Bad naming)"; 301b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 302dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 303b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorGCLeakReturned: 304b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (GC-ed at return)"; 305b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 306dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 307b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorUseAfterRelease: 308b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Use-After-Release [ERROR]"; 309b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 310dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 311b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorReleaseNotOwned: 312b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Release of Not-Owned [ERROR]"; 313b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 314dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 315b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorOverAutorelease: 316b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Over autoreleased"; 317b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 318dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 319b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorReturnedNotOwned: 320b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Non-owned object returned instead of owned"; 321b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 322b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 323dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 324b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (ACnt) { 325b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << " [ARC +" << ACnt << ']'; 326b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 327b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 328b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} //end anonymous namespace 329b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 330b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 331b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// RefBindings - State used to track object reference counts. 332b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 333b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 334b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, RefVal> RefBindings; 335b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 336b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace clang { 3379ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 33818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> 33918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenekstruct ProgramStateTrait<RefBindings> 34018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<RefBindings> { 34118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static void *GDMIndex() { 34218c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static int RefBIndex = 0; 34318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek return &RefBIndex; 34418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek } 34518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek}; 346b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 3475a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} 348b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 349b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 350910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Function/Method behavior summaries. 351b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 352b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 353b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace { 354ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummary { 3551bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// Args - an ordered vector of (index, ArgEffect) pairs, where index 3561bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// specifies the argument (starting from 0). This can be sparsely 3571bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// populated; arguments with no entry in Args use 'DefaultArgEffect'. 358b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects Args; 3591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3601bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// DefaultArgEffect - The default ArgEffect to apply to arguments that 3611bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// do not have an entry in Args. 3620507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect DefaultArgEffect; 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 364553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Receiver - If this summary applies to an Objective-C message expression, 365553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// this is the effect applied to the state of the receiver. 3660507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect Receiver; 3671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 368553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ret - The effect on the return value. Used to indicate if the 36976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose /// function/method call returns a new tracked symbol. 3700507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek RetEffect Ret; 3711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3726b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 373b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetainSummary(ArgEffects A, RetEffect R, ArgEffect defaultEff, 374e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect ReceiverEff) 375e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose : Args(A), DefaultArgEffect(defaultEff), Receiver(ReceiverEff), Ret(R) {} 3761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 377553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArg - Return the argument effect on the argument specified by 378553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// idx (starting from 0). 3791ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek ArgEffect getArg(unsigned idx) const { 380b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek if (const ArgEffect *AE = Args.lookup(idx)) 381b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return *AE; 3821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3831bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek return DefaultArgEffect; 3841ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 38511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 38611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek void addArg(ArgEffects::Factory &af, unsigned idx, ArgEffect e) { 38711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek Args = af.add(Args, idx, e); 38811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 3891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 390885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setDefaultArgEffect - Set the default argument effect. 391885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setDefaultArgEffect(ArgEffect E) { 392885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek DefaultArgEffect = E; 393885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek } 3941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 395553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getRetEffect - Returns the effect on the return value of the call. 396b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetEffect getRetEffect() const { return Ret; } 3971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 398885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setRetEffect - Set the effect of the return value of the call. 399885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setRetEffect(RetEffect E) { Ret = E; } 4001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40112b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 40212b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek /// Sets the effect on the receiver of the message. 40312b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek void setReceiverEffect(ArgEffect e) { Receiver = e; } 40412b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 405553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getReceiverEffect - Returns the effect on the receiver of the call. 406553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// This is only meaningful if the summary applies to an ObjCMessageExpr*. 407b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffect getReceiverEffect() const { return Receiver; } 4084df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 4094df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// Test if two retain summaries are identical. Note that merely equivalent 4104df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// summaries are not necessarily identical (for example, if an explicit 4114df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// argument effect matches the default effect). 4124df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetainSummary &Other) const { 4134df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return Args == Other.Args && DefaultArgEffect == Other.DefaultArgEffect && 4144df54feb02d72b76249e846053d5d53d820bf832Jordy Rose Receiver == Other.Receiver && Ret == Other.Ret; 4154df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 4166b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 4174f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} // end anonymous namespace 4186b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 419553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 420553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for constructing summaries. 421553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 422553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4234f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 424ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryKey { 425553cf18cd44769a7624fc942493f076498527529Ted Kremenek IdentifierInfo* II; 426553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector S; 4271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 428553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(IdentifierInfo* ii, Selector s) 429553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(ii), S(s) {} 430553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4319c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, Selector s) 432553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(d ? d->getIdentifier() : 0), S(s) {} 43370b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek 4349c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, IdentifierInfo *ii, Selector s) 43570b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek : II(d ? d->getIdentifier() : ii), S(s) {} 4361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 437553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(Selector s) 438553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(0), S(s) {} 4391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4400507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek IdentifierInfo *getIdentifier() const { return II; } 441553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector getSelector() const { return S; } 442553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 4434f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} 4444f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek 4454f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace llvm { 446553cf18cd44769a7624fc942493f076498527529Ted Kremenektemplate <> struct DenseMapInfo<ObjCSummaryKey> { 447553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getEmptyKey() { 448553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getEmptyKey(), 449553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::getEmptyKey()); 450553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 452553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getTombstoneKey() { 453553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getTombstoneKey(), 4541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump DenseMapInfo<Selector>::getTombstoneKey()); 455553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 457553cf18cd44769a7624fc942493f076498527529Ted Kremenek static unsigned getHashValue(const ObjCSummaryKey &V) { 458553cf18cd44769a7624fc942493f076498527529Ted Kremenek return (DenseMapInfo<IdentifierInfo*>::getHashValue(V.getIdentifier()) 4591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump & 0x88888888) 460553cf18cd44769a7624fc942493f076498527529Ted Kremenek | (DenseMapInfo<Selector>::getHashValue(V.getSelector()) 461553cf18cd44769a7624fc942493f076498527529Ted Kremenek & 0x55555555); 462553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 464553cf18cd44769a7624fc942493f076498527529Ted Kremenek static bool isEqual(const ObjCSummaryKey& LHS, const ObjCSummaryKey& RHS) { 465553cf18cd44769a7624fc942493f076498527529Ted Kremenek return DenseMapInfo<IdentifierInfo*>::isEqual(LHS.getIdentifier(), 466553cf18cd44769a7624fc942493f076498527529Ted Kremenek RHS.getIdentifier()) && 467553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::isEqual(LHS.getSelector(), 468553cf18cd44769a7624fc942493f076498527529Ted Kremenek RHS.getSelector()); 469553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 471553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 47206159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <> 47306159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<ObjCSummaryKey> { static const bool value = true; }; 474553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end llvm namespace 4751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 476553cf18cd44769a7624fc942493f076498527529Ted Kremeneknamespace { 477ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryCache { 47893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<ObjCSummaryKey, const RetainSummary *> MapTy; 479553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy M; 480553cf18cd44769a7624fc942493f076498527529Ted Kremenekpublic: 481553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryCache() {} 4821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 48393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, IdentifierInfo *ClsName, 484a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek Selector S) { 4858711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Lookup the method using the decl for the class @interface. If we 4868711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // have no decl, lookup using the class name. 4878711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek return D ? find(D, S) : find(ClsName, S); 4888711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 4891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 49093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, Selector S) { 491553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Do a lookup with the (D,S) pair. If we find a match return 492553cf18cd44769a7624fc942493f076498527529Ted Kremenek // the iterator. 493553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey K(D, S); 494553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy::iterator I = M.find(K); 4951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 496553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (I != M.end() || !D) 497614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I->second; 4981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 499553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Walk the super chain. If we find a hit with a parent, we'll end 500553cf18cd44769a7624fc942493f076498527529Ted Kremenek // up returning that summary. We actually allow that key (null,S), as 501553cf18cd44769a7624fc942493f076498527529Ted Kremenek // we cache summaries for the null ObjCInterfaceDecl* to allow us to 502553cf18cd44769a7624fc942493f076498527529Ted Kremenek // generate initial summaries without having to worry about NSObject 503553cf18cd44769a7624fc942493f076498527529Ted Kremenek // being declared. 504553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: We may change this at some point. 5059c378f705405d37f49795d5e915989de774fe11fTed Kremenek for (ObjCInterfaceDecl *C=D->getSuperClass() ;; C=C->getSuperClass()) { 506553cf18cd44769a7624fc942493f076498527529Ted Kremenek if ((I = M.find(ObjCSummaryKey(C, S))) != M.end()) 507553cf18cd44769a7624fc942493f076498527529Ted Kremenek break; 5081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 509553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (!C) 510614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return NULL; 5114f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek } 5121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Cache the summary with original key to make the next lookup faster 514553cf18cd44769a7624fc942493f076498527529Ted Kremenek // and return the iterator. 51593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = I->second; 516614cc540a617978814e37d75bf5066926b921a0aTed Kremenek M[K] = Summ; 517614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return Summ; 518553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5200507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *find(IdentifierInfo* II, Selector S) { 521553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: Class method lookup. Right now we dont' have a good way 522553cf18cd44769a7624fc942493f076498527529Ted Kremenek // of going between IdentifierInfo* and the class hierarchy. 523614cc540a617978814e37d75bf5066926b921a0aTed Kremenek MapTy::iterator I = M.find(ObjCSummaryKey(II, S)); 5241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 525614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (I == M.end()) 526614cc540a617978814e37d75bf5066926b921a0aTed Kremenek I = M.find(ObjCSummaryKey(S)); 5271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 528614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I == M.end() ? NULL : I->second; 529553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 53193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](ObjCSummaryKey K) { 532553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[K]; 533553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 53593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](Selector S) { 536553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[ ObjCSummaryKey(S) ]; 537553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 539553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end anonymous namespace 540553cf18cd44769a7624fc942493f076498527529Ted Kremenek 541553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 542553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for managing collections of summaries. 543553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 544553cf18cd44769a7624fc942493f076498527529Ted Kremenek 5454f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 546ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummaryManager { 547d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 548d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 549d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Typedefs. 550d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 55293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<const FunctionDecl*, const RetainSummary *> 553d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy; 5541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5554f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek typedef ObjCSummaryCache ObjCMethodSummariesTy; 5561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 557d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 558d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Data. 559d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 561553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ctx - The ASTContext object for the analyzed ASTs. 5629c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &Ctx; 563179064eb831125630c296556dd6d67e67f716143Ted Kremenek 564553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// GCEnabled - Records whether or not the analyzed code runs in GC mode. 565377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek const bool GCEnabled; 5661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 567f85e193739c953358c865005855253af4f68a497John McCall /// Records whether or not the analyzed code runs in ARC mode. 568f85e193739c953358c865005855253af4f68a497John McCall const bool ARCEnabled; 569f85e193739c953358c865005855253af4f68a497John McCall 570553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// FuncSummaries - A map from FunctionDecls to summaries. 5711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump FuncSummariesTy FuncSummaries; 5721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 573553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCClassMethodSummaries - A map from selectors (for instance methods) 574553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// to summaries. 5751f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCClassMethodSummaries; 576d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 577553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCMethodSummaries - A map from selectors to summaries. 5781f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCMethodSummaries; 579d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 580553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// BPAlloc - A BumpPtrAllocator used for allocating summaries, ArgEffects, 581553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// and all other data used by the checker. 582d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek llvm::BumpPtrAllocator BPAlloc; 5831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 584b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek /// AF - A factory for ArgEffects objects. 5851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ArgEffects::Factory AF; 5861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 587553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ScratchArgs - A holding buffer for construct ArgEffects. 5880507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffects ScratchArgs; 5891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 590ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// ObjCAllocRetE - Default return effect for methods returning Objective-C 591ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// objects. 592ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek RetEffect ObjCAllocRetE; 593547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek 5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// ObjCInitRetE - Default return effect for init methods returning 595ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek /// Objective-C objects. 596547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek RetEffect ObjCInitRetE; 5971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5987faca821633c9521030127bf7f42f032c73b24e2Ted Kremenek RetainSummary DefaultSummary; 59993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *StopSummary; 6001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 601d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 602d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Methods. 603d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 6041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 605553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArgEffects - Returns a persistent ArgEffects object based on the 606553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// data in ScratchArgs. 607b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects getArgEffects(); 60800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 6091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum UnaryFuncKind { cfretain, cfrelease, cfmakecollectable }; 6101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 611896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekpublic: 61278a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek RetEffect getObjAllocRetEffect() const { return ObjCAllocRetE; } 61378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek 61493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getDefaultSummary() { 61593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return &DefaultSummary; 61693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek } 61793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek 6180507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getUnarySummary(const FunctionType* FT, 61993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek UnaryFuncKind func); 6201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6210507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryCreateRule(const FunctionDecl *FD); 6220507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryGetRule(const FunctionDecl *FD); 6230507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFCreateGetRuleSummary(const FunctionDecl *FD); 6241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6250507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getPersistentSummary(ArgEffects AE, RetEffect RetEff, 62693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect ReceiverEff = DoNothing, 62793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect DefaultEff = MayEscape); 628706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 6290507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getPersistentSummary(RetEffect RE, 63093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect ReceiverEff = DoNothing, 63193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect DefaultEff = MayEscape) { 6321bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek return getPersistentSummary(getArgEffects(), RE, ReceiverEff, DefaultEff); 6339c32d08925045b32d7c39516e35d860159252e1dTed Kremenek } 6341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 63593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getPersistentStopSummary() { 636432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek if (StopSummary) 637432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek return StopSummary; 6381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 639432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek StopSummary = getPersistentSummary(RetEffect::MakeNoRet(), 640432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek StopTracking, StopTracking); 641706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 642432af5985a22e098cbc2329c021d5e23c944fb91Ted Kremenek return StopSummary; 6431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 644b309525445c8ec3d36e49568382029efc2740554Ted Kremenek 64593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getInitMethodSummary(QualType RetTy); 64646e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek 6471f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeClassMethodSummaries(); 6481f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeMethodSummaries(); 649896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekprivate: 65093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectClsMethSummary(Selector S, const RetainSummary *Summ) { 651553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCClassMethodSummaries[S] = Summ; 652553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 65493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectMethSummary(Selector S, const RetainSummary *Summ) { 655553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCMethodSummaries[S] = Summ; 656553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6573aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek 658a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek void addClassMethSummary(const char* Cls, const char* name, 659a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek const RetainSummary *Summ, bool isNullary = true) { 6603aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 661a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek Selector S = isNullary ? GetNullarySelector(name, Ctx) 662a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek : GetUnarySelector(name, Ctx); 6633aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6643aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek } 6651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6666c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek void addInstMethSummary(const char* Cls, const char* nullaryName, 66793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ) { 6686c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6696c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6706c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek ObjCMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6716c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek } 6721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 673de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector generateSelector(va_list argp) { 6745f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<IdentifierInfo*, 10> II; 675de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6769e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek while (const char* s = va_arg(argp, const char*)) 6779e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek II.push_back(&Ctx.Idents.get(s)); 678de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return Ctx.Selectors.getSelector(II.size(), &II[0]); 680de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 6811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 682de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addMethodSummary(IdentifierInfo *ClsII, ObjCMethodSummariesTy& Summaries, 68393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * Summ, va_list argp) { 684de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector S = generateSelector(argp); 685de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Summaries[ObjCSummaryKey(ClsII, S)] = Summ; 68670a733e64e2379a654631a14fa29e46761d5f80dTed Kremenek } 6871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addInstMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 689af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_list argp; 690af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_start(argp, Summ); 691de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls), ObjCMethodSummaries, Summ, argp); 6921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump va_end(argp); 693af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek } 6941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 69593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 696de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 697de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 698de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls),ObjCClassMethodSummaries, Summ, argp); 699de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 700de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(IdentifierInfo *II, const RetainSummary * Summ, ...) { 703de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 704de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 705de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(II, ObjCClassMethodSummaries, Summ, argp); 706de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 707de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 708de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7096b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 7101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7119c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummaryManager(ASTContext &ctx, bool gcenabled, bool usesARC) 712179064eb831125630c296556dd6d67e67f716143Ted Kremenek : Ctx(ctx), 713f85e193739c953358c865005855253af4f68a497John McCall GCEnabled(gcenabled), 714f85e193739c953358c865005855253af4f68a497John McCall ARCEnabled(usesARC), 715f85e193739c953358c865005855253af4f68a497John McCall AF(BPAlloc), ScratchArgs(AF.getEmptyMap()), 716f85e193739c953358c865005855253af4f68a497John McCall ObjCAllocRetE(gcenabled 717f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 718f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 719f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwned(RetEffect::ObjC, true))), 720f85e193739c953358c865005855253af4f68a497John McCall ObjCInitRetE(gcenabled 721f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 722f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 723f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwnedWhenTrackedReceiver())), 7243baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek DefaultSummary(AF.getEmptyMap() /* per-argument effects (none) */, 7257faca821633c9521030127bf7f42f032c73b24e2Ted Kremenek RetEffect::MakeNoRet() /* return effect */, 726ebd5a2dc1a3743fed9157379d89e5eb26293c9d6Ted Kremenek MayEscape, /* default argument effect */ 727ebd5a2dc1a3743fed9157379d89e5eb26293c9d6Ted Kremenek DoNothing /* receiver effect */), 728b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek StopSummary(0) { 729553cf18cd44769a7624fc942493f076498527529Ted Kremenek 730553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeClassMethodSummaries(); 731553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeMethodSummaries(); 732553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 7331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7340507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getSummary(const FunctionDecl *FD); 7351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 7378bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state, 73893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const LocationContext *LC); 739dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 7400507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 74193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCInterfaceDecl *ID) { 742432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis return getInstanceMethodSummary(msg.getSelector(), 0, 743432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis ID, msg.getMethodDecl(), msg.getType(Ctx)); 7448711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 7451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7460507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getInstanceMethodSummary(Selector S, 74793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek IdentifierInfo *ClsName, 74893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCInterfaceDecl *ID, 74993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD, 75093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek QualType RetTy); 751fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek 75293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getClassMethodSummary(Selector S, 75393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek IdentifierInfo *ClsName, 75493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCInterfaceDecl *ID, 75593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD, 75693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek QualType RetTy); 7571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 75893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getClassMethodSummary(const ObjCMessage &msg) { 759432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const ObjCInterfaceDecl *Class = 0; 760432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis if (!msg.isInstanceMessage()) 761432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis Class = msg.getReceiverInterface(); 76204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 763432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis return getClassMethodSummary(msg.getSelector(), 76404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Class? Class->getIdentifier() : 0, 76504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Class, 766432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis msg.getMethodDecl(), msg.getType(Ctx)); 767fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek } 768552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek 769552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// getMethodSummary - This version of getMethodSummary is used to query 770552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// the summary for the current method being analyzed. 77193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getMethodSummary(const ObjCMethodDecl *MD) { 772a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek // FIXME: Eventually this should be unneeded. 773a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID = MD->getClassInterface(); 77470a6576c9c8d21ff2361574f4937a2e73bd57779Ted Kremenek Selector S = MD->getSelector(); 775552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek IdentifierInfo *ClsName = ID->getIdentifier(); 776552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek QualType ResultTy = MD->getResultType(); 7771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 778552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek if (MD->isInstanceMethod()) 779552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek return getInstanceMethodSummary(S, ClsName, ID, MD, ResultTy); 780552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek else 781552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek return getClassMethodSummary(S, ClsName, ID, MD, ResultTy); 782552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek } 7831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7840507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCommonMethodSummary(const ObjCMethodDecl *MD, 78593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Selector S, QualType RetTy); 786a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek 78793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7884dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD); 7894dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 79093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7914dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD); 7924dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 793d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek bool isGCEnabled() const { return GCEnabled; } 7941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 795f85e193739c953358c865005855253af4f68a497John McCall bool isARCEnabled() const { return ARCEnabled; } 796f85e193739c953358c865005855253af4f68a497John McCall 797f85e193739c953358c865005855253af4f68a497John McCall bool isARCorGCEnabled() const { return GCEnabled || ARCEnabled; } 798f85e193739c953358c865005855253af4f68a497John McCall 79993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *copySummary(const RetainSummary *OldSumm) { 80093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 801885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek new (Summ) RetainSummary(*OldSumm); 802885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek return Summ; 8031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 8046b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 8051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8060fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// Used to avoid allocating long-term (BPAlloc'd) memory for default retain 8070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// summaries. If a function or method looks like it has a default summary, but 8080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// it has annotations, the annotations are added to the stack-based template 8090fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// and then copied into managed memory. 8100fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Roseclass RetainSummaryTemplate { 8110fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &Manager; 81293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *&RealSummary; 81393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *BaseSummary; 8140fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary ScratchSummary; 8150fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose bool Accessed; 8160fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rosepublic: 81793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummaryTemplate(const RetainSummary *&real, const RetainSummary &base, 8180fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &manager) 81993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek : Manager(manager), 82093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RealSummary(real), 82193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek BaseSummary(&base), 82293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ScratchSummary(base), 82393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Accessed(false) {} 8240fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8250fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose ~RetainSummaryTemplate() { 82693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek if (Accessed) 8270fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RealSummary = Manager.copySummary(&ScratchSummary); 82893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek else if (!RealSummary) 82993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RealSummary = BaseSummary; 8300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8310fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary &operator*() { 8330fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 83493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return ScratchSummary; 8350fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8360fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8370fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *operator->() { 8380fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 83993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return &ScratchSummary; 8400fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8410fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose}; 8420fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8436b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end anonymous namespace 8446b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 8456b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8466b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek// Implementation of checker data structures. 8476b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8486b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 849b77449cead63264650958c92cb30609c942cc5e9Ted KremenekArgEffects RetainSummaryManager::getArgEffects() { 850b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects AE = ScratchArgs; 8513baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.getEmptyMap(); 852b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return AE; 85300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 85400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 85593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 856b77449cead63264650958c92cb30609c942cc5e9Ted KremenekRetainSummaryManager::getPersistentSummary(ArgEffects AE, RetEffect RetEff, 8571bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek ArgEffect ReceiverEff, 858e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect DefaultEff) { 859891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Create the summary and return it. 86093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 861e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose new (Summ) RetainSummary(AE, RetEff, DefaultEff, ReceiverEff); 86200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek return Summ; 86300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 86400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 865d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 866d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for functions (largely uses of Core Foundation). 867d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 86800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 8699c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRetain(const FunctionDecl *FD, StringRef FName) { 870b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Retain"); 8711261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8721261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 8739c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRelease(const FunctionDecl *FD, StringRef FName) { 874b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Release"); 8751261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8761261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 87776c506fba2359296d1f19e64998bd11d7b864563Jordy Rosestatic bool isMakeCollectable(const FunctionDecl *FD, StringRef FName) { 87876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Remove FunctionDecl parameter. 87976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Is it really okay if MakeCollectable isn't a suffix? 88076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return FName.find("MakeCollectable") != StringRef::npos; 88176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 88276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 88393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * RetainSummaryManager::getSummary(const FunctionDecl *FD) { 884891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 885d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 886d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 887891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 888891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 889e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 89093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *S = 0; 8911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 89237d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 8931261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 8941261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 8951261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 8961261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 8971261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 8989ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // For C++ methods, generate an implicit "stop" summary as well. We 8999ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // can relax this once we have a clear policy for C++ methods and 9009ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // ownership attributes. 9019ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek if (isa<CXXMethodDecl>(FD)) { 9029ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek S = getPersistentStopSummary(); 9039ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek break; 9049ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek } 9051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 906183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 90799890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 908183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 90948c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 91048c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 91148c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 912b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 913b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 9141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 915bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 916bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 917b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 9181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9191261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 9201261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 9211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9221261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 9231261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 924008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 925e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 926b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer if (FName == "pthread_create") { 927b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of: <rdar://problem/7299394>. This will be addressed 928b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // better with IPA. 929b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 930b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 931b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 932b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 933b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 934b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 935b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 936b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 937b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 938b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 939b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 940b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 941b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 942b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 943b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 944b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 945b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 946b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 947b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 948b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 9493baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 950b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 951b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 952b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 953b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 954b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 9553baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 956b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 957b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 958b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 959b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 960b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 961b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 962b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 963b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 9643baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 965b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 966b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 967b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 968b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 969b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 970b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 9713baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 972b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 973b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 974b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 975b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 976b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 977b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 978b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 979b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 9803baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 981b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 982b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 9831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 984b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 985b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 986b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 98761991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 98861991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Enable this code once the semantics of NSDeallocateObject are resolved 98961991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // for GC. <rdar://problem/6619988> 99061991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#if 0 99161991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Handle: NSDeallocateObject(id anObject); 99261991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // This method does allow 'nil' (although we don't check it now). 9931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (strcmp(FName, "NSDeallocateObject") == 0) { 99461991903335144605031c3597a5c99e1565b0bd4Ted Kremenek return RetTy == Ctx.VoidTy 99561991903335144605031c3597a5c99e1565b0bd4Ted Kremenek ? getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, Dealloc) 99661991903335144605031c3597a5c99e1565b0bd4Ted Kremenek : getPersistentStopSummary(); 99761991903335144605031c3597a5c99e1565b0bd4Ted Kremenek } 99861991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#endif 9991261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10001261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (RetTy->isPointerType()) { 10011261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 100278acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 10031261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10041261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 100576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 10061261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 10071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 10087df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10091261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 101037d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 101137d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10121261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10131261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 101478acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 10151261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10161261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 10171261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 10187df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10191261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 102037d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 102137d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10221261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10231261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 102478acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 102578acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 102678acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 10277df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1028706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1029706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 10301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10311261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 103237d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10331261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10341261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 10351261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 10361261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1037e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1038b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1039e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1040bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 10411261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 10421261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1043b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 10446818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 10456818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 10466818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 10476818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 10486818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 10506818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 10511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 10526818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 10536818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10546818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1055c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1056c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1057c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1058c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1059e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1060e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1061e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1062e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1063c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 10646818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 10651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10666818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 10671261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 106864e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 106937d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 107037d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 10711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10724dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 10734df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(S, FD); 10741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1075d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 10761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 10772fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 10782fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 107993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 10807df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 10817df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 108286ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 10831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1084d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 108500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 108600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 108793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 10886ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 10896ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 10906ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 10911261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 10921261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 109372564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 10941261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 10951261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 10961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1097b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 10981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1100377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 110176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 110276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 110376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 1104940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 110576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 110676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 110776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 110800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 110900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 111093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11119c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1112b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11142d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 111500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 111600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 111793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11189c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 11191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 11202d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 11212d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 112200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 112300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 11246b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1125d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1126d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1127d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 112893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11298711c03dda12863a7537f14025513f7717b14ce1Ted KremenekRetainSummaryManager::getInitMethodSummary(QualType RetTy) { 11301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(ScratchArgs.isEmpty()); 113178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek // 'init' methods conceptually return a newly allocated object and claim 11321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // the receiver. 11330556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek if (cocoa::isCocoaObjectRef(RetTy) || 11340556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek coreFoundation::isCFObjectRef(RetTy)) 1135547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek return getPersistentSummary(ObjCInitRetE, DecRefMsg); 11361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 113793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 113846e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek} 11394dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11404dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 114193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 11424dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 11434dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 11444dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11454dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11460fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryTemplate Template(Summ, DefaultSummary, *this); 11474df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 114811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 114911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 115011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 115198b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 115211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 115311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 11544df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 11550fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 11564df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 11574df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 11580fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 115911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 116011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 116111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1162b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 11631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11644dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 116578acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 116640b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 11670fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 11684dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 116940b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 11700fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1171b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 11726041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>()) { 11730fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 11746041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11756041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11760fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 11776041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11784df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (RetTy->getAs<PointerType>()) { 117940b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 11800fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 11814dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1182d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11830fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1184d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 11854dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 11864dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 11874dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11884dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 118993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 119093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD) { 11914dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 11924dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11934dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11940fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryTemplate Template(Summ, DefaultSummary, *this); 11957acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek 11967acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek // Check the method family, and apply any default annotations. 11977acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek switch (MD->getMethodFamily()) { 11987acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_None: 11997acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek break; 12007acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_init: 12017acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek Template->setRetEffect(ObjCInitRetE); 12027acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek Template->setReceiverEffect(DecRefMsg); 12037acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek break; 12047acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_alloc: 12057acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_new: 12067acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_copy: 12077acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_mutableCopy: 12087acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek Template->setRetEffect(ObjCAllocRetE); 12097acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek break; 12107acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_autorelease: 12117acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek Template->setReceiverEffect(Autorelease); 12127acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_retain: 12137acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek Template->setReceiverEffect(IncRefMsg); 12147acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek break; 12157acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_release: 12167acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek Template->setReceiverEffect(DecRefMsg); 12177acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek break; 12187acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_self: 12197acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_performSelector: 12207acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_retainCount: 12217acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_dealloc: 12227acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek case OMF_finalize: 12237acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek break; 12247acf23f03e4598d9a68d4a5e5441947300f0d32cTed Kremenek } 12254df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 12266d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 12271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 122812b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 122912b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 123011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12310fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 123211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 123311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 123411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 123511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1236491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1237491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 123811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 123911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 124011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 124111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12420fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 124311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 124411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 12450fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 124611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 124712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 124812b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 12494dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 125078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 125140b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 12520fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 12536d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 12544dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 12556041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>()) { 12560fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 12576041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 12586041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12606d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 12610fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 12626217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 12630fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 12641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12656041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 12666041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 12670fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 12686041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 12690fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 12706041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12714dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 12724dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 127393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12749c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCommonMethodSummary(const ObjCMethodDecl *MD, 1275a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek Selector S, QualType RetTy) { 12768ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek 1277fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek if (MD) { 1278376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Scan the method decl for 'void*' arguments. These should be treated 1279376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // as 'StopTracking' because they are often used with delegates. 1280376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Delegates are a frequent form of false positives with the retain 1281376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // count checker. 1282376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek unsigned i = 0; 1283491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator I = MD->param_begin(), 1284376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek E = MD->param_end(); I != E; ++I, ++i) 1285491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis if (const ParmVarDecl *PD = *I) { 1286376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek QualType Ty = Ctx.getCanonicalType(PD->getType()); 1287a4923eb7c4b04d360cb2747641a5e92818edf804Douglas Gregor if (Ty.getLocalUnqualifiedType() == Ctx.VoidPtrTy) 12883baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, i, StopTracking); 1289376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 1290376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 12911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12928ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // Any special effect for the receiver? 12938ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 12941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12958ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 12968ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 12978ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 12988ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 12998ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 13008ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek const std::string &str = S.getAsString(); 13018ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek assert(!str.empty()); 1302e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer if (StrInStrNoCase(str, "delegate:") != StringRef::npos) 1303e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ReceiverEff = StopTracking; 13048ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 13051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1306250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek // Look for methods that return an owned object. 130778acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 130828f47b92e760ccf641ac91cb0fe1c12d9ca89795Ted Kremenek // EXPERIMENTAL: assume the Cocoa conventions for all objects returned 130992511433cc78021dca5f340136be1bbd72388191Ted Kremenek // by instance methods. 1310786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor RetEffect E = cocoa::followsFundamentalRule(S, MD) 13117db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek ? ObjCAllocRetE : RetEffect::MakeNotOwned(RetEffect::ObjC); 13121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return getPersistentSummary(E, ReceiverEff, MayEscape); 1314376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 13151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 131692511433cc78021dca5f340136be1bbd72388191Ted Kremenek // Look for methods that return an owned core foundation object. 13170556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek if (coreFoundation::isCFObjectRef(RetTy)) { 1318786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor RetEffect E = cocoa::followsFundamentalRule(S, MD) 13197db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek ? RetEffect::MakeOwned(RetEffect::CF, true) 13207db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek : RetEffect::MakeNotOwned(RetEffect::CF); 13211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 132292511433cc78021dca5f340136be1bbd72388191Ted Kremenek return getPersistentSummary(E, ReceiverEff, MayEscape); 132392511433cc78021dca5f340136be1bbd72388191Ted Kremenek } 13241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 132592511433cc78021dca5f340136be1bbd72388191Ted Kremenek if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing) 132693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 13271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1328885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek return getPersistentSummary(RetEffect::MakeNoRet(), ReceiverEff, MayEscape); 1329250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1330250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 133193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1332432424d67641d609e4990d791baa782fc161027eArgyrios KyrtzidisRetainSummaryManager::getInstanceMethodSummary(const ObjCMessage &msg, 13338bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state, 1334b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek const LocationContext *LC) { 1335b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1336b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // We need the type-information of the tracked receiver object 1337b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Retrieve it from the state. 1338432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const Expr *Receiver = msg.getInstanceReceiver(); 13399c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID = 0; 1340b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1341b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: Is this really working as expected? There are cases where 1342b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we just use the 'ID' from the message expression. 134304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor SVal receiverV; 134404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 13458f326751df18e78bdb7edf786a842def8a4f41e3Ted Kremenek if (Receiver) { 13465eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek receiverV = state->getSValAsScalarOrLoc(Receiver, LC); 1347dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 134804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Eventually replace the use of state->get<RefBindings> with 134904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // a generic API for reasoning about the Objective-C types of symbolic 135004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // objects. 135104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (SymbolRef Sym = receiverV.getAsLocSymbol()) 135204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const RefVal *T = state->get<RefBindings>(Sym)) 1353dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek if (const ObjCObjectPointerType* PT = 1354b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 135504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 1356dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 135704badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: this is a hack. This may or may not be the actual method 135804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // that is called. 135904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (!ID) { 136004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const ObjCObjectPointerType *PT = 136104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Receiver->getType()->getAs<ObjCObjectPointerType>()) 136204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 136304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } 136404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } else { 136504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Hack for 'super'. 1366432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis ID = msg.getReceiverInterface(); 1367b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 136804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1369b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1370b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 13714df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return getInstanceMethodSummary(msg, ID); 1372b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1373b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 137493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1375ce8a41d020d0b171535d77f73adb8acb3e6a881eTed KremenekRetainSummaryManager::getInstanceMethodSummary(Selector S, 1376ce8a41d020d0b171535d77f73adb8acb3e6a881eTed Kremenek IdentifierInfo *ClsName, 13779c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID, 1378a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCMethodDecl *MD, 1379ce8a41d020d0b171535d77f73adb8acb3e6a881eTed Kremenek QualType RetTy) { 13801bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 13818711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 138293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = ObjCMethodSummaries.find(ID, ClsName, S); 13831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1384614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1385614cc540a617978814e37d75bf5066926b921a0aTed Kremenek assert(ScratchArgs.isEmpty()); 13861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1387614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // "initXXX": pass-through for receiver. 1388786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor if (cocoa::deriveNamingConvention(S, MD) == cocoa::InitRule) 1389614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getInitMethodSummary(RetTy); 1390614cc540a617978814e37d75bf5066926b921a0aTed Kremenek else 1391614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getCommonMethodSummary(MD, S, RetTy); 13921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1393614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 13944df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 13951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1396614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 1397614cc540a617978814e37d75bf5066926b921a0aTed Kremenek ObjCMethodSummaries[ObjCSummaryKey(ID, ClsName, S)] = Summ; 1398614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 13991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1400e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 140146e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek} 140246e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek 140393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1404fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed KremenekRetainSummaryManager::getClassMethodSummary(Selector S, IdentifierInfo *ClsName, 1405a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID, 1406a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCMethodDecl *MD, 1407a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek QualType RetTy) { 1408de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 1409fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek assert(ClsName && "Class name must be specified."); 141093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = ObjCClassMethodSummaries.find(ID, ClsName, S); 14111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1412614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1413614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getCommonMethodSummary(MD, S, RetTy); 14144df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1415614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 14164df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 14174df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1418614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 1419614cc540a617978814e37d75bf5066926b921a0aTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ID, ClsName, S)] = Summ; 1420614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 14211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1422e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1423c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1424c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 14251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1426ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 14271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 14286fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 14292d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 14301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14316d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 14323baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 14336fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 14346fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 14356fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 14361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1437de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // Create the summaries for [NSObject performSelector...]. We treat 1438de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // these as 'stop tracking' for the arguments because they are often 1439de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // used for delegates that can release the object. When we have better 1440de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // inter-procedural analysis we can potentially do something better. This 1441de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // workaround is to remove false positives. 144293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = 1443012614ecf78442368ec82ee30efb3bc047b413e6Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, StopTracking); 1444de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek IdentifierInfo *NSObjectII = &Ctx.Idents.get("NSObject"); 1445de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1446de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", NULL); 1447de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1448de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", "inModes", NULL); 1449de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1450de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1451de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1452de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1453de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1454de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1455de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1456de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1457de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorInBackground", 1458de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", NULL); 14599c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 14609c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 14611f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 14621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 14641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1465c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1466c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 146793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1468ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1469ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1470ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1471ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1472ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1473ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 14741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1475c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 147693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 147793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *CFAllocSumm = 1478a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 14791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14803c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1481500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 148293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1483553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 14841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14853c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1486500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1487553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 14881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1489299e8158d63d69830cca0187f4003cba1e66081fTed Kremenek // Create the "drain" selector. 1490500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, isGCEnabled() ? DoNothing : DecRef); 1491553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); 14921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1493f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1494500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1495f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 14963c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 14973c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1498500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1499553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 15001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1501f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek // Specially handle NSAutoreleasePool. 15026c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek addInstMethSummary("NSAutoreleasePool", "init", 1503500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose getPersistentSummary(NoRet, NewAutoreleasePool)); 15041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 150689e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 150789e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 150889e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 150989e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 15103aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 151193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 151278a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 151378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 15141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 151599d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 151699d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 15173aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#if 0 151878a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1519af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 152178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1522af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 15233aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#endif 15241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1525179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1526179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 152799d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 152899d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 152999d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 15301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 153178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#if 0 153278a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1533af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 153578a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1536af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 153778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#endif 15381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1539ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // Don't track allocated autorelease pools yet, as it is okay to prematurely 1540ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1541ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1542a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek addClassMethSummary("NSAutoreleasePool", "allocWithZone", NoTrackYet, false); 1543553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1544767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1545767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1546767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1547767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1548767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1549767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1550211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1551a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1552a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1553a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1554767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1555a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 15561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1557a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1558211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1559b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1560b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1561d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 15624d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek// AutoreleaseBindings - State used to track objects in autorelease pools. 15636d34893fc886f4153f104de8880876764981cb7fTed Kremenek//===----------------------------------------------------------------------===// 15646d34893fc886f4153f104de8880876764981cb7fTed Kremenek 15654d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, unsigned> ARCounts; 15664d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, ARCounts> ARPoolContents; 15674d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableList<SymbolRef> ARStack; 1568f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek 15694d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenekstatic int AutoRCIndex = 0; 15706d34893fc886f4153f104de8880876764981cb7fTed Kremenekstatic int AutoRBIndex = 0; 15716d34893fc886f4153f104de8880876764981cb7fTed Kremenek 1572ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleasePoolContents {}; } 1573ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleaseStack {}; } 15744d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 15756d34893fc886f4153f104de8880876764981cb7fTed Kremeneknamespace clang { 15769ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 157718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleaseStack> 157818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARStack> { 15799c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRBIndex; } 15804d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15814d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 158218c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleasePoolContents> 158318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARPoolContents> { 15849c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRCIndex; } 15854d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15865a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 15874d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek} // end clang namespace 15886d34893fc886f4153f104de8880876764981cb7fTed Kremenek 15898bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic SymbolRef GetCurrentAutoreleasePool(ProgramStateRef state) { 15907037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARStack stack = state->get<AutoreleaseStack>(); 15917037ab8f15950e594642adf77a56d299667debe7Ted Kremenek return stack.isEmpty() ? SymbolRef() : stack.getHead(); 15927037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 15937037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 15948bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic ProgramStateRef 15958bef8238181a30e52dea380789a7e2d760eac532Ted KremenekSendAutorelease(ProgramStateRef state, 159618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ARCounts::Factory &F, 159718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek SymbolRef sym) { 15987037ab8f15950e594642adf77a56d299667debe7Ted Kremenek SymbolRef pool = GetCurrentAutoreleasePool(state); 1599b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const ARCounts *cnts = state->get<AutoreleasePoolContents>(pool); 16007037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARCounts newCnts(0); 16011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 16027037ab8f15950e594642adf77a56d299667debe7Ted Kremenek if (cnts) { 16037037ab8f15950e594642adf77a56d299667debe7Ted Kremenek const unsigned *cnt = (*cnts).lookup(sym); 16043baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(*cnts, sym, cnt ? *cnt + 1 : 1); 16057037ab8f15950e594642adf77a56d299667debe7Ted Kremenek } 16067037ab8f15950e594642adf77a56d299667debe7Ted Kremenek else 16073baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(F.getEmptyMap(), sym, 1); 16081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1609b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek return state->set<AutoreleasePoolContents>(pool, newCnts); 16107037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 16117037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 16121392261ff4418a070fb919cb4832b76b468b6faaTed Kremenek//===----------------------------------------------------------------------===// 1613c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1614c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1615c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1616ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1617ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1618ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1619c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1620c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 16211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 16221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1623ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1624c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 162535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 162635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : BugType(name, "Memory (Core Foundation/Objective-C)") {} 1627c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1629c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 163035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 16311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1632c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1633c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1635ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1636c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 163735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 163935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1640c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1642c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1644ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1645c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 164635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 16471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 164835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1649bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1650bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1651b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1652c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1654ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1655c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 165635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 165735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 16581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1659c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1660369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 16611499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1662c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1664ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1665c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 166635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 166735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 16681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1669c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1670c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 167100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 16721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1674ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1675369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 167635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 167735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 16781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1679369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1680eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1681369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1682369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 16831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1684ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1685e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 168635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 168735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 16881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1689e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 16905b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1691e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1692e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1693e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 16941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1695ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1696c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const bool isReturn; 1697c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 169835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose Leak(StringRef name, bool isRet) 1699db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose : CFRefBug(name), isReturn(isRet) { 1700db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1701db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1702db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 1703c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 170535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 17061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1707c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1708c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1710ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class LeakAtReturn : public Leak { 1711c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 171235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose LeakAtReturn(StringRef name) 171335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Leak(name, true) {} 1714c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1716ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class LeakWithinFunction : public Leak { 1717c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 171835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose LeakWithinFunction(StringRef name) 171935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Leak(name, false) {} 17201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 17211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1722c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1723c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1724c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 17251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1726dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks class CFRefReportVisitor : public BugReporterVisitor { 172723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1728dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1729ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 173035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 173123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1732dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 173335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 173435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1735dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 173623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1737dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1738dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1739dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1740dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1741dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 174223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 174323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 174423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 174523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 174623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 174723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 174823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 174923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 175023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 175123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 175223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 175323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 175435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1755ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 175635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 175723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 175823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 175923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 176023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1761dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1762dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1763e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 17642058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 176535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1766c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17672058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17682058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17692058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1770edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 177123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 17722058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17732058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1774dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1775eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 17762058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17772058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17782058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1779edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 17802058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17812058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1782dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 17831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1784e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1785edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1786edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1787e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1788c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1789640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1790c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1791c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1792eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1793ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1794c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 179523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1796c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17972058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17982058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17996a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx); 18001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1801590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1802590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1803590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1804590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 18051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 18065216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 18075216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 18082058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 18092058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1810f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 18111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1812e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 18137f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 18142058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 181535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 181635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18187f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 18192058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 182035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 182135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18237f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 18242058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 182535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 182635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 182735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 182835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 182935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 183035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 183135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 183235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 183335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18347f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1835c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 183635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1837f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 183835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1839c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1840e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1841910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18425f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1843c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18445f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1845c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1846c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 18471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1848c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1849c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1850c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 18514c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenekstatic bool isPropertyAccess(const Stmt *S, ParentMap &PM) { 18524c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek unsigned maxDepth = 4; 18534c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek while (S && maxDepth) { 18544c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek if (const PseudoObjectExpr *PO = dyn_cast<PseudoObjectExpr>(S)) { 18554c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek if (!isa<ObjCMessageExpr>(PO->getSyntacticForm())) 18564c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return true; 18574c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return false; 18584c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek } 18594c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek S = PM.getParent(S); 18604c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek --maxDepth; 18614c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek } 18624c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return false; 18634c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek} 18644c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek 1865dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1866dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1867dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1868dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 18691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1870f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<StmtPoint>(N->getLocation())) 18712033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 18721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18738966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 18748bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef PrevSt = PrevN->getState(); 18758bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef CurrSt = N->getState(); 18765eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = N->getLocationContext(); 18771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const RefVal* CurrT = CurrSt->get<RefBindings>(Sym); 1879c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 18801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1881b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 1882b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal *PrevT = PrevSt->get<RefBindings>(Sym); 18831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1884c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1885c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1886c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1887c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 18881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1889c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1890c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1891c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 1892f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 18931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (isa<ObjCArrayLiteral>(S)) { 18951a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSArray literal is an object with a +0 retain count"; 18961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 18971a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else if (isa<ObjCDictionaryLiteral>(S)) { 18981a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSDictionary literal is an object with a +0 retain count"; 1899c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19001a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19011a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 19021a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Get the name of the callee (if it is available). 19031a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee(), LCtx); 19041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 19051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "Call to function '" << *FD << '\''; 19061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else 19071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "function call"; 19081a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19091a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(isa<ObjCMessageExpr>(S)); 19111a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // The message expression may have between written directly or as 19121a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // a property access. Lazily determine which case we are looking at. 19131a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << (isPropertyAccess(S, N->getParentMap()) ? "Property" : "Method"); 19141a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19161a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 19171a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns a Core Foundation object with a "; 19181a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19191a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19201a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 19211a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns an Objective-C object with a "; 19221a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19241a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.isOwned()) { 19251a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+1 retain count"; 19261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19271a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (GCEnabled) { 19281a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 19291a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << ". " 19301a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek "Core Foundation objects are not automatically garbage collected."; 19311a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19321a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19331a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19341a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.isNotOwned()); 19351a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+0 retain count"; 1936c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1937cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1939220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 1940220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 1941c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 1942cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1944c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 1945c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 19465f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 19471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1948ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 1949ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 1950c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 1951c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 1952f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19545f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1955c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 1956c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 1957c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 19581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19595f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 1960c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 19611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1962c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 1963c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 19645eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI, LCtx).getAsLocSymbol() != Sym) 1965c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 19661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1967c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 1968c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 1969c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1970c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 197204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 19735eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver, LCtx) 19745eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek .getAsLocSymbol() == Sym) { 1975c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 1976c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 1977c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1978c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19791c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 19801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1981c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 1982c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 1983c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 19841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1985c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 198635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 1987c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 1988c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 1989c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 1990c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 1991c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 1992f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 1993c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 1994f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 1995f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 1996c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1998c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 1999c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 2000c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 2001f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 20025eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = 20035eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee(), LCtx); 20049c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 20051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 200635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 2007c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2008c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 20091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2010b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "In GC mode a call to '" << *FD 2011c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 2012c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 20131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2014c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2015c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 2016c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 2017c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 2018c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2019c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2020c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 2021c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 2022c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 20233eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 20241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 2025b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "When GC is not enabled a call to '" << *FD 2026c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 20271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2028c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 2029c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2030c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 2033c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 2034c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 20351ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 20361ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 20371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2038f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 2039f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 2040f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 2041f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 20421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2043264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 2044eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 2045f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 2046f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 20471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2048c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 2049c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 2050c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2051c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 20521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2053c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 2054c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 20551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2056c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 205735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 205874b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << " The object is not eligible for garbage collection until " 205974b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "the retain count reaches 0 again."; 2060c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2062c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20641ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2065c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 20661ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 20671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2068c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 206974b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose // Autoreleases can be applied after marking a node ReturnedOwned. 207074b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose if (CurrV.getAutoreleaseCount()) 207174b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose return NULL; 207274b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose 207374b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << "Object returned to caller as an owning reference (single " 207474b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "retain count transferred to caller)"; 2075c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2077c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2078f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2079c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2081c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2082c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2083c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2085c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 20865f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2087c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 20881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2089c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 209035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2091c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2092c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2093c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2094c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2095c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2096c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2097c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2098c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2099c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2100c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2101c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2102c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2103c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 21051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2106c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2107c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 21082033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 2109f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 2110220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2111220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 21129c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 21131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2114c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2115c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 21161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 21175f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 21189c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 21195eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp, LCtx).getAsLocSymbol() == Sym) { 2120c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2121c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2122c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2124c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2125c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2126c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2127c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 2128ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class FindUniqueBinding : 2129c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public StoreManager::BindingsHandler { 2130c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym; 2131c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* Binding; 2132c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool First; 21331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2134c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 2135c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek FindUniqueBinding(SymbolRef sym) : Sym(sym), Binding(0), First(true) {} 21361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2137c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool HandleBinding(StoreManager& SMgr, Store store, const MemRegion* R, 2138c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SVal val) { 21391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SymbolRef SymV = val.getAsSymbol(); 2141c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!SymV || SymV != Sym) 2142c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return true; 21431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2144c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (Binding) { 2145c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek First = false; 2146c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 2147c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2148c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2149c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Binding = R; 21501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return true; 2152c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2154c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek operator bool() { return First && Binding; } 21550507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const MemRegion *getRegion() { return Binding; } 21561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 2157c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 21589e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek 2159e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// Find the first node in the current function context that referred to the 2160e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// tracked symbol and the memory location that value was stored to. Note, the 2161e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// value is only reported if the allocation occurred in the same function as 2162e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// the leak. 2163c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 216418c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2165c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 21669c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 21671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 2168e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks const LocationContext *LeakContext = N->getLocationContext(); 21691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2170c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 21718bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St = N->getState(); 2172c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefBindings B = St->get<RefBindings>(); 21731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2174c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!B.lookup(Sym)) 2175940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 21761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2177c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek FindUniqueBinding FB(Sym); 21781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 21791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 21801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2181e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // Allocation node, is the last node in the current context in which the 2182e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // symbol was tracked. 2183e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() == LeakContext) 2184e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks Last = N; 2185e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 21861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 21871ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 21881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2189e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // If allocation happened in a function different from the leak node context, 2190e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // do not report the binding. 2191e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() != LeakContext) { 2192e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks FirstBinding = 0; 2193e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks } 2194e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 2195c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 21966b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 21976b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2198c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 219923f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 220023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 220123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 220276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 220323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2204c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2205fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2206c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 220723f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 220823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 220923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 22101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22118966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2212c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 221376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 22141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2215c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2216c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2217c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 22189c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2219c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 22201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2221c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2222f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 22231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22244fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 22251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2226c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2227c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2228c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 22299c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 22304fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 22311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2232c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2233c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 22341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2235f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 22361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2237f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2238f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2239f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2240f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2241f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2242f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 22431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2244c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 2245c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const RefVal* RV = EndN->getState()->get<RefBindings>(Sym); 22461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2247c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2248c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 22495b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2250c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2251d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2252d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2253d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek os << " is returned from a method whose name ('" 2254d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << MD->getSelector().getAsString() 2255d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 22565b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose " This violates the naming convention rules" 2257f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " given in the Memory Management Guide for Cocoa"; 2258d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2259d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2260d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2261b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek os << " is returned from a function whose name ('" 2262a59d20b135bfde058a5a69045bab5ec4e2553f74Benjamin Kramer << *FD 2263d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 2264b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek " convention rules given in the Memory Management Guide for Core" 2265f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " Foundation"; 2266d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2267c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2268e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 22699c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2270e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 227182f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 227282f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 227382f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 227482f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2275e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2276c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2277abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2278f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 22791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2280c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2281c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2282cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 22832058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 22842058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 22852058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 22866a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx) 22872058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 22881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2289fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2290c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2291c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2292c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2293c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2294c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2295c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2296c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 22979c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 22981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22996a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const SourceManager& SMgr = Ctx.getSourceManager(); 2300590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2301c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 23026a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks GetAllocationSite(Ctx.getStateManager(), getErrorNode(), sym); 23031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2304c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2305c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 2306590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks const Stmt *AllocStmt = cast<PostStmt>(P).getStmt(); 2307590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2308590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2309c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2310c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2311c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2312dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 23132058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2314dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2315212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << "of an object"; 23161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2317c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2318c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2319212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << " stored into '" << AllocBinding->getString() << '\''; 2320dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 23212058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2322c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2323c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2324c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2325c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2326c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2327c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2328d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2329910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 23309c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 233138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 23329c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 233338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::EndPath, 23346704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2335f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 2336294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostStmt<CallExpr>, 2337537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose check::PostStmt<CXXConstructExpr>, 23381a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCArrayLiteral>, 23391a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCDictionaryLiteral>, 2340294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostObjCMessage, 2341f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 23426704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 234376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 234476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 23456f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 23466f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 23476f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 23486f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 23496f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 235038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 235138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 235238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 235338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 235438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 235538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23566f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> Summaries; 23576f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> SummariesGC; 2358b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 2359e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose mutable ARCounts::Factory ARCountFactory; 2360e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 23619c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 23629c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 23639c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23642f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2365910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 236638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2367910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 236838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 236938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 237038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23719c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 23729c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 23739c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 23749c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 23759c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 23769c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 23779c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 23789c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 23799c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 23809c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 23819c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 23821ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23831ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 23841ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 23851ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 23861ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 23871ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23889c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 23899c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 23909c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 23919c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 23921ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23939c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 23949c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 23959c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 23969c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23979c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 23989c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 23999c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 24009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 24019c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 24029c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 24039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 24051ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 24061ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 240717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 240817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 240917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2410db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2411db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunctionGC.reset(new LeakWithinFunction("Leak of object when " 2412db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "using garbage " 2413db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "collection")); 241417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2415db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2416db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2417e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2418db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunction.reset(new LeakWithinFunction("Leak of object when " 2419db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "not using garbage " 2420db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "collection (GC) in " 2421db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "dual GC/non-GC " 2422db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "code")); 2423db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2424db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunction.reset(new LeakWithinFunction("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) 2434db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturnGC.reset(new LeakAtReturn("Leak of returned object when " 2435db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "using garbage collection")); 243617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2437db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2438db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2439e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2440db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturn.reset(new LeakAtReturn("Leak of returned object when " 2441db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "not using garbage collection " 2442db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "(GC) in dual GC/non-GC code")); 2443db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2444db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturn.reset(new LeakAtReturn("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; 2486294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostObjCMessage(const ObjCMessage &Msg, CheckerContext &C) const; 24871a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 2488294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkSummary(const RetainSummary &Summ, const CallOrObjCMessage &Call, 2489e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2490294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 249176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 249276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 24938bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond, 2494ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 24956704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 24968bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 24978bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek checkRegionChanges(ProgramStateRef state, 2498537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 2499537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 250066c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 250166c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks const CallOrObjCMessage *Call) const; 2502ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 25038bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool wantsRegionChangeUpdate(ProgramStateRef state) const { 25042f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2505ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2506294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2507f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2508f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2509f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 25108bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek SymbolRef Sym, ProgramStateRef state) const; 2511f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 251238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 2513af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks void checkEndPath(CheckerContext &C) const; 251438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25158bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef updateSymbol(ProgramStateRef state, SymbolRef sym, 251617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 251717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CheckerContext &C) const; 2518e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 25198bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void processNonLeakError(ProgramStateRef St, SourceRange ErrorRange, 2520294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2521294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 25221a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25231a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void processObjCLiterals(CheckerContext &C, const Expr *Ex) const; 2524294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 252538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 252638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25278bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef handleSymbolDeath(ProgramStateRef state, 252838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef sid, RefVal V, 252938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const; 253038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25318bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ExplodedNode *, ProgramStateRef > 25328bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek handleAutoreleaseCounts(ProgramStateRef state, 25338d22863184419faa2348bd5148c663197bc4bb00Jordy Rose GenericNodeBuilderRefCount Bd, ExplodedNode *Pred, 25346a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, SymbolRef Sym, RefVal V) const; 25358d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 25368bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *processLeaks(ProgramStateRef state, 253738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 253838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount &Builder, 25396a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 254038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2541d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2542d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2543d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 25446704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 25456704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 25468bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 25476704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 25488bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek StopTrackingCallback(ProgramStateRef st) : state(st) {} 25498bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return state; } 25506704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25516704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 25526704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 25536704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 25546704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 25556704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 25566704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 25576704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2558910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2559910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2560910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 25616704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2562910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2563910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2564dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2565910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2566dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2567469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 256838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2569dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 25708bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 257138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 25725eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek cast<BlockDataRegion>(state->getSVal(BE, 25735eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsRegion()); 2574dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 257538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 257638cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2577dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 257838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 257938cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2580dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 258267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 258367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 25845f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 258539ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2586c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2587dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 258967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion *VR = *I; 259067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 259167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 259267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 259367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 259467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2595dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 259667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 259767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 259867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 25990bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 260038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 260138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2602910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2603910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2604f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2605f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2606f85e193739c953358c865005855253af4f68a497John McCall return; 2607f85e193739c953358c865005855253af4f68a497John McCall 260871c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2609f85e193739c953358c865005855253af4f68a497John McCall 2610f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2611f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2612f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2613f85e193739c953358c865005855253af4f68a497John McCall return; 2614f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2615f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2616f85e193739c953358c865005855253af4f68a497John McCall break; 2617f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2618f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2619f85e193739c953358c865005855253af4f68a497John McCall break; 2620f85e193739c953358c865005855253af4f68a497John McCall } 2621f85e193739c953358c865005855253af4f68a497John McCall 26228bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26235eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CE, C.getLocationContext()).getAsLocSymbol(); 2624f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2625f85e193739c953358c865005855253af4f68a497John McCall return; 2626f85e193739c953358c865005855253af4f68a497John McCall const RefVal* T = state->get<RefBindings>(Sym); 2627f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2628f85e193739c953358c865005855253af4f68a497John McCall return; 2629f85e193739c953358c865005855253af4f68a497John McCall 2630f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 263117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2632f85e193739c953358c865005855253af4f68a497John McCall 2633f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2634e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2635e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2636f85e193739c953358c865005855253af4f68a497John McCall return; 2637f85e193739c953358c865005855253af4f68a497John McCall } 2638f85e193739c953358c865005855253af4f68a497John McCall 26390bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 2640f85e193739c953358c865005855253af4f68a497John McCall} 2641f85e193739c953358c865005855253af4f68a497John McCall 2642910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CallExpr *CE, 2643910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2644294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Get the callee. 26458bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2646294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Callee = CE->getCallee(); 26475eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal L = state->getSVal(Callee, C.getLocationContext()); 2648294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 264917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 265093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = 0; 2651294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2652294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Better support for blocks. For now we stop tracking anything 2653294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // that is passed to blocks. 2654294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Need to handle variables that are "captured" by the block. 2655294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (dyn_cast_or_null<BlockDataRegion>(L.getAsRegion())) { 2656294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getPersistentStopSummary(); 2657294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const FunctionDecl *FD = L.getAsFunctionDecl()) { 2658294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getSummary(FD); 2659294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const CXXMemberCallExpr *me = dyn_cast<CXXMemberCallExpr>(CE)) { 2660294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const CXXMethodDecl *MD = me->getMethodDecl()) 2661294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getSummary(MD); 2662294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2663294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2664294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 266593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Summ = Summaries.getDefaultSummary(); 2666294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 26675eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(CE, state, C.getLocationContext()), C); 2668294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2669294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2670910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CXXConstructExpr *CE, 2671910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2672537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const CXXConstructorDecl *Ctor = CE->getConstructor(); 2673537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Ctor) 2674537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2675537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 267617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 267793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = Summaries.getSummary(Ctor); 2678537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 2679537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose // If we didn't get a summary, this constructor doesn't affect retain counts. 2680537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Summ) 2681537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2682537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 26838bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26845eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(CE, state, C.getLocationContext()), C); 2685537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose} 2686537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 26871a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::processObjCLiterals(CheckerContext &C, 26881a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Expr *Ex) const { 26891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ProgramStateRef state = C.getState(); 26901a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const ExplodedNode *pred = C.getPredecessor(); 26911a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek for (Stmt::const_child_iterator it = Ex->child_begin(), et = Ex->child_end() ; 26921a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek it != et ; ++it) { 26931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Stmt *child = *it; 26941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal V = state->getSVal(child, pred->getLocationContext()); 26951a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = V.getAsSymbol()) 26961a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const RefVal* T = state->get<RefBindings>(sym)) { 26971a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek RefVal::Kind hasErr = (RefVal::Kind) 0; 26981a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = updateSymbol(state, sym, *T, MayEscape, hasErr, C); 26991a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (hasErr) { 27001a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processNonLeakError(state, child->getSourceRange(), hasErr, sym, C); 27011a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek return; 27021a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27031a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Return the object as autoreleased. 27071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // RetEffect RE = RetEffect::MakeNotOwned(RetEffect::ObjC); 27081a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = 27091a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state->getSVal(Ex, pred->getLocationContext()).getAsSymbol()) { 27101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek QualType ResultTy = Ex->getType(); 27111a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = state->set<RefBindings>(sym, RefVal::makeNotOwned(RetEffect::ObjC, 27121a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ResultTy)); 27131a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27141a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27151a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek C.addTransition(state); 27161a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27171a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27181a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCArrayLiteral *AL, 27191a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27201a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all values. 27211a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, AL); 27221a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27231a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27241a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCDictionaryLiteral *DL, 27251a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27261a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all keys and values. 27271a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, DL); 27281a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27291a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 2730910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostObjCMessage(const ObjCMessage &Msg, 2731910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 27328bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2733294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 273417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2735b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 273693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ; 2737294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Msg.isInstanceMessage()) { 2738a2a860306e3697fcf7a12c5ba59551ca60578968Anna Zaks const LocationContext *LC = C.getLocationContext(); 2739294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getInstanceMethodSummary(Msg, state, LC); 2740294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 2741294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getClassMethodSummary(Msg); 2742294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2743294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2744294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // If we didn't get a summary, this message doesn't affect retain counts. 2745294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 2746294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2747294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 27485eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(Msg, state, C.getLocationContext()), C); 2749294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2750294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2751910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2752910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2753910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// While the the return type can be queried directly from RetEx, when 2754910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2755910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2756910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2757910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2758910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2759910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2760910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2761910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2762910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2763910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2764910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2765910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2766910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2767910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2768910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2769910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2770910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2771910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2772910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2773910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2774910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2775910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2776910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2777910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2778910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2779910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 2780910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const CallOrObjCMessage &CallOrMsg, 2781910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 27828bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2783294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2784294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2785294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2786294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2787294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2788294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2789294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2790537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2791294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2792294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 2793294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RefBindings::data_type *T = state->get<RefBindings>(Sym)) { 279417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2795294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2796294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2797294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2798294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2799294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2800294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2801294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2802294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2803294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2804294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2805294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 2806e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (!hasErr && CallOrMsg.isObjCMessage()) { 280739ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2808e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose SVal Receiver = CallOrMsg.getInstanceMessageReceiver(LC); 2809e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (SymbolRef Sym = Receiver.getAsLocSymbol()) { 2810294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const RefVal *T = state->get<RefBindings>(Sym)) { 2811294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ReceiverIsTracked = true; 281217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 281317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose hasErr, C); 2814294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2815e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose ErrorRange = CallOrMsg.getReceiverSourceRange(); 2816294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2817294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2818294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2819294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2820294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2821294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2822294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2823294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2824294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2825294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2826294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2827294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2828294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2829294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2830294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2831294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2832b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 283317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2834b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2835294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2836294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2837294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2838294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2839294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 28407530c034c0c71a64c5a9173206d9742ae847af8bDavid Blaikie llvm_unreachable("Unhandled RetEffect."); 2841294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2842294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2843294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2844294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2845294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2846294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2847294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 28485eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 28495eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsSymbol(); 2850294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2851294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2852294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2853294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use the result type from callOrMsg as it automatically adjusts 2854294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 2855294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = CallOrMsg.getResultType(C.getASTContext()); 2856294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeOwned(RE.getObjKind(), 2857294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2858294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2859294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2860294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // *not* fail. (The code below is out-of-date, though.) 2861294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#if 0 2862294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedAllocatedSymbol) { 2863294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool isFeasible; 2864294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state.assume(loc::SymbolVal(Sym), true, isFeasible); 2865294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose assert(isFeasible && "Cannot assume fresh symbol is non-null."); 2866294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2867294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#endif 2868294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2869294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2870294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2871294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2872294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2873294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2874294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2875294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 28765eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(Ex, C.getLocationContext()).getAsSymbol(); 2877294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2878294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2879294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2880294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2881294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 2882294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeNotOwned(RE.getObjKind(), 2883294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2884294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2885294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2886294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2887294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2888294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2889294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2890294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2891294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2892294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2893294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2894294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 28950bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks NewNode = C.addTransition(state); 2896294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2897294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 28989c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 28999c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 29009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 29019c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 29029c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 29039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 29049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2905ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 29069c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2907294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2908294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2909e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 29108bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 29118bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::updateSymbol(ProgramStateRef state, SymbolRef sym, 2912910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2913910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2914e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2915910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 291617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 291717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 29184e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie IgnoreRetainMsg = (bool)C.getASTContext().getLangOpts().ObjCAutoRefCount; 291917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2920e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2921e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: break; 292217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case IncRefMsg: E = IgnoreRetainMsg ? DoNothing : IncRef; break; 292317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case DecRefMsg: E = IgnoreRetainMsg ? DoNothing : DecRef; break; 292417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case MakeCollectable: E = C.isObjCGCEnabled() ? DecRef : DoNothing; break; 292517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case NewAutoreleasePool: E = C.isObjCGCEnabled() ? DoNothing : 292617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose NewAutoreleasePool; break; 2927e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2928e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2929e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 293017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2931e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2932e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2933e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2934e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2935e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2936e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2937e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2938e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2939e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 2940e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2941e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2942e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2943e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 294417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2945e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2946e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2947e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2948e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2949e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2950e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2951e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2952e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2953e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2954e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2955e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2956e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 2957e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2958e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2959e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2960e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2961e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2962e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2963e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2964e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2965e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case NewAutoreleasePool: 296617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!C.isObjCGCEnabled()); 2967e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->add<AutoreleaseStack>(sym); 2968e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2969e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 2970e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 2971e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2972e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2973e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2974e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2975e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2976e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2977e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 2978e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2979e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2980e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 298117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 2982e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2983e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2984e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 2985e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose state = SendAutorelease(state, ARCountFactory, sym); 2986e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 2987e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2988e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2989e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 2990e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->remove<RefBindings>(sym); 2991e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2992e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 2993e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2994e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2995e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 2996e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2997e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2998e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 2999e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3000e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3001e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 300217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3003e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 3004e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3005e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3006e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3007e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3008e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case SelfOwn: 3009e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 3010e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 3011e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 3012e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 3013e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3014e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3015e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 3016e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 3017e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3018e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3019e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 3020e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 3021e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 3022e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 3023e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3024e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3025e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3026e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 3027e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() > 0) 3028e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3029e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose else { 3030e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 3031e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3032e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3033e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3034e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3035e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3036e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 303717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3038e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 3039e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3040e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3041e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3042e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3043e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3044e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 3045e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 3046e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 30478bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::processNonLeakError(ProgramStateRef St, 3048910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 3049910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 3050910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 3051910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3052294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 3053294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 3054294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 3055294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3056294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 3057294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 3058294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 3059294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 3060294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 3061d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 3062d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 3063d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 3064294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3065294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 3066d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 3067d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 3068d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 3069294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3070294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 3071d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 3072d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 3073d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 3074294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3075294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 3076d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 3077d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 3078d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 3079294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3080294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3081294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3082d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 30834e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOpts(), 308417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 308517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 3086294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 3087294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.EmitReport(report); 3088294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 3089294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3090910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3091910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 3092910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3093910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3094910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 309576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 30968bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3097b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *FD = C.getCalleeDecl(CE); 309876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 309976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 310076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 310176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 310276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 310376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 310476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 310576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 310676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 310776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 310876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 310976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 311076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 311176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 311276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 311376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 311476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 311576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 311676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 311776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 311876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3119b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks QualType ResultTy = CE->getCallReturnType(); 312076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 312176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 312276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 312376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 312476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 312576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 312676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 312776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 312876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 312976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 313076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 313176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 313276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 313376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 313476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 313576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 313676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 31375eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = C.getLocationContext(); 31385eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal RetVal = state->getSVal(CE->getArg(0), LCtx); 313976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 314076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 314176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 31425d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 31433133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek SVal RetVal = SVB.getConjuredSymbolVal(0, CE, LCtx, ResultTy, Count); 314476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 31455eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal, false); 314676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3147294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3148294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3149294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3150294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3151294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 3152294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefBindings::data_type *Binding = 0; 3153294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 3154294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Binding = state->get<RefBindings>(Sym); 315576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3156294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 31575d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 31583133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek state = state->invalidateRegions(ArgRegion, CE, Count, LCtx); 315976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3160294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3161294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 3162294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, *Binding); 3163294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3164294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 31650bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 316676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 316776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 316876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3169910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3170910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3171910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3172f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3173e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek// Return true if the current LocationContext has no caller context. 3174e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenekstatic bool inTopFrame(CheckerContext &C) { 3175e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek const LocationContext *LC = C.getLocationContext(); 3176e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return LC->getParent() == 0; 3177e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek} 3178e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3179910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3180910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3181e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3182e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // Only adjust the reference count if this is the top-level call frame, 3183e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // and not the result of inlining. In the future, we should do 3184e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // better checking even for inlined calls, and see if they match 3185e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // with their expected semantics (e.g., the method should return a retained 3186e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // object, etc.). 3187e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek if (!inTopFrame(C)) 3188e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return; 3189e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3190f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3191f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3192f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3193f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 31948bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 31955eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = 31965eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state->getSValAsScalarOrLoc(RetE, C.getLocationContext()).getAsLocSymbol(); 3197f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3198f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3199f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3200f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 3201f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const RefVal *T = state->get<RefBindings>(Sym); 3202f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3203f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3204f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3205f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3206f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3207f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3208f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3209f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3210f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3211f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3212f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3213f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3214f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3215f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3216f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3217f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3218f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3219f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3220f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3221f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3222f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3223f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3224f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3225f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3226f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3227f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3228f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3229f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3230f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3231f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3232f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3233f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 3234f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 32350bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *Pred = C.addTransition(state); 3236f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3237f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3238f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3239f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3240f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3241f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3242f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3243f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3244f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3245f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3246f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3247910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 32484eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, &AutoreleaseTag); 32496a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, Sym, X); 3250f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3251f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 32528d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!Pred) 3253f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3254f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3255f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 3256f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose T = state->get<RefBindings>(Sym); 3257f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3258f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3259f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3260f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 326117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3262f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 3263f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3264f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3265f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Unlike regular functions, /all/ ObjC methods are assumed to always 3266f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // follow Cocoa retain-count conventions, not just those with special 3267f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // names or attributes. 3268b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 3269f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RetEffect RE = Summ ? Summ->getRetEffect() : RetEffect::MakeNoRet(); 3270f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3271f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3272f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3273f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 3274f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<CXXMethodDecl>(FD)) 3275b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (const RetainSummary *Summ = Summaries.getSummary(FD)) 3276f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, Summ->getRetEffect(), X, 3277f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose Sym, state); 3278f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3279f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3280f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3281910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3282910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3283910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3284910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3285910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 32868bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state) const { 3287f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3288f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3289f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3290f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 329117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3292f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3293f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3294f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3295f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3296f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3297f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3298f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3299f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3300f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3301f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3302f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3303f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3304f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3305f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3306f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3307f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3308f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 3309f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 3310f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3311f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3312910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 33130bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnOwnLeakTag); 3314f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 33154e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = C.getASTContext().getLangOpts(); 331617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3317f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 331817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 331917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 33206a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks N, Sym, C); 3321f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3322f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3323f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3324f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3325f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3326f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3327f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3328f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 3329f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X ^ RefVal::ErrorReturnedNotOwned); 3330f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3331f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3332910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 33330bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnNotOwnedTag); 3334f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3335d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3336d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3337d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3338f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3339d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 33404e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie C.getASTContext().getLangOpts(), 334117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3342f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3343f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3344f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3345f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3346f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3347f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33488d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3349910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3350910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3351910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3352390909c89c98ab1807e15e033a72e975f866fb23Anna Zaksvoid RetainCountChecker::checkBind(SVal loc, SVal val, const Stmt *S, 3353910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3354910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3355910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3356910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3357910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3358910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3359910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3360910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3361910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3362910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 33638bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3364910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3365910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (loc::MemRegionVal *regionLoc = dyn_cast<loc::MemRegionVal>(&loc)) { 3366910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3367910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3368910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3369910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3370910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3371910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3372910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = (state == (state->bindLoc(*regionLoc, val))); 3373910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3374910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3375910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3376910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3377910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3378910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3379910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3380910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3381910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3382910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3383910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3384910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 33850bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 3386910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3387910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 33888bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef RetainCountChecker::evalAssume(ProgramStateRef state, 3389910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3390910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3391910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3392910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3393910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3394910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3395910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3396910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3397910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3398910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings B = state->get<RefBindings>(); 3399910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3400910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3401910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3402910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3403910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3404910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings::Factory &RefBFactory = state->get_context<RefBindings>(); 3405910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3406910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3407910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Check if the symbol is null (or equal to any constant). 3408910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If this is the case, stop tracking the symbol. 3409910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (state->getSymVal(I.getKey())) { 3410910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3411910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3412910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3413910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3414910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3415910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3416910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3417910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3418910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3419910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3420910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34218bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 34228bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::checkRegionChanges(ProgramStateRef state, 3423910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 3424910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 342566c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 342666c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks const CallOrObjCMessage *Call) const { 3427910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3428910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3429910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3430910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3431910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3432910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3433910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3434910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3435910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3436910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3437910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (StoreManager::InvalidatedSymbols::const_iterator I=invalidated->begin(), 3438910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3439910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3440910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3441910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3442910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 3443910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->remove<RefBindings>(sym); 3444910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3445910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3446910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3447910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3448910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 34498d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 34508d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 34518d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34528bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstd::pair<ExplodedNode *, ProgramStateRef > 34538bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleAutoreleaseCounts(ProgramStateRef state, 3454910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount Bd, 34556a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred, 34566a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 3457910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 34588d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 34598d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34608d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 34618d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 34628d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(Pred, state); 34638d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34646a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks assert(!Ctx.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 34658d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 34668d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34678d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 34688d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34698d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 34708d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 34718d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34728d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 34738d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 34748d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 34758d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 34768d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 34778d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 34788d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 34798d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 34808d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setCount(Cnt - ACnt); 34818d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 34828d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 34838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 34848d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ExplodedNode *N = Bd.MakeNode(state, Pred); 34858d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (N == 0) 34868d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = 0; 34878d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(N, state); 34888d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 34898d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34908d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 34918d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 34928d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 34938d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 34948d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3495f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks if (ExplodedNode *N = Bd.MakeNode(state, Pred, true)) { 3496f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<128> sbuf; 34978d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 34988d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 34998d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 35008d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 35018d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 35028d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3503d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3504d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3505d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 35064e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35078d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3508d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3509d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 35106a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 35118d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35128d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35138bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek return std::make_pair((ExplodedNode *)0, (ProgramStateRef )0); 35148d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 351538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35168bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 35178bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleSymbolDeath(ProgramStateRef state, 3518910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 351938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 35205337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 352138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 352238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 352338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 352438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 352538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 352638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 352738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->remove<RefBindings>(sid); 352838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 352938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 353038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->set<RefBindings>(sid, V ^ RefVal::ErrorLeak); 353138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 353238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 353338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 35348bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::processLeaks(ProgramStateRef state, 3535910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 3536910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount &Builder, 35376a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 35386a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred) const { 353938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (Leaked.empty()) 354038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return Pred; 354138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 354238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 354338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *N = Builder.MakeNode(state, Pred); 354438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 354538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 354638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 354738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 354838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35494e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35506a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks bool GCEnabled = Ctx.isObjCGCEnabled(); 355117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 355217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 355338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 35542058956954802229bf98604e8063fa57677abff4Jordy Rose 355517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 35566a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks SummaryLog, N, *I, Ctx); 35576a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 355838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 355938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 356038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 356238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 356338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3564af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaksvoid RetainCountChecker::checkEndPath(CheckerContext &Ctx) const { 35658bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Ctx.getState(); 3566af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks GenericNodeBuilderRefCount Bd(Ctx); 356738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 3568af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred = Ctx.getPredecessor(); 356938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 35716a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, Ctx, 35728d22863184419faa2348bd5148c663197bc4bb00Jordy Rose I->first, I->second); 35738d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 357438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 357538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 357638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35770cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // If the current LocationContext has a parent, don't check for leaks. 35780cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // We will do that later. 35790cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // FIXME: we should instead check for imblances of the retain/releases, 35800cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // and suggest annotations. 35810cf3d471546251b12bdceff360f66c079c40526cTed Kremenek if (Ctx.getLocationContext()->getParent()) 35820cf3d471546251b12bdceff360f66c079c40526cTed Kremenek return; 35830cf3d471546251b12bdceff360f66c079c40526cTed Kremenek 358438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 358538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 358638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 358738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) 35888d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 358938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35906a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks processLeaks(state, Leaked, Bd, Ctx, Pred); 359138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 359238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 359338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3594910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 359538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 359638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 3597f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<64> buf; 359838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3599f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks out << "RetainCountChecker : Dead Symbol : "; 3600f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks sym->dumpToStream(out); 360138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 360238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 360338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 360438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 360538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3606910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3607910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 360838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 360938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36108bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 361138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 361238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 361338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 361438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 361538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 361638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 361738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 361838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 361938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 36204eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, getDeadSymbolTag(Sym)); 36216a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, 36228d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Sym, *T); 36238d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 362438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 362538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 362638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 362738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 362838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 362938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 363038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 363138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 363238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 363338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(*I)) 363438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = handleSymbolDeath(state, *I, *T, Leaked); 363538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 363638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 363738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose { 36384eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, this); 36396a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Pred = processLeaks(state, Leaked, Bd, C, Pred); 364038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 364138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 364238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 364338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 364438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 364538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 364638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 364738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings::Factory &F = state->get_context<RefBindings>(); 364838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 364938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 365038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) 365138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 365238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 365338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 36540bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state, Pred); 365538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 365638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3657d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek//===----------------------------------------------------------------------===// 3658dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose// Debug printing of refcount bindings and autorelease pools. 3659dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3660dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3661dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rosestatic void PrintPool(raw_ostream &Out, SymbolRef Sym, 36628bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State) { 3663dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ' '; 3664dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (Sym) 3665f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks Sym->dumpToStream(Out); 3666dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose else 3667dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "<pool>"; 3668dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ":{"; 3669dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3670dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Get the contents of the pool. 3671dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (const ARCounts *Cnts = State->get<AutoreleasePoolContents>(Sym)) 3672dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARCounts::iterator I = Cnts->begin(), E = Cnts->end(); I != E; ++I) 3673dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '(' << I.getKey() << ',' << I.getData() << ')'; 3674dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3675dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '}'; 3676dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3677dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 36788bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic bool UsesAutorelease(ProgramStateRef state) { 3679dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // A state uses autorelease if it allocated an autorelease pool or if it has 3680dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // objects in the caller's autorelease pool. 3681dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose return !state->get<AutoreleaseStack>().isEmpty() || 3682dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose state->get<AutoreleasePoolContents>(SymbolRef()); 3683dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3684dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 36858bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::printState(raw_ostream &Out, ProgramStateRef State, 3686910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3687dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3688dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose RefBindings B = State->get<RefBindings>(); 3689dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3690dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3691dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3692dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3693dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3694dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3695dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3696dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3697dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3698dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3699dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Print the autorelease stack. 3700dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (UsesAutorelease(State)) { 3701dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL << "AR pool stack:"; 3702dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose ARStack Stack = State->get<AutoreleaseStack>(); 3703dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3704dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, SymbolRef(), State); // Print the caller's pool. 3705dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARStack::iterator I = Stack.begin(), E = Stack.end(); I != E; ++I) 3706dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, *I, State); 3707dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3708dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3709dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3710dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3711dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3712dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3713910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 37146b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 37156b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 371617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3717910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 371817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 371917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3720