RetainCountChecker.cpp revision 3133f79cf451e6302dd05262b4bb53a3e4fd6300
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 6583aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek void addClassMethSummary(const char* Cls, const char* nullaryName, 65993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ) { 6603aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6613aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6623aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6633aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek } 6641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6656c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek void addInstMethSummary(const char* Cls, const char* nullaryName, 66693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ) { 6676c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6686c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6696c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek ObjCMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6706c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek } 6711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 672de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector generateSelector(va_list argp) { 6735f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<IdentifierInfo*, 10> II; 674de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6759e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek while (const char* s = va_arg(argp, const char*)) 6769e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek II.push_back(&Ctx.Idents.get(s)); 677de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return Ctx.Selectors.getSelector(II.size(), &II[0]); 679de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 6801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 681de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addMethodSummary(IdentifierInfo *ClsII, ObjCMethodSummariesTy& Summaries, 68293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * Summ, va_list argp) { 683de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector S = generateSelector(argp); 684de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Summaries[ObjCSummaryKey(ClsII, S)] = Summ; 68570a733e64e2379a654631a14fa29e46761d5f80dTed Kremenek } 6861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addInstMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 688af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_list argp; 689af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_start(argp, Summ); 690de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls), ObjCMethodSummaries, Summ, argp); 6911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump va_end(argp); 692af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek } 6931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 69493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 695de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 696de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 697de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls),ObjCClassMethodSummaries, Summ, argp); 698de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 699de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(IdentifierInfo *II, const RetainSummary * Summ, ...) { 702de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 703de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 704de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(II, ObjCClassMethodSummaries, Summ, argp); 705de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 706de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 707de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7086b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 7091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7109c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummaryManager(ASTContext &ctx, bool gcenabled, bool usesARC) 711179064eb831125630c296556dd6d67e67f716143Ted Kremenek : Ctx(ctx), 712f85e193739c953358c865005855253af4f68a497John McCall GCEnabled(gcenabled), 713f85e193739c953358c865005855253af4f68a497John McCall ARCEnabled(usesARC), 714f85e193739c953358c865005855253af4f68a497John McCall AF(BPAlloc), ScratchArgs(AF.getEmptyMap()), 715f85e193739c953358c865005855253af4f68a497John McCall ObjCAllocRetE(gcenabled 716f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 717f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 718f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwned(RetEffect::ObjC, true))), 719f85e193739c953358c865005855253af4f68a497John McCall ObjCInitRetE(gcenabled 720f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 721f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 722f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwnedWhenTrackedReceiver())), 7233baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek DefaultSummary(AF.getEmptyMap() /* per-argument effects (none) */, 7247faca821633c9521030127bf7f42f032c73b24e2Ted Kremenek RetEffect::MakeNoRet() /* return effect */, 725ebd5a2dc1a3743fed9157379d89e5eb26293c9d6Ted Kremenek MayEscape, /* default argument effect */ 726ebd5a2dc1a3743fed9157379d89e5eb26293c9d6Ted Kremenek DoNothing /* receiver effect */), 727b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek StopSummary(0) { 728553cf18cd44769a7624fc942493f076498527529Ted Kremenek 729553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeClassMethodSummaries(); 730553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeMethodSummaries(); 731553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 7321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7330507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getSummary(const FunctionDecl *FD); 7341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 7368bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state, 73793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const LocationContext *LC); 738dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 7390507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getInstanceMethodSummary(const ObjCMessage &msg, 74093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCInterfaceDecl *ID) { 741432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis return getInstanceMethodSummary(msg.getSelector(), 0, 742432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis ID, msg.getMethodDecl(), msg.getType(Ctx)); 7438711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek } 7441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7450507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getInstanceMethodSummary(Selector S, 74693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek IdentifierInfo *ClsName, 74793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCInterfaceDecl *ID, 74893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD, 74993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek QualType RetTy); 750fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek 75193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getClassMethodSummary(Selector S, 75293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek IdentifierInfo *ClsName, 75393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCInterfaceDecl *ID, 75493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD, 75593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek QualType RetTy); 7561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 75793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getClassMethodSummary(const ObjCMessage &msg) { 758432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const ObjCInterfaceDecl *Class = 0; 759432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis if (!msg.isInstanceMessage()) 760432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis Class = msg.getReceiverInterface(); 76104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 762432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis return getClassMethodSummary(msg.getSelector(), 76304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Class? Class->getIdentifier() : 0, 76404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Class, 765432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis msg.getMethodDecl(), msg.getType(Ctx)); 766fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek } 767552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek 768552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// getMethodSummary - This version of getMethodSummary is used to query 769552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// the summary for the current method being analyzed. 77093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getMethodSummary(const ObjCMethodDecl *MD) { 771a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek // FIXME: Eventually this should be unneeded. 772a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID = MD->getClassInterface(); 77370a6576c9c8d21ff2361574f4937a2e73bd57779Ted Kremenek Selector S = MD->getSelector(); 774552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek IdentifierInfo *ClsName = ID->getIdentifier(); 775552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek QualType ResultTy = MD->getResultType(); 7761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 777552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek if (MD->isInstanceMethod()) 778552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek return getInstanceMethodSummary(S, ClsName, ID, MD, ResultTy); 779552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek else 780552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek return getClassMethodSummary(S, ClsName, ID, MD, ResultTy); 781552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek } 7821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7830507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCommonMethodSummary(const ObjCMethodDecl *MD, 78493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Selector S, QualType RetTy); 785a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek 78693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7874dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD); 7884dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 78993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7904dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD); 7914dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 792d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek bool isGCEnabled() const { return GCEnabled; } 7931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 794f85e193739c953358c865005855253af4f68a497John McCall bool isARCEnabled() const { return ARCEnabled; } 795f85e193739c953358c865005855253af4f68a497John McCall 796f85e193739c953358c865005855253af4f68a497John McCall bool isARCorGCEnabled() const { return GCEnabled || ARCEnabled; } 797f85e193739c953358c865005855253af4f68a497John McCall 79893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *copySummary(const RetainSummary *OldSumm) { 79993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 800885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek new (Summ) RetainSummary(*OldSumm); 801885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek return Summ; 8021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 8036b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 8041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8050fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// Used to avoid allocating long-term (BPAlloc'd) memory for default retain 8060fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// summaries. If a function or method looks like it has a default summary, but 8070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// it has annotations, the annotations are added to the stack-based template 8080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// and then copied into managed memory. 8090fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Roseclass RetainSummaryTemplate { 8100fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &Manager; 81193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *&RealSummary; 81293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *BaseSummary; 8130fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary ScratchSummary; 8140fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose bool Accessed; 8150fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rosepublic: 81693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummaryTemplate(const RetainSummary *&real, const RetainSummary &base, 8170fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &manager) 81893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek : Manager(manager), 81993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RealSummary(real), 82093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek BaseSummary(&base), 82193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ScratchSummary(base), 82293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Accessed(false) {} 8230fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8240fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose ~RetainSummaryTemplate() { 82593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek if (Accessed) 8260fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RealSummary = Manager.copySummary(&ScratchSummary); 82793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek else if (!RealSummary) 82893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RealSummary = BaseSummary; 8290fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8310fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary &operator*() { 8320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 83393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return ScratchSummary; 8340fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8350fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8360fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *operator->() { 8370fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 83893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return &ScratchSummary; 8390fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8400fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose}; 8410fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8426b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end anonymous namespace 8436b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 8446b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8456b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek// Implementation of checker data structures. 8466b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8476b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 848b77449cead63264650958c92cb30609c942cc5e9Ted KremenekArgEffects RetainSummaryManager::getArgEffects() { 849b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects AE = ScratchArgs; 8503baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.getEmptyMap(); 851b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return AE; 85200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 85300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 85493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 855b77449cead63264650958c92cb30609c942cc5e9Ted KremenekRetainSummaryManager::getPersistentSummary(ArgEffects AE, RetEffect RetEff, 8561bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek ArgEffect ReceiverEff, 857e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect DefaultEff) { 858891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Create the summary and return it. 85993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 860e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose new (Summ) RetainSummary(AE, RetEff, DefaultEff, ReceiverEff); 86100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek return Summ; 86200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 86300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 864d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 865d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for functions (largely uses of Core Foundation). 866d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 86700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 8689c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRetain(const FunctionDecl *FD, StringRef FName) { 869b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Retain"); 8701261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8711261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 8729c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRelease(const FunctionDecl *FD, StringRef FName) { 873b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Release"); 8741261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8751261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 87676c506fba2359296d1f19e64998bd11d7b864563Jordy Rosestatic bool isMakeCollectable(const FunctionDecl *FD, StringRef FName) { 87776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Remove FunctionDecl parameter. 87876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Is it really okay if MakeCollectable isn't a suffix? 87976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return FName.find("MakeCollectable") != StringRef::npos; 88076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 88176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 88293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * RetainSummaryManager::getSummary(const FunctionDecl *FD) { 883891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 884d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 885d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 886891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 887891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 888e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 88993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *S = 0; 8901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 89137d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 8921261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 8931261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 8941261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 8951261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 8961261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 8979ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // For C++ methods, generate an implicit "stop" summary as well. We 8989ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // can relax this once we have a clear policy for C++ methods and 8999ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek // ownership attributes. 9009ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek if (isa<CXXMethodDecl>(FD)) { 9019ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek S = getPersistentStopSummary(); 9029ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek break; 9039ca2851de4cc62ddd8466312603fe41bdac10eb5Ted Kremenek } 9041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 905183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 90699890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 907183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 90848c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 90948c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 91048c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 911b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 912b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 9131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 914bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 915bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 916b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 9171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9181261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 9191261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 9201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9211261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 9221261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 923008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 924e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 925b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer if (FName == "pthread_create") { 926b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of: <rdar://problem/7299394>. This will be addressed 927b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // better with IPA. 928b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 929b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 930b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 931b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 932b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 933b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 934b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 935b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 936b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 937b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 938b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 939b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 940b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 941b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 942b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 943b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 944b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 945b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 946b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 947b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 9483baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 949b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 950b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 951b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 952b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 953b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 9543baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 955b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 956b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 957b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 958b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 959b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 960b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 961b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 962b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 9633baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 964b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 965b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 966b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 967b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 968b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 969b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 9703baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 971b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 972b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 973b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 974b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 975b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 976b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 977b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 978b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 9793baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 980b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 981b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 9821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 983b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 984b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 985b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 98661991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 98761991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Enable this code once the semantics of NSDeallocateObject are resolved 98861991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // for GC. <rdar://problem/6619988> 98961991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#if 0 99061991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Handle: NSDeallocateObject(id anObject); 99161991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // This method does allow 'nil' (although we don't check it now). 9921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (strcmp(FName, "NSDeallocateObject") == 0) { 99361991903335144605031c3597a5c99e1565b0bd4Ted Kremenek return RetTy == Ctx.VoidTy 99461991903335144605031c3597a5c99e1565b0bd4Ted Kremenek ? getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, Dealloc) 99561991903335144605031c3597a5c99e1565b0bd4Ted Kremenek : getPersistentStopSummary(); 99661991903335144605031c3597a5c99e1565b0bd4Ted Kremenek } 99761991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#endif 9981261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 9991261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (RetTy->isPointerType()) { 10001261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 100178acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 10021261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10031261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 100476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 10051261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 10061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 10077df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10081261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 100937d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 101037d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10111261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10121261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 101378acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 10141261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 10151261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 10161261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 10177df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 10181261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 101937d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 102037d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10211261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10221261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 102378acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 102478acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 102578acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 10267df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1027706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1028706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 10291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10301261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 103137d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 10321261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 10331261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 10341261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 10351261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1036e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1037b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1038e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1039bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 10401261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 10411261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1042b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 10436818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 10446818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 10456818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 10466818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 10476818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 10496818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 10501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 10516818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 10526818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 10536818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1054c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1055c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1056c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1057c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1058e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1059e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1060e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1061e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1062c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 10636818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 10641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10656818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 10661261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 106764e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 106837d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 106937d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 10701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10714dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 10724df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(S, FD); 10731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1074d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 10751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 10762fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 10772fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 107893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 10797df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 10807df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 108186ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 10821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1083d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 108400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 108500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 108693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 10876ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 10886ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 10896ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 10901261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 10911261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 109272564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 10931261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 10941261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 10951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1096b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 10971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1099377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 110076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 110176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 110276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 1103940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 110476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 110576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 110676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 110700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 110800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 110993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11109c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1111b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11132d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 111400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 111500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 111693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11179c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 11181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 11192d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 11202d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 112100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 112200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 11236b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1124d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1125d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1126d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 112793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11288711c03dda12863a7537f14025513f7717b14ce1Ted KremenekRetainSummaryManager::getInitMethodSummary(QualType RetTy) { 11291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(ScratchArgs.isEmpty()); 113078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek // 'init' methods conceptually return a newly allocated object and claim 11311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // the receiver. 11320556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek if (cocoa::isCocoaObjectRef(RetTy) || 11330556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek coreFoundation::isCFObjectRef(RetTy)) 1134547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek return getPersistentSummary(ObjCInitRetE, DecRefMsg); 11351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 113693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 113746e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek} 11384dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11394dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 114093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 11414dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 11424dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 11434dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11444dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11450fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryTemplate Template(Summ, DefaultSummary, *this); 11464df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 114711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 114811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 114911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 115098b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 115111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 115211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 11534df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 11540fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 11554df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 11564df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 11570fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 115811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 115911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 116011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1161b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 11621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11634dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 116478acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 116540b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 11660fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 11674dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 116840b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 11690fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1170b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 11716041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>()) { 11720fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 11736041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11746041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11750fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 11766041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 11774df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (RetTy->getAs<PointerType>()) { 117840b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 11790fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 11804dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1181d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 11820fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1183d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 11844dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 11854dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 11864dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11874dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 118893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 118993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD) { 11904dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 11914dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 11924dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 11930fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryTemplate Template(Summ, DefaultSummary, *this); 11944df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 11956d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 11961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 119712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 119812b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 119911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12000fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 120111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 120211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 120311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 120411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1205491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1206491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 120711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 120811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 120911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 121011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12110fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 121211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 121311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 12140fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 121511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 121612b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 121712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 12184dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 121978acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 122040b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 12210fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 12226d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 12234dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 12246041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>()) { 12250fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 12266041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 12276041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12296d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 12300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 12316217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 12320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 12331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12346041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 12356041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 12360fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 12376041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 12380fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 12396041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12404dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 12414dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 124293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12439c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCommonMethodSummary(const ObjCMethodDecl *MD, 1244a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek Selector S, QualType RetTy) { 12458ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek 1246fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek if (MD) { 1247376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Scan the method decl for 'void*' arguments. These should be treated 1248376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // as 'StopTracking' because they are often used with delegates. 1249376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Delegates are a frequent form of false positives with the retain 1250376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // count checker. 1251376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek unsigned i = 0; 1252491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator I = MD->param_begin(), 1253376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek E = MD->param_end(); I != E; ++I, ++i) 1254491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis if (const ParmVarDecl *PD = *I) { 1255376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek QualType Ty = Ctx.getCanonicalType(PD->getType()); 1256a4923eb7c4b04d360cb2747641a5e92818edf804Douglas Gregor if (Ty.getLocalUnqualifiedType() == Ctx.VoidPtrTy) 12573baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, i, StopTracking); 1258376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 1259376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 12601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12618ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // Any special effect for the receiver? 12628ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 12631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12648ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 12658ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 12668ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 12678ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 12688ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 12698ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek const std::string &str = S.getAsString(); 12708ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek assert(!str.empty()); 1271e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer if (StrInStrNoCase(str, "delegate:") != StringRef::npos) 1272e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ReceiverEff = StopTracking; 12738ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 12741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1275250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek // Look for methods that return an owned object. 127678acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 127728f47b92e760ccf641ac91cb0fe1c12d9ca89795Ted Kremenek // EXPERIMENTAL: assume the Cocoa conventions for all objects returned 127892511433cc78021dca5f340136be1bbd72388191Ted Kremenek // by instance methods. 1279786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor RetEffect E = cocoa::followsFundamentalRule(S, MD) 12807db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek ? ObjCAllocRetE : RetEffect::MakeNotOwned(RetEffect::ObjC); 12811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return getPersistentSummary(E, ReceiverEff, MayEscape); 1283376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 12841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 128592511433cc78021dca5f340136be1bbd72388191Ted Kremenek // Look for methods that return an owned core foundation object. 12860556048ae8ff743d0abb9fa88a0d0ee8e9123742Ted Kremenek if (coreFoundation::isCFObjectRef(RetTy)) { 1287786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor RetEffect E = cocoa::followsFundamentalRule(S, MD) 12887db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek ? RetEffect::MakeOwned(RetEffect::CF, true) 12897db16041263f39df6deb1145b5c039dfd8da6af0Ted Kremenek : RetEffect::MakeNotOwned(RetEffect::CF); 12901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 129192511433cc78021dca5f340136be1bbd72388191Ted Kremenek return getPersistentSummary(E, ReceiverEff, MayEscape); 129292511433cc78021dca5f340136be1bbd72388191Ted Kremenek } 12931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 129492511433cc78021dca5f340136be1bbd72388191Ted Kremenek if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing) 129593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 12961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1297885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek return getPersistentSummary(RetEffect::MakeNoRet(), ReceiverEff, MayEscape); 1298250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1299250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 130093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1301432424d67641d609e4990d791baa782fc161027eArgyrios KyrtzidisRetainSummaryManager::getInstanceMethodSummary(const ObjCMessage &msg, 13028bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state, 1303b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek const LocationContext *LC) { 1304b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1305b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // We need the type-information of the tracked receiver object 1306b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Retrieve it from the state. 1307432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis const Expr *Receiver = msg.getInstanceReceiver(); 13089c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID = 0; 1309b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 1310b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: Is this really working as expected? There are cases where 1311b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we just use the 'ID' from the message expression. 131204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor SVal receiverV; 131304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 13148f326751df18e78bdb7edf786a842def8a4f41e3Ted Kremenek if (Receiver) { 13155eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek receiverV = state->getSValAsScalarOrLoc(Receiver, LC); 1316dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 131704badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Eventually replace the use of state->get<RefBindings> with 131804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // a generic API for reasoning about the Objective-C types of symbolic 131904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // objects. 132004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (SymbolRef Sym = receiverV.getAsLocSymbol()) 132104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const RefVal *T = state->get<RefBindings>(Sym)) 1322dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek if (const ObjCObjectPointerType* PT = 1323b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 132404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 1325dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 132604badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: this is a hack. This may or may not be the actual method 132704badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // that is called. 132804badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (!ID) { 132904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const ObjCObjectPointerType *PT = 133004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor Receiver->getType()->getAs<ObjCObjectPointerType>()) 133104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor ID = PT->getInterfaceDecl(); 133204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } 133304badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor } else { 133404badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor // FIXME: Hack for 'super'. 1335432424d67641d609e4990d791baa782fc161027eArgyrios Kyrtzidis ID = msg.getReceiverInterface(); 1336b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 133704badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1338b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1339b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 13404df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return getInstanceMethodSummary(msg, ID); 1341b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1342b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 134393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1344ce8a41d020d0b171535d77f73adb8acb3e6a881eTed KremenekRetainSummaryManager::getInstanceMethodSummary(Selector S, 1345ce8a41d020d0b171535d77f73adb8acb3e6a881eTed Kremenek IdentifierInfo *ClsName, 13469c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID, 1347a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCMethodDecl *MD, 1348ce8a41d020d0b171535d77f73adb8acb3e6a881eTed Kremenek QualType RetTy) { 13491bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 13508711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 135193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = ObjCMethodSummaries.find(ID, ClsName, S); 13521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1353614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1354614cc540a617978814e37d75bf5066926b921a0aTed Kremenek assert(ScratchArgs.isEmpty()); 13551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1356614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // "initXXX": pass-through for receiver. 1357786dcd9dca76e3780fdb9642c0db33ed13db1187Douglas Gregor if (cocoa::deriveNamingConvention(S, MD) == cocoa::InitRule) 1358614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getInitMethodSummary(RetTy); 1359614cc540a617978814e37d75bf5066926b921a0aTed Kremenek else 1360614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getCommonMethodSummary(MD, S, RetTy); 13611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1362614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 13634df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 13641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1365614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 1366614cc540a617978814e37d75bf5066926b921a0aTed Kremenek ObjCMethodSummaries[ObjCSummaryKey(ID, ClsName, S)] = Summ; 1367614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 13681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1369e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 137046e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek} 137146e49eeb30626ec803a56e49302d1489a28bddb0Ted Kremenek 137293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1373fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed KremenekRetainSummaryManager::getClassMethodSummary(Selector S, IdentifierInfo *ClsName, 1374a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID, 1375a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCMethodDecl *MD, 1376a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek QualType RetTy) { 1377de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 1378fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek assert(ClsName && "Class name must be specified."); 137993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = ObjCClassMethodSummaries.find(ID, ClsName, S); 13801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1381614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1382614cc540a617978814e37d75bf5066926b921a0aTed Kremenek Summ = getCommonMethodSummary(MD, S, RetTy); 13834df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1384614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 13854df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 13864df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1387614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 1388614cc540a617978814e37d75bf5066926b921a0aTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ID, ClsName, S)] = Summ; 1389614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 13901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1391e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1392c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1393c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 13941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1395ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 13961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 13976fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 13982d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 13991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14006d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 14013baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 14026fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 14036fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 14046fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 14051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1406de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // Create the summaries for [NSObject performSelector...]. We treat 1407de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // these as 'stop tracking' for the arguments because they are often 1408de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // used for delegates that can release the object. When we have better 1409de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // inter-procedural analysis we can potentially do something better. This 1410de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek // workaround is to remove false positives. 141193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = 1412012614ecf78442368ec82ee30efb3bc047b413e6Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, StopTracking); 1413de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek IdentifierInfo *NSObjectII = &Ctx.Idents.get("NSObject"); 1414de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1415de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", NULL); 1416de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "withObject", 1417de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "afterDelay", "inModes", NULL); 1418de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1419de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1420de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorOnMainThread", 1421de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1422de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1423de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", NULL); 1424de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelector", "onThread", 1425de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", "waitUntilDone", "modes", NULL); 1426de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addClsMethSummary(NSObjectII, Summ, "performSelectorInBackground", 1427de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek "withObject", NULL); 14289c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 14299c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 14301f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 14311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 14331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1434c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1435c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 143693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1437ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1438ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1439ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1440ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1441ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1442ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 14431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1444c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 144593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 144693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *CFAllocSumm = 1447a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 14481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14493c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1450500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 145193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1452553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 14531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14543c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1455500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1456553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 14571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1458299e8158d63d69830cca0187f4003cba1e66081fTed Kremenek // Create the "drain" selector. 1459500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, isGCEnabled() ? DoNothing : DecRef); 1460553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); 14611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1462f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1463500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1464f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 14653c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 14663c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1467500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1468553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 14691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1470f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek // Specially handle NSAutoreleasePool. 14716c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek addInstMethSummary("NSAutoreleasePool", "init", 1472500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose getPersistentSummary(NoRet, NewAutoreleasePool)); 14731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 147589e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 147689e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 147789e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 147889e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 14793aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 148093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 148178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 148278a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 14831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 148499d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 148599d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 14863aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#if 0 148778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1488af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 14891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 149078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1491af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 14923aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#endif 14931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1494179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1495179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 149699d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 149799d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 149899d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 14991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 150078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#if 0 150178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1502af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 150478a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1505af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 150678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#endif 15071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1508ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // Don't track allocated autorelease pools yet, as it is okay to prematurely 1509ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1510ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1511553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1512767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1513767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1514767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1515767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1516767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1517767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1518211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1519a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1520a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1521a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1522767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1523a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 15241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1525a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1526211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1527b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1528b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1529d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 15304d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek// AutoreleaseBindings - State used to track objects in autorelease pools. 15316d34893fc886f4153f104de8880876764981cb7fTed Kremenek//===----------------------------------------------------------------------===// 15326d34893fc886f4153f104de8880876764981cb7fTed Kremenek 15334d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, unsigned> ARCounts; 15344d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, ARCounts> ARPoolContents; 15354d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableList<SymbolRef> ARStack; 1536f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek 15374d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenekstatic int AutoRCIndex = 0; 15386d34893fc886f4153f104de8880876764981cb7fTed Kremenekstatic int AutoRBIndex = 0; 15396d34893fc886f4153f104de8880876764981cb7fTed Kremenek 1540ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleasePoolContents {}; } 1541ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleaseStack {}; } 15424d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 15436d34893fc886f4153f104de8880876764981cb7fTed Kremeneknamespace clang { 15449ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 154518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleaseStack> 154618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARStack> { 15479c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRBIndex; } 15484d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15494d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 155018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleasePoolContents> 155118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARPoolContents> { 15529c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRCIndex; } 15534d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 15545a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 15554d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek} // end clang namespace 15566d34893fc886f4153f104de8880876764981cb7fTed Kremenek 15578bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic SymbolRef GetCurrentAutoreleasePool(ProgramStateRef state) { 15587037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARStack stack = state->get<AutoreleaseStack>(); 15597037ab8f15950e594642adf77a56d299667debe7Ted Kremenek return stack.isEmpty() ? SymbolRef() : stack.getHead(); 15607037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 15617037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 15628bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic ProgramStateRef 15638bef8238181a30e52dea380789a7e2d760eac532Ted KremenekSendAutorelease(ProgramStateRef state, 156418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ARCounts::Factory &F, 156518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek SymbolRef sym) { 15667037ab8f15950e594642adf77a56d299667debe7Ted Kremenek SymbolRef pool = GetCurrentAutoreleasePool(state); 1567b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const ARCounts *cnts = state->get<AutoreleasePoolContents>(pool); 15687037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARCounts newCnts(0); 15691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15707037ab8f15950e594642adf77a56d299667debe7Ted Kremenek if (cnts) { 15717037ab8f15950e594642adf77a56d299667debe7Ted Kremenek const unsigned *cnt = (*cnts).lookup(sym); 15723baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(*cnts, sym, cnt ? *cnt + 1 : 1); 15737037ab8f15950e594642adf77a56d299667debe7Ted Kremenek } 15747037ab8f15950e594642adf77a56d299667debe7Ted Kremenek else 15753baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(F.getEmptyMap(), sym, 1); 15761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1577b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek return state->set<AutoreleasePoolContents>(pool, newCnts); 15787037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 15797037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 15801392261ff4418a070fb919cb4832b76b468b6faaTed Kremenek//===----------------------------------------------------------------------===// 1581c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1582c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1583c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1584ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1585ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1586ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1587c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1588c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 15891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 15901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1591ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1592c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 159335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 159435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : BugType(name, "Memory (Core Foundation/Objective-C)") {} 1595c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 15961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1597c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 159835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 15991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1600c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1601c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1603ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1604c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 160535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 160735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1608c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1610c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1612ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1613c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 161435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 16151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 161635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1617bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1618bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1619b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1620c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1622ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1623c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 162435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 162535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 16261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1627c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1628369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 16291499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1630c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1632ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1633c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 163435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 163535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 16361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1637c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1638c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 163900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 16401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1642ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1643369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 164435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 164535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 16461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1647369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1648eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1649369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1650369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 16511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1652ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1653e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 165435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 165535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 16561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1657e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 16585b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1659e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1660e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1661e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 16621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1663ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1664c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const bool isReturn; 1665c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 166635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose Leak(StringRef name, bool isRet) 1667db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose : CFRefBug(name), isReturn(isRet) { 1668db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1669db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1670db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 1671c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 167335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 16741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1675c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1676c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1678ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class LeakAtReturn : public Leak { 1679c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 168035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose LeakAtReturn(StringRef name) 168135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Leak(name, true) {} 1682c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1684ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class LeakWithinFunction : public Leak { 1685c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 168635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose LeakWithinFunction(StringRef name) 168735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Leak(name, false) {} 16881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1690c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1691c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1692c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 16931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1694dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks class CFRefReportVisitor : public BugReporterVisitor { 169523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1696dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1697ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 169835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 169923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1700dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 170135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 170235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1703dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 170423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1705dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1706dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1707dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1708dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1709dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 171023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 171123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 171223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 171323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 171423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 171523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 171623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 171723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 171823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 171923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 172023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 172123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 172235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1723ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 172435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 172523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 172623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 172723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 172823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1729dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1730dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1731e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 17322058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 173335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1734c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17352058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17362058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17372058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1738edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 173923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 17402058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17412058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1742dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1743eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 17442058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17452058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17462058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1747edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 17482058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17492058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1750dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 17511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1752e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1753edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1754edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1755e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1756c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1757640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1758c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1759c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1760eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1761ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1762c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 176323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1764c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17652058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17662058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17676a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx); 17681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1769590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1770590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1771590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1772590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 17731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 17745216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 17755216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 17762058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 17772058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1778f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 17791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1780e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 17817f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 17822058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 178335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 178435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 17851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 17867f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 17872058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 178835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 178935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 17901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 17917f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 17922058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 179335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 179435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 179535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 179635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 179735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 179835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 179935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 180035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 180135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18027f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1803c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 180435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1805f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 180635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1807c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1808e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1809910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18105f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1811c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18125f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1813c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1814c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 18151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1816c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1817c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1818c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 18194c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenekstatic bool isPropertyAccess(const Stmt *S, ParentMap &PM) { 18204c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek unsigned maxDepth = 4; 18214c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek while (S && maxDepth) { 18224c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek if (const PseudoObjectExpr *PO = dyn_cast<PseudoObjectExpr>(S)) { 18234c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek if (!isa<ObjCMessageExpr>(PO->getSyntacticForm())) 18244c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return true; 18254c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return false; 18264c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek } 18274c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek S = PM.getParent(S); 18284c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek --maxDepth; 18294c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek } 18304c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek return false; 18314c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek} 18324c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek 1833dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1834dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1835dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1836dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 18371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1838f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<StmtPoint>(N->getLocation())) 18392033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 18401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18418966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 18428bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef PrevSt = PrevN->getState(); 18438bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef CurrSt = N->getState(); 18445eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = N->getLocationContext(); 18451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const RefVal* CurrT = CurrSt->get<RefBindings>(Sym); 1847c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 18481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1849b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 1850b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal *PrevT = PrevSt->get<RefBindings>(Sym); 18511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1852c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1853c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1854c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1855c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 18561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1857c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1858c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1859c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 1860f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 18611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18625f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1863c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the callee (if it is available). 18645eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee(), LCtx); 18659c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 1866b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "Call to function '" << *FD << '\''; 1867c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 18681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump os << "function call"; 18691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 18704c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek else { 18714c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek assert(isa<ObjCMessageExpr>(S)); 18724c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek // The message expression may have between written directly or as 18734c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek // a property access. Lazily determine which case we are looking at. 18744c42bb7815e4f6317826767f8c53776ae03b4028Ted Kremenek os << (isPropertyAccess(S, N->getParentMap()) ? "Property" : "Method"); 1875c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 18761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1877c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 1878c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " returns a Core Foundation object with a "; 1879c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1880c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else { 1881c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 1882c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " returns an Objective-C object with a "; 18834fd8897f81e2d9e2d9b8c6a5f10fe0dae3e52223Ted Kremenek } 18841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1885c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.isOwned()) { 1886f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "+1 retain count"; 18871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 188835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 1889c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 18905b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose os << ". " 1891c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "Core Foundation objects are not automatically garbage collected."; 1892c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 18934fd8897f81e2d9e2d9b8c6a5f10fe0dae3e52223Ted Kremenek } 1894c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else { 1895c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert (CurrV.isNotOwned()); 1896f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "+0 retain count"; 1897cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 18981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1899220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 1900220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 1901c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 1902cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1904c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 1905c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 19065f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 19071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1908ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 1909ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 1910c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 1911c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 1912f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19145f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1915c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 1916c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 1917c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 19181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19195f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 1920c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 19211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1922c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 1923c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 19245eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI, LCtx).getAsLocSymbol() != Sym) 1925c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 19261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1927c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 1928c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 1929c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1930c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 193204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 19335eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver, LCtx) 19345eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek .getAsLocSymbol() == Sym) { 1935c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 1936c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 1937c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1938c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19391c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 19401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1941c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 1942c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 1943c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 19441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1945c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 194635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 1947c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 1948c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 1949c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 1950c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 1951c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 1952f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 1953c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 1954f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 1955f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 1956c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1958c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 1959c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 1960c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 1961f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19625eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = 19635eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee(), LCtx); 19649c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 19651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 196635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 1967c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 1968c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 19691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1970b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "In GC mode a call to '" << *FD 1971c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 1972c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 19731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1974c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 1975c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 1976c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 1977c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 1978c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1979c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1980c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 1981c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 1982c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 19833eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 19841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 1985b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "When GC is not enabled a call to '" << *FD 1986c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 19871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1988c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 1989c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 1990c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 19911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 1993c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 1994c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 19951ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 19961ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 19971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1998f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 1999f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 2000f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 2001f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 20021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2003264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 2004eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 2005f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 2006f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 20071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2008c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 2009c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 2010c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2011c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 20121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2013c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 2014c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 20151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2016c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 201735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 2018c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object is not eligible for garbage collection until the " 2019c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "retain count reaches 0 again."; 2020c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2022c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20241ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2025c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 20261ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 20271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2028c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 2029c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object returned to caller as an owning reference (single retain " 2030f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count transferred to caller)"; 2031c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2033c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2034f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2035c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2037c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2038c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2039c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2041c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 20425f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2043c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 20441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2045c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 204635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2047c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2048c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2049c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2050c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2051c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2052c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2053c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2054c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2055c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2056c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2057c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2058c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2059c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 20611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2062c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2063c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 20642033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 2065f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 2066220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2067220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 20689c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 20691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2070c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2071c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 20721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 20735f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 20749c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 20755eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp, LCtx).getAsLocSymbol() == Sym) { 2076c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2077c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2078c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2080c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2081c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2082c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2083c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 2084ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class FindUniqueBinding : 2085c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public StoreManager::BindingsHandler { 2086c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym; 2087c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* Binding; 2088c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool First; 20891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2090c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 2091c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek FindUniqueBinding(SymbolRef sym) : Sym(sym), Binding(0), First(true) {} 20921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2093c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool HandleBinding(StoreManager& SMgr, Store store, const MemRegion* R, 2094c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SVal val) { 20951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SymbolRef SymV = val.getAsSymbol(); 2097c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!SymV || SymV != Sym) 2098c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return true; 20991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2100c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (Binding) { 2101c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek First = false; 2102c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 2103c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2104c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2105c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Binding = R; 21061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return true; 2108c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2110c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek operator bool() { return First && Binding; } 21110507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const MemRegion *getRegion() { return Binding; } 21121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 2113c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 21149e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek 2115c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 211618c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2117c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 21181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2119c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Find both first node that referred to the tracked symbol and the 2120c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // memory location that value was store to. 21219c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 21221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 21231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2124c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 21258bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St = N->getState(); 2126c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefBindings B = St->get<RefBindings>(); 21271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2128c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!B.lookup(Sym)) 2129940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 21301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2131c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek FindUniqueBinding FB(Sym); 21321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 21331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 21341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2135c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Last = N; 21361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 21371ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 21381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2139c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 21406b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 21416b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2142c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 214323f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 214423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 214523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 21468966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2147c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 21488966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek BRC.addNotableSymbol(Sym); 214923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2150c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2151fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2152c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 215323f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 215423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 215523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 21561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21578966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2158c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 21598966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek BRC.addNotableSymbol(Sym); 21601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2161c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2162c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2163c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 21649c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2165c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 21661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2167c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2168f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 21691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21704fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 21711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2172c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2173c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2174c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 21759c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 21764fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 21771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2178c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2179c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 21801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2181f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 21821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2183f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2184f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2185f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2186f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2187f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2188f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 21891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2190c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 2191c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const RefVal* RV = EndN->getState()->get<RefBindings>(Sym); 21921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2193c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2194c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 21955b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2196c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2197d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2198d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2199d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek os << " is returned from a method whose name ('" 2200d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << MD->getSelector().getAsString() 2201d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 22025b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose " This violates the naming convention rules" 2203f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " given in the Memory Management Guide for Cocoa"; 2204d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2205d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2206d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2207b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek os << " is returned from a function whose name ('" 2208a59d20b135bfde058a5a69045bab5ec4e2553f74Benjamin Kramer << *FD 2209d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 2210b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek " convention rules given in the Memory Management Guide for Core" 2211f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " Foundation"; 2212d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2213c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2214e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 22159c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2216e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 221782f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 221882f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 221982f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 222082f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2221e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2222c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2223abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2224f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 22251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2226c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2227c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2228cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 22292058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 22302058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 22312058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 22326a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx) 22332058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 22341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2235fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2236c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2237c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2238c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2239c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2240c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2241c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2242c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 22439c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 22441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22456a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const SourceManager& SMgr = Ctx.getSourceManager(); 2246590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2247c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 22486a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks GetAllocationSite(Ctx.getStateManager(), getErrorNode(), sym); 22491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2250c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2251c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 2252590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks const Stmt *AllocStmt = cast<PostStmt>(P).getStmt(); 2253590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2254590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2255c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2256c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2257c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2258590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks unsigned AllocLine = SMgr.getExpansionLineNumber(AllocStmt->getLocStart()); 2259dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 22602058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2261dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2262dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "of an object allocated on line " << AllocLine; 22631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2264c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2265c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2266c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " and stored into '" << AllocBinding->getString() << '\''; 2267dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 22682058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2269c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2270c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2271c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2272c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2273c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2274c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2275d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2276910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 22779c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 227838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 22799c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 228038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::EndPath, 22816704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2282f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 2283294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostStmt<CallExpr>, 2284537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose check::PostStmt<CXXConstructExpr>, 2285294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose check::PostObjCMessage, 2286f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 22876704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 228876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 228976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 22906f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 22916f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 22926f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 22936f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 22946f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 229538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 229638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 229738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 229838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 229938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 230038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23016f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> Summaries; 23026f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> SummariesGC; 2303b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 2304e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose mutable ARCounts::Factory ARCountFactory; 2305e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 23069c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 23079c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 23089c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23092f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2310910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 231138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2312910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 231338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 231438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 231538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23169c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 23179c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 23189c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 23199c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 23209c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 23219c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 23229c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 23239c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 23249c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 23259c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 23269c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 23271ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23281ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 23291ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 23301ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 23311ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 23321ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23339c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 23349c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 23359c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 23369c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 23371ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23389c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 23399c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 23409c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 23419c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23429c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 23439c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 23449c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 23459c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 23469c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 23479c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 23489c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23499c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 23501ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 23511ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 235217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 235317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 235417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2355db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2356db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunctionGC.reset(new LeakWithinFunction("Leak of object when " 2357db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "using garbage " 2358db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "collection")); 235917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2360db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2361db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2362e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2363db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunction.reset(new LeakWithinFunction("Leak of object when " 2364db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "not using garbage " 2365db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "collection (GC) in " 2366db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "dual GC/non-GC " 2367db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "code")); 2368db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2369db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakWithinFunction.reset(new LeakWithinFunction("Leak")); 2370db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2371db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 237217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunction.get(); 2373db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2374db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2375db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 237617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakAtReturnBug(const LangOptions &LOpts, bool GCEnabled) const { 237717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2378db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturnGC) 2379db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturnGC.reset(new LeakAtReturn("Leak of returned object when " 2380db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "using garbage collection")); 238117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2382db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2383db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2384e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2385db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturn.reset(new LeakAtReturn("Leak of returned object when " 2386db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "not using garbage collection " 2387db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose "(GC) in dual GC/non-GC code")); 2388db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2389db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose leakAtReturn.reset(new LeakAtReturn("Leak of returned object")); 2390db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2391db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 239217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturn.get(); 2393db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2394db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2395db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 239617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(ASTContext &Ctx, 239717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 239817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // FIXME: We don't support ARC being turned on and off during one analysis. 239917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // (nor, for that matter, do we support changing ASTContexts) 240017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool ARCEnabled = (bool)Ctx.getLangOptions().ObjCAutoRefCount; 240117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 240217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!SummariesGC) 2403b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose SummariesGC.reset(new RetainSummaryManager(Ctx, true, ARCEnabled)); 240417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 240517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(SummariesGC->isARCEnabled() == ARCEnabled); 2406b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *SummariesGC; 2407b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } else { 240817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!Summaries) 2409b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose Summaries.reset(new RetainSummaryManager(Ctx, false, ARCEnabled)); 241017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 241117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(Summaries->isARCEnabled() == ARCEnabled); 2412b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *Summaries; 2413b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2414b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2415b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 241617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(CheckerContext &C) const { 241717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return getSummaryManager(C.getASTContext(), C.isObjCGCEnabled()); 241817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 241917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 24208bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void printState(raw_ostream &Out, ProgramStateRef State, 2421dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const char *NL, const char *Sep) const; 2422dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 2423390909c89c98ab1807e15e033a72e975f866fb23Anna Zaks void checkBind(SVal loc, SVal val, const Stmt *S, CheckerContext &C) const; 2424ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const; 2425ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const CastExpr *CE, CheckerContext &C) const; 2426f85e193739c953358c865005855253af4f68a497John McCall 2427294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostStmt(const CallExpr *CE, CheckerContext &C) const; 2428537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose void checkPostStmt(const CXXConstructExpr *CE, CheckerContext &C) const; 2429294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkPostObjCMessage(const ObjCMessage &Msg, CheckerContext &C) const; 2430294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose void checkSummary(const RetainSummary &Summ, const CallOrObjCMessage &Call, 2431e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2432294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 243376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 243476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 24358bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond, 2436ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 24376704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 24388bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 24398bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek checkRegionChanges(ProgramStateRef state, 2440537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 2441537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 244266c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 244366c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks const CallOrObjCMessage *Call) const; 2444ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 24458bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool wantsRegionChangeUpdate(ProgramStateRef state) const { 24462f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2447ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2448294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2449f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2450f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2451f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 24528bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek SymbolRef Sym, ProgramStateRef state) const; 2453f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 245438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 2455af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks void checkEndPath(CheckerContext &C) const; 245638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 24578bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef updateSymbol(ProgramStateRef state, SymbolRef sym, 245817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 245917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CheckerContext &C) const; 2460e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 24618bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void processNonLeakError(ProgramStateRef St, SourceRange ErrorRange, 2462294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2463294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 2464294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 246538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 246638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 24678bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef handleSymbolDeath(ProgramStateRef state, 246838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef sid, RefVal V, 246938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const; 247038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 24718bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ExplodedNode *, ProgramStateRef > 24728bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek handleAutoreleaseCounts(ProgramStateRef state, 24738d22863184419faa2348bd5148c663197bc4bb00Jordy Rose GenericNodeBuilderRefCount Bd, ExplodedNode *Pred, 24746a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, SymbolRef Sym, RefVal V) const; 24758d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 24768bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *processLeaks(ProgramStateRef state, 247738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 247838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount &Builder, 24796a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 248038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2481d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2482d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2483d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 24846704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 24856704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 24868bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 24876704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 24888bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek StopTrackingCallback(ProgramStateRef st) : state(st) {} 24898bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return state; } 24906704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 24916704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 24926704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 24936704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 24946704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 24956704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 24966704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 24976704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2498910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2499910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2500910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 25016704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2502910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2503910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2504dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2505910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2506dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2507469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 250838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2509dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 25108bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 251138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 25125eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek cast<BlockDataRegion>(state->getSVal(BE, 25135eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsRegion()); 2514dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 251538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 251638cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2517dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 251838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 251938cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2520dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 252167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 252267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 252367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 25245f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 252539ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2526c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2527dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 252867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 252967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion *VR = *I; 253067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 253167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 253267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 253367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 253467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2535dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 253667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 253767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 253867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 25390bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 254038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 254138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2542910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2543910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2544f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2545f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2546f85e193739c953358c865005855253af4f68a497John McCall return; 2547f85e193739c953358c865005855253af4f68a497John McCall 254871c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2549f85e193739c953358c865005855253af4f68a497John McCall 2550f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2551f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2552f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2553f85e193739c953358c865005855253af4f68a497John McCall return; 2554f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2555f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2556f85e193739c953358c865005855253af4f68a497John McCall break; 2557f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2558f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2559f85e193739c953358c865005855253af4f68a497John McCall break; 2560f85e193739c953358c865005855253af4f68a497John McCall } 2561f85e193739c953358c865005855253af4f68a497John McCall 25628bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 25635eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CE, C.getLocationContext()).getAsLocSymbol(); 2564f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2565f85e193739c953358c865005855253af4f68a497John McCall return; 2566f85e193739c953358c865005855253af4f68a497John McCall const RefVal* T = state->get<RefBindings>(Sym); 2567f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2568f85e193739c953358c865005855253af4f68a497John McCall return; 2569f85e193739c953358c865005855253af4f68a497John McCall 2570f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 257117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2572f85e193739c953358c865005855253af4f68a497John McCall 2573f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2574e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2575e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2576f85e193739c953358c865005855253af4f68a497John McCall return; 2577f85e193739c953358c865005855253af4f68a497John McCall } 2578f85e193739c953358c865005855253af4f68a497John McCall 25790bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 2580f85e193739c953358c865005855253af4f68a497John McCall} 2581f85e193739c953358c865005855253af4f68a497John McCall 2582910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CallExpr *CE, 2583910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2584294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Get the callee. 25858bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2586294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Callee = CE->getCallee(); 25875eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal L = state->getSVal(Callee, C.getLocationContext()); 2588294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 258917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 259093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = 0; 2591294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2592294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Better support for blocks. For now we stop tracking anything 2593294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // that is passed to blocks. 2594294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Need to handle variables that are "captured" by the block. 2595294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (dyn_cast_or_null<BlockDataRegion>(L.getAsRegion())) { 2596294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getPersistentStopSummary(); 2597294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const FunctionDecl *FD = L.getAsFunctionDecl()) { 2598294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getSummary(FD); 2599294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else if (const CXXMemberCallExpr *me = dyn_cast<CXXMemberCallExpr>(CE)) { 2600294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const CXXMethodDecl *MD = me->getMethodDecl()) 2601294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getSummary(MD); 2602294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2603294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2604294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 260593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek Summ = Summaries.getDefaultSummary(); 2606294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 26075eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(CE, state, C.getLocationContext()), C); 2608294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2609294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2610910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CXXConstructExpr *CE, 2611910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2612537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const CXXConstructorDecl *Ctor = CE->getConstructor(); 2613537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Ctor) 2614537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2615537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 261617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 261793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = Summaries.getSummary(Ctor); 2618537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 2619537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose // If we didn't get a summary, this constructor doesn't affect retain counts. 2620537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose if (!Summ) 2621537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose return; 2622537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 26238bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26245eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(CE, state, C.getLocationContext()), C); 2625537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose} 2626537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose 2627910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostObjCMessage(const ObjCMessage &Msg, 2628910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 26298bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2630294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 263117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2632b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 263393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ; 2634294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Msg.isInstanceMessage()) { 2635a2a860306e3697fcf7a12c5ba59551ca60578968Anna Zaks const LocationContext *LC = C.getLocationContext(); 2636294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getInstanceMethodSummary(Msg, state, LC); 2637294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 2638294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Summ = Summaries.getClassMethodSummary(Msg); 2639294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2640294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2641294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // If we didn't get a summary, this message doesn't affect retain counts. 2642294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Summ) 2643294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2644294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 26455eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek checkSummary(*Summ, CallOrObjCMessage(Msg, state, C.getLocationContext()), C); 2646294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2647294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2648910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2649910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2650910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// While the the return type can be queried directly from RetEx, when 2651910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2652910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2653910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2654910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2655910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2656910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2657910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2658910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2659910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2660910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2661910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2662910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2663910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2664910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2665910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2666910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2667910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2668910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2669910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2670910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2671910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2672910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2673910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2674910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2675910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2676910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 2677910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const CallOrObjCMessage &CallOrMsg, 2678910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 26798bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2680294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2681294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2682294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2683294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2684294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2685294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2686294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2687537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2688294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2689294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 2690294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RefBindings::data_type *T = state->get<RefBindings>(Sym)) { 269117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2692294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2693294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2694294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2695294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2696294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2697294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2698294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2699294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2700294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2701294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2702294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 2703e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (!hasErr && CallOrMsg.isObjCMessage()) { 270439ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2705e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose SVal Receiver = CallOrMsg.getInstanceMessageReceiver(LC); 2706e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose if (SymbolRef Sym = Receiver.getAsLocSymbol()) { 2707294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const RefVal *T = state->get<RefBindings>(Sym)) { 2708294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ReceiverIsTracked = true; 270917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 271017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose hasErr, C); 2711294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2712e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose ErrorRange = CallOrMsg.getReceiverSourceRange(); 2713294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2714294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2715294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2716294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2717294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2718294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2719294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2720294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2721294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2722294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2723294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2724294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2725294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2726294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2727294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2728294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2729b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 273017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2731b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2732294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2733294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2734294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2735294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2736294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 27377530c034c0c71a64c5a9173206d9742ae847af8bDavid Blaikie llvm_unreachable("Unhandled RetEffect."); 2738294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2739294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2740294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2741294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2742294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2743294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2744294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 27455eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 27465eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsSymbol(); 2747294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2748294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2749294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2750294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use the result type from callOrMsg as it automatically adjusts 2751294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 2752294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = CallOrMsg.getResultType(C.getASTContext()); 2753294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeOwned(RE.getObjKind(), 2754294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2755294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2756294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2757294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // *not* fail. (The code below is out-of-date, though.) 2758294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#if 0 2759294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedAllocatedSymbol) { 2760294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool isFeasible; 2761294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state.assume(loc::SymbolVal(Sym), true, isFeasible); 2762294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose assert(isFeasible && "Cannot assume fresh symbol is non-null."); 2763294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2764294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#endif 2765294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2766294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2767294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2768294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2769294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2770294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2771294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2772294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 27735eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(Ex, C.getLocationContext()).getAsSymbol(); 2774294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2775294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2776294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2777294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2778294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 2779294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeNotOwned(RE.getObjKind(), 2780294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2781294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2782294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2783294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2784294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2785294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2786294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2787294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2788294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2789294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2790294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2791294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 27920bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks NewNode = C.addTransition(state); 2793294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2794294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 27959c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 27969c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 27979c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 27989c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 27999c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 28009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 28019c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2802ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 28039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2804294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2805294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2806e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 28078bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 28088bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::updateSymbol(ProgramStateRef state, SymbolRef sym, 2809910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2810910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2811e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2812910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 281317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 281417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 281517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose IgnoreRetainMsg = (bool)C.getASTContext().getLangOptions().ObjCAutoRefCount; 281617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2817e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2818e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: break; 281917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case IncRefMsg: E = IgnoreRetainMsg ? DoNothing : IncRef; break; 282017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case DecRefMsg: E = IgnoreRetainMsg ? DoNothing : DecRef; break; 282117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case MakeCollectable: E = C.isObjCGCEnabled() ? DecRef : DoNothing; break; 282217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose case NewAutoreleasePool: E = C.isObjCGCEnabled() ? DoNothing : 282317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose NewAutoreleasePool; break; 2824e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2825e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2826e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 282717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2828e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2829e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2830e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2831e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2832e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2833e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2834e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2835e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2836e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 2837e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2838e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2839e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2840e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 284117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2842e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2843e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2844e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2845e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2846e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2847e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2848e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2849e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2850e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2851e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2852e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2853e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 2854e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2855e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2856e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2857e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2858e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2859e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2860e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2861e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2862e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case NewAutoreleasePool: 286317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!C.isObjCGCEnabled()); 2864e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->add<AutoreleaseStack>(sym); 2865e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2866e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 2867e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 2868e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2869e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2870e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2871e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2872e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2873e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2874e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 2875e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2876e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2877e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 287817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 2879e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2880e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2881e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 2882e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose state = SendAutorelease(state, ARCountFactory, sym); 2883e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 2884e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2885e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2886e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 2887e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->remove<RefBindings>(sym); 2888e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2889e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 2890e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2891e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2892e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 2893e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2894e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2895e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 2896e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2897e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 2898e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 289917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 2900e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 2901e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2902e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2903e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2904e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2905e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case SelfOwn: 2906e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2907e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2908e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 2909e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 2910e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2911e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2912e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 2913e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 2914e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2915e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2916e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 2917e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 2918e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 2919e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 2920e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 2921e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2922e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2923e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2924e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() > 0) 2925e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 2926e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose else { 2927e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 2928e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2929e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2930e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2931e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2932e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 2933e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 293417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 2935e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2936e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2937e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2938e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2939e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2940e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2941e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2942e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 2943e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 29448bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::processNonLeakError(ProgramStateRef St, 2945910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 2946910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 2947910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 2948910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2949294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 2950294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 2951294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2952294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2953294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 2954294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 2955294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 2956294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 2957294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 2958d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 2959d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 2960d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 2961294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2962294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 2963d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 2964d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 2965d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 2966294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2967294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 2968d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 2969d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 2970d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 2971294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2972294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 2973d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 2974d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 2975d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 2976294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2977294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2978294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2979d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 29802058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOptions(), 298117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 298217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 2983294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 2984294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.EmitReport(report); 2985294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2986294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2987910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2988910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 2989910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2990910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2991910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 299276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 29938bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2994b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *FD = C.getCalleeDecl(CE); 299576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 299676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 299776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 299876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 299976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 300076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 300176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 300276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 300376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 300476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 300576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 300676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 300776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 300876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 300976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 301076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 301176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 301276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 301376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 301476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 301576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3016b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks QualType ResultTy = CE->getCallReturnType(); 301776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 301876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 301976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 302076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 302176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 302276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 302376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 302476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 302576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 302676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 302776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 302876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 302976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 303076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 303176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 303276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 303376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 30345eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = C.getLocationContext(); 30355eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal RetVal = state->getSVal(CE->getArg(0), LCtx); 303676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 303776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 303876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 30395d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 30403133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek SVal RetVal = SVB.getConjuredSymbolVal(0, CE, LCtx, ResultTy, Count); 304176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 30425eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal, false); 304376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3044294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3045294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3046294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3047294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3048294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 3049294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefBindings::data_type *Binding = 0; 3050294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 3051294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Binding = state->get<RefBindings>(Sym); 305276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3053294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 30545d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 30553133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek state = state->invalidateRegions(ArgRegion, CE, Count, LCtx); 305676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3057294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3058294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 3059294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, *Binding); 3060294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3061294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 30620bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 306376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 306476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 306576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3066910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3067910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3068910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3069f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3070910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3071910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3072f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3073f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3074f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3075f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 30768bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 30775eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = 30785eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state->getSValAsScalarOrLoc(RetE, C.getLocationContext()).getAsLocSymbol(); 3079f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3080f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3081f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3082f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 3083f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const RefVal *T = state->get<RefBindings>(Sym); 3084f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3085f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3086f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3087f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3088f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3089f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3090f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3091f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3092f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3093f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3094f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3095f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3096f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3097f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3098f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3099f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3100f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3101f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3102f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3103f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3104f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3105f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3106f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3107f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3108f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3109f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3110f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3111f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3112f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3113f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3114f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3115f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 3116f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 31170bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *Pred = C.addTransition(state); 3118f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3119f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3120f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3121f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3122f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3123f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3124f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3125f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3126f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3127f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3128f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3129910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 31304eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, &AutoreleaseTag); 31316a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, Sym, X); 3132f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3133f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 31348d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!Pred) 3135f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3136f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3137f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 3138f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose T = state->get<RefBindings>(Sym); 3139f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3140f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3141f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3142f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 314317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3144f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 3145f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3146f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3147f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Unlike regular functions, /all/ ObjC methods are assumed to always 3148f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // follow Cocoa retain-count conventions, not just those with special 3149f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // names or attributes. 3150b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 3151f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RetEffect RE = Summ ? Summ->getRetEffect() : RetEffect::MakeNoRet(); 3152f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3153f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3154f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3155f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 3156f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<CXXMethodDecl>(FD)) 3157b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (const RetainSummary *Summ = Summaries.getSummary(FD)) 3158f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose checkReturnWithRetEffect(S, C, Pred, Summ->getRetEffect(), X, 3159f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose Sym, state); 3160f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3161f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3162f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3163910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3164910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3165910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3166910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3167910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 31688bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state) const { 3169f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3170f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3171f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3172f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 317317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3174f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3175f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3176f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3177f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3178f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3179f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3180f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3181f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3182f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3183f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3184f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3185f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3186f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3187f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3188f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3189f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3190f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 3191f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 3192f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3193f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3194910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 31950bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnOwnLeakTag); 3196f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 319717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose const LangOptions &LOpts = C.getASTContext().getLangOptions(); 319817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3199f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 320017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 320117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 32026a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks N, Sym, C); 3203f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3204f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3205f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3206f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3207f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3208f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3209f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3210f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 3211f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X ^ RefVal::ErrorReturnedNotOwned); 3212f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3213f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3214910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 32150bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnNotOwnedTag); 3216f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3217d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3218d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3219d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3220f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3221d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 322217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.getASTContext().getLangOptions(), 322317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3224f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3225f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3226f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3227f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3228f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3229f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32308d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3231910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3232910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3233910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3234390909c89c98ab1807e15e033a72e975f866fb23Anna Zaksvoid RetainCountChecker::checkBind(SVal loc, SVal val, const Stmt *S, 3235910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3236910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3237910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3238910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3239910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3240910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3241910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3242910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3243910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3244910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 32458bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3246910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3247910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (loc::MemRegionVal *regionLoc = dyn_cast<loc::MemRegionVal>(&loc)) { 3248910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3249910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3250910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3251910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3252910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3253910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3254910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = (state == (state->bindLoc(*regionLoc, val))); 3255910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3256910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3257910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3258910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3259910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3260910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3261910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3262910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3263910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3264910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3265910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3266910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 32670bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 3268910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3269910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 32708bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef RetainCountChecker::evalAssume(ProgramStateRef state, 3271910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3272910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3273910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3274910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3275910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3276910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3277910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3278910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3279910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3280910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings B = state->get<RefBindings>(); 3281910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3282910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3283910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3284910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3285910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3286910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings::Factory &RefBFactory = state->get_context<RefBindings>(); 3287910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3288910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3289910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Check if the symbol is null (or equal to any constant). 3290910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If this is the case, stop tracking the symbol. 3291910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (state->getSymVal(I.getKey())) { 3292910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3293910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3294910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3295910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3296910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3297910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3298910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3299910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3300910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3301910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3302910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 33038bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 33048bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::checkRegionChanges(ProgramStateRef state, 3305910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 3306910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 330766c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 330866c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks const CallOrObjCMessage *Call) const { 3309910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3310910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3311910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3312910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3313910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3314910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3315910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3316910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3317910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3318910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3319910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (StoreManager::InvalidatedSymbols::const_iterator I=invalidated->begin(), 3320910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3321910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3322910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3323910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3324910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 3325910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->remove<RefBindings>(sym); 3326910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3327910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3328910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3329910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3330910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 33318d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 33328d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 33338d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33348bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstd::pair<ExplodedNode *, ProgramStateRef > 33358bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleAutoreleaseCounts(ProgramStateRef state, 3336910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount Bd, 33376a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred, 33386a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 3339910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 33408d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 33418d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33428d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 33438d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 33448d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(Pred, state); 33458d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33466a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks assert(!Ctx.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 33478d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 33488d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33498d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 33508d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33518d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 33528d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 33538d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33548d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 33558d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 33568d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 33578d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 33588d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 33598d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 33608d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 33618d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 33628d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setCount(Cnt - ACnt); 33638d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 33648d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 33658d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 33668d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ExplodedNode *N = Bd.MakeNode(state, Pred); 33678d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (N == 0) 33688d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = 0; 33698d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(N, state); 33708d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 33718d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33728d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 33738d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 33748d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 33758d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 33768d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3377f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks if (ExplodedNode *N = Bd.MakeNode(state, Pred, true)) { 3378f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<128> sbuf; 33798d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 33808d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 33818d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 33828d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 33838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 33848d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3385d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3386d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3387d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 33886a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const LangOptions &LOpts = Ctx.getASTContext().getLangOptions(); 33898d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3390d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3391d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 33926a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 33938d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 33948d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 33958bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek return std::make_pair((ExplodedNode *)0, (ProgramStateRef )0); 33968d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 339738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 33988bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 33998bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleSymbolDeath(ProgramStateRef state, 3400910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 340138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 34025337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 340338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 340438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 340538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 340638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 340738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 340838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 340938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->remove<RefBindings>(sid); 341038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 341138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 341238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->set<RefBindings>(sid, V ^ RefVal::ErrorLeak); 341338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 341438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 341538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 34168bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::processLeaks(ProgramStateRef state, 3417910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 3418910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount &Builder, 34196a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 34206a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred) const { 342138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (Leaked.empty()) 342238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return Pred; 342338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 342438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 342538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *N = Builder.MakeNode(state, Pred); 342638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 342738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 342838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 342938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 343038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 34316a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const LangOptions &LOpts = Ctx.getASTContext().getLangOptions(); 34326a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks bool GCEnabled = Ctx.isObjCGCEnabled(); 343317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 343417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 343538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 34362058956954802229bf98604e8063fa57677abff4Jordy Rose 343717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 34386a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks SummaryLog, N, *I, Ctx); 34396a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 344038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 344138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 344238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 344338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 344438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 344538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3446af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaksvoid RetainCountChecker::checkEndPath(CheckerContext &Ctx) const { 34478bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Ctx.getState(); 3448af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks GenericNodeBuilderRefCount Bd(Ctx); 344938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 3450af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred = Ctx.getPredecessor(); 345138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 345238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 34536a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, Ctx, 34548d22863184419faa2348bd5148c663197bc4bb00Jordy Rose I->first, I->second); 34558d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 345638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 345738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 345838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 34590cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // If the current LocationContext has a parent, don't check for leaks. 34600cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // We will do that later. 34610cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // FIXME: we should instead check for imblances of the retain/releases, 34620cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // and suggest annotations. 34630cf3d471546251b12bdceff360f66c079c40526cTed Kremenek if (Ctx.getLocationContext()->getParent()) 34640cf3d471546251b12bdceff360f66c079c40526cTed Kremenek return; 34650cf3d471546251b12bdceff360f66c079c40526cTed Kremenek 346638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 346738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 346838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 346938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) 34708d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 347138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 34726a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks processLeaks(state, Leaked, Bd, Ctx, Pred); 347338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 347438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 347538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3476910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 347738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 347838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 3479f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<64> buf; 348038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3481f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks out << "RetainCountChecker : Dead Symbol : "; 3482f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks sym->dumpToStream(out); 348338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 348438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 348538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 348638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 348738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3488910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3489910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 349038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 349138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 34928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 349338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 349438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 349538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 349638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 349738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 349838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 349938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 350038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 350138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 35024eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, getDeadSymbolTag(Sym)); 35036a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, 35048d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Sym, *T); 35058d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 350638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 350738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 350838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 350938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 351038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 351138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 351238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 351338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 351438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 351538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(*I)) 351638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = handleSymbolDeath(state, *I, *T, Leaked); 351738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 351838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 351938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose { 35204eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, this); 35216a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Pred = processLeaks(state, Leaked, Bd, C, Pred); 352238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 352338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 352438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 352538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 352638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 352738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 352838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 352938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings::Factory &F = state->get_context<RefBindings>(); 353038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 353138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 353238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) 353338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 353438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 353538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 35360bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state, Pred); 353738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 353838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3539d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek//===----------------------------------------------------------------------===// 3540dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose// Debug printing of refcount bindings and autorelease pools. 3541dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3542dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3543dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rosestatic void PrintPool(raw_ostream &Out, SymbolRef Sym, 35448bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State) { 3545dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ' '; 3546dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (Sym) 3547f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks Sym->dumpToStream(Out); 3548dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose else 3549dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "<pool>"; 3550dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ":{"; 3551dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3552dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Get the contents of the pool. 3553dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (const ARCounts *Cnts = State->get<AutoreleasePoolContents>(Sym)) 3554dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARCounts::iterator I = Cnts->begin(), E = Cnts->end(); I != E; ++I) 3555dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '(' << I.getKey() << ',' << I.getData() << ')'; 3556dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3557dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '}'; 3558dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3559dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 35608bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic bool UsesAutorelease(ProgramStateRef state) { 3561dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // A state uses autorelease if it allocated an autorelease pool or if it has 3562dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // objects in the caller's autorelease pool. 3563dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose return !state->get<AutoreleaseStack>().isEmpty() || 3564dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose state->get<AutoreleasePoolContents>(SymbolRef()); 3565dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3566dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 35678bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::printState(raw_ostream &Out, ProgramStateRef State, 3568910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3569dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3570dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose RefBindings B = State->get<RefBindings>(); 3571dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3572dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3573dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3574dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3575dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3576dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3577dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3578dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3579dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3580dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3581dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Print the autorelease stack. 3582dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (UsesAutorelease(State)) { 3583dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL << "AR pool stack:"; 3584dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose ARStack Stack = State->get<AutoreleaseStack>(); 3585dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3586dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, SymbolRef(), State); // Print the caller's pool. 3587dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARStack::iterator I = Stack.begin(), E = Stack.end(); I != E; ++I) 3588dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, *I, State); 3589dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3590dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3591dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3592dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3593dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3594dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3595910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 35966b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 35976b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 359817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3599910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 360017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 360117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3602