RetainCountChecker.cpp revision d563d3fb73879df7147b8a5302c3bf0e1402ba18
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" 26f540c54701e3eeb34cb619a3a4eb18f1ac70ef2dJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 27910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h" 2818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h" 299b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.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, 694531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose DecRefAndStopTracking, DecRefMsgAndStopTracking, 70bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Rose IncRefMsg, IncRef, MakeCollectable, MayEscape, 7129299c6c98fa05f635c984898d0e9b5fcbb412d4Jordan Rose NewAutoreleasePool, StopTracking }; 72553cf18cd44769a7624fc942493f076498527529Ted Kremenek 736b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremeneknamespace llvm { 74b77449cead63264650958c92cb30609c942cc5e9Ted Kremenektemplate <> struct FoldingSetTrait<ArgEffect> { 75b77449cead63264650958c92cb30609c942cc5e9Ted Kremenekstatic inline void Profile(const ArgEffect X, FoldingSetNodeID& ID) { 76b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ID.AddInteger((unsigned) X); 77b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek} 78553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 796b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end llvm namespace 806b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 81b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek/// ArgEffects summarizes the effects of a function/method call on all of 82b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek/// its arguments. 83b77449cead63264650958c92cb30609c942cc5e9Ted Kremenektypedef llvm::ImmutableMap<unsigned,ArgEffect> ArgEffects; 84b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek 856b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremeneknamespace { 86553cf18cd44769a7624fc942493f076498527529Ted Kremenek 87553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// RetEffect is used to summarize a function/method call's behavior with 881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// respect to its return value. 89ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetEffect { 906b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 9176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose enum Kind { NoRet, OwnedSymbol, OwnedAllocatedSymbol, 92f85e193739c953358c865005855253af4f68a497John McCall NotOwnedSymbol, GCNotOwnedSymbol, ARCNotOwnedSymbol, 9378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek OwnedWhenTrackedReceiver }; 941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum ObjKind { CF, ObjC, AnyObj }; 962d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 976b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekprivate: 982d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek Kind K; 992d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek ObjKind O; 1002d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 10176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose RetEffect(Kind k, ObjKind o = AnyObj) : K(k), O(o) {} 1021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1036b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 1042d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek Kind getKind() const { return K; } 1052d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 1062d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek ObjKind getObjKind() const { return O; } 1071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 108a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek bool isOwned() const { 10978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek return K == OwnedSymbol || K == OwnedAllocatedSymbol || 11078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek K == OwnedWhenTrackedReceiver; 111a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek } 1121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1134df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetEffect &Other) const { 1144df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return K == Other.K && O == Other.O; 1154df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 1164df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 11778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek static RetEffect MakeOwnedWhenTrackedReceiver() { 11878a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek return RetEffect(OwnedWhenTrackedReceiver, ObjC); 11978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek } 1201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1212d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek static RetEffect MakeOwned(ObjKind o, bool isAllocated = false) { 1222d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return RetEffect(isAllocated ? OwnedAllocatedSymbol : OwnedSymbol, o); 1231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1242d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek static RetEffect MakeNotOwned(ObjKind o) { 1252d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return RetEffect(NotOwnedSymbol, o); 126e798e7c5a107ff5262005431817409a855a67922Ted Kremenek } 127e798e7c5a107ff5262005431817409a855a67922Ted Kremenek static RetEffect MakeGCNotOwned() { 128e798e7c5a107ff5262005431817409a855a67922Ted Kremenek return RetEffect(GCNotOwnedSymbol, ObjC); 129e798e7c5a107ff5262005431817409a855a67922Ted Kremenek } 130f85e193739c953358c865005855253af4f68a497John McCall static RetEffect MakeARCNotOwned() { 131f85e193739c953358c865005855253af4f68a497John McCall return RetEffect(ARCNotOwnedSymbol, ObjC); 132f85e193739c953358c865005855253af4f68a497John McCall } 133553cf18cd44769a7624fc942493f076498527529Ted Kremenek static RetEffect MakeNoRet() { 134553cf18cd44769a7624fc942493f076498527529Ted Kremenek return RetEffect(NoRet); 135a73447013c919d43f40c05451f5e4b662c043d6dTed Kremenek } 136ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 137ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void Profile(llvm::FoldingSetNodeID& ID) const { 138ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.AddInteger((unsigned) K); 139ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.AddInteger((unsigned) O); 140ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 1416b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 1421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 143b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 144b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// Reference-counting logic (typestate + counts). 145b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 1461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 147ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RefVal { 148b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 149b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek enum Kind { 150b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Owned = 0, // Owning reference. 151b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek NotOwned, // Reference is not owned by still valid (not freed). 152b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Released, // Object has been released. 153b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedOwned, // Returned object passes ownership to caller. 154b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedNotOwned, // Return object does not pass ownership to caller. 155b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_START, 156b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocNotOwned, // -dealloc called on non-owned object. 157b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocGC, // Calling -dealloc with GC enabled. 158b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorUseAfterRelease, // Object used after released. 159b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReleaseNotOwned, // Release of an object that was not owned. 160b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_LEAK_START, 161b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeak, // A memory leak due to excessive reference counts. 162b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeakReturned, // A memory leak due to the returning method not having 163b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // the correct naming conventions. 164b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorGCLeakReturned, 165b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorOverAutorelease, 166b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReturnedNotOwned 167b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek }; 168dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 169b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekprivate: 170b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind kind; 171b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind okind; 172b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Cnt; 173b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned ACnt; 174b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType T; 175dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 176b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal(Kind k, RetEffect::ObjKind o, unsigned cnt, unsigned acnt, QualType t) 177b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek : kind(k), okind(o), Cnt(cnt), ACnt(acnt), T(t) {} 178dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 179b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 180b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind getKind() const { return kind; } 181dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 182b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind getObjKind() const { return okind; } 183dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 184b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCount() const { return Cnt; } 185b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getAutoreleaseCount() const { return ACnt; } 186b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCombinedCounts() const { return Cnt + ACnt; } 187b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void clearCounts() { Cnt = 0; ACnt = 0; } 188b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setCount(unsigned i) { Cnt = i; } 189b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setAutoreleaseCount(unsigned i) { ACnt = i; } 190dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 191b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType getType() const { return T; } 192dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 193b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isOwned() const { 194b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == Owned; 195b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 196dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 197b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isNotOwned() const { 198b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == NotOwned; 199b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 200dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 201b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedOwned() const { 202b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedOwned; 203b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 204dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 205b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedNotOwned() const { 206b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedNotOwned; 207b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 208dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 209b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeOwned(RetEffect::ObjKind o, QualType t, 210b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 1) { 211b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(Owned, o, Count, 0, t); 212b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 213dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 214b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeNotOwned(RetEffect::ObjKind o, QualType t, 215b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 0) { 216b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(NotOwned, o, Count, 0, t); 217b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 218dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 219b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Comparison, profiling, and pretty-printing. 220dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 221b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool operator==(const RefVal& X) const { 222b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return kind == X.kind && Cnt == X.Cnt && T == X.T && ACnt == X.ACnt; 223b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 224dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 225b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator-(size_t i) const { 226b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount() - i, 227b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getAutoreleaseCount(), getType()); 228b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 229dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 230b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator+(size_t i) const { 231b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount() + i, 232b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getAutoreleaseCount(), getType()); 233b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 234dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 235b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator^(Kind k) const { 236b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(k, getObjKind(), getCount(), getAutoreleaseCount(), 237b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 238b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 239dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 240b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal autorelease() const { 241b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount(), getAutoreleaseCount()+1, 242b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 243b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 244dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 245b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 246b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger((unsigned) kind); 247b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(Cnt); 248b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(ACnt); 249b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.Add(T); 250b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 251dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2529c378f705405d37f49795d5e915989de774fe11fTed Kremenek void print(raw_ostream &Out) const; 253b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek}; 254b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 2559c378f705405d37f49795d5e915989de774fe11fTed Kremenekvoid RefVal::print(raw_ostream &Out) const { 256b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (!T.isNull()) 257dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "Tracked " << T.getAsString() << '/'; 258dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 259b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek switch (getKind()) { 260910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose default: llvm_unreachable("Invalid RefVal kind"); 261b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Owned: { 262b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Owned"; 263b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 264b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 265b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 266b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 267dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 268b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case NotOwned: { 269b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "NotOwned"; 270b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 271b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 272b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 273b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 274dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 275b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedOwned: { 276b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedOwned"; 277b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 278b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 279b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 280b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 281dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 282b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedNotOwned: { 283b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedNotOwned"; 284b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 285b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 286b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 287b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 288dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 289b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Released: 290b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Released"; 291b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 292dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 293b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocGC: 294b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (GC)"; 295b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 296dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 297b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocNotOwned: 298b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (not-owned)"; 299b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 300dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 301b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeak: 302b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked"; 303b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 304dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 305b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeakReturned: 306b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (Bad naming)"; 307b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 308dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 309b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorGCLeakReturned: 310b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (GC-ed at return)"; 311b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 312dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 313b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorUseAfterRelease: 314b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Use-After-Release [ERROR]"; 315b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 316dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 317b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorReleaseNotOwned: 318b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Release of Not-Owned [ERROR]"; 319b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 320dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 321b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorOverAutorelease: 322b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Over autoreleased"; 323b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 324dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 325b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorReturnedNotOwned: 326b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Non-owned object returned instead of owned"; 327b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 328b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 329dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 330b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (ACnt) { 331b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << " [ARC +" << ACnt << ']'; 332b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 333b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 334b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} //end anonymous namespace 335b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 336b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 337b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// RefBindings - State used to track object reference counts. 338b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 339b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 340b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, RefVal> RefBindings; 341b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 342b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace clang { 3439ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 34418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> 34518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenekstruct ProgramStateTrait<RefBindings> 34618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<RefBindings> { 34718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static void *GDMIndex() { 34818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static int RefBIndex = 0; 34918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek return &RefBIndex; 35018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek } 35118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek}; 352b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 3535a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} 354b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 355b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 356910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Function/Method behavior summaries. 357b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 358b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 359b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace { 360ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummary { 361ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// Args - a map of (index, ArgEffect) pairs, where index 3621bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// specifies the argument (starting from 0). This can be sparsely 3631bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// populated; arguments with no entry in Args use 'DefaultArgEffect'. 364b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects Args; 3651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3661bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// DefaultArgEffect - The default ArgEffect to apply to arguments that 3671bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// do not have an entry in Args. 3680507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect DefaultArgEffect; 3691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 370553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Receiver - If this summary applies to an Objective-C message expression, 371553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// this is the effect applied to the state of the receiver. 3720507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect Receiver; 3731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 374553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ret - The effect on the return value. Used to indicate if the 37576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose /// function/method call returns a new tracked symbol. 3760507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek RetEffect Ret; 3771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3786b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 379b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetainSummary(ArgEffects A, RetEffect R, ArgEffect defaultEff, 380e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect ReceiverEff) 381e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose : Args(A), DefaultArgEffect(defaultEff), Receiver(ReceiverEff), Ret(R) {} 3821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 383553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArg - Return the argument effect on the argument specified by 384553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// idx (starting from 0). 3851ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek ArgEffect getArg(unsigned idx) const { 386b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek if (const ArgEffect *AE = Args.lookup(idx)) 387b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return *AE; 3881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3891bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek return DefaultArgEffect; 3901ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 39111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 39211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek void addArg(ArgEffects::Factory &af, unsigned idx, ArgEffect e) { 39311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek Args = af.add(Args, idx, e); 39411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 3951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 396885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setDefaultArgEffect - Set the default argument effect. 397885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setDefaultArgEffect(ArgEffect E) { 398885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek DefaultArgEffect = E; 399885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek } 4001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 401553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getRetEffect - Returns the effect on the return value of the call. 402b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetEffect getRetEffect() const { return Ret; } 4031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 404885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setRetEffect - Set the effect of the return value of the call. 405885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setRetEffect(RetEffect E) { Ret = E; } 4061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 40812b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek /// Sets the effect on the receiver of the message. 40912b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek void setReceiverEffect(ArgEffect e) { Receiver = e; } 41012b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 411553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getReceiverEffect - Returns the effect on the receiver of the call. 412553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// This is only meaningful if the summary applies to an ObjCMessageExpr*. 413b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffect getReceiverEffect() const { return Receiver; } 4144df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 4154df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// Test if two retain summaries are identical. Note that merely equivalent 4164df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// summaries are not necessarily identical (for example, if an explicit 4174df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// argument effect matches the default effect). 4184df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetainSummary &Other) const { 4194df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return Args == Other.Args && DefaultArgEffect == Other.DefaultArgEffect && 4204df54feb02d72b76249e846053d5d53d820bf832Jordy Rose Receiver == Other.Receiver && Ret == Other.Ret; 4214df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 422ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 423ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// Profile this summary for inclusion in a FoldingSet. 424ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void Profile(llvm::FoldingSetNodeID& ID) const { 425ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Args); 426ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(DefaultArgEffect); 427ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Receiver); 428ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Ret); 429ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 430ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 431ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// A retain summary is simple if it has no ArgEffects other than the default. 432ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose bool isSimple() const { 433ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return Args.isEmpty(); 434ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 4354531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 4364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Roseprivate: 4374531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffects getArgEffects() const { return Args; } 4384531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffect getDefaultArgEffect() const { return DefaultArgEffect; } 4394531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 4404531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose friend class RetainSummaryManager; 4416b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 4424f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} // end anonymous namespace 4436b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 444553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 445553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for constructing summaries. 446553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 447553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4484f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 449ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryKey { 450553cf18cd44769a7624fc942493f076498527529Ted Kremenek IdentifierInfo* II; 451553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector S; 4521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 453553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(IdentifierInfo* ii, Selector s) 454553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(ii), S(s) {} 455553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4569c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, Selector s) 457553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(d ? d->getIdentifier() : 0), S(s) {} 45870b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek 459553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(Selector s) 460553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(0), S(s) {} 4611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4620507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek IdentifierInfo *getIdentifier() const { return II; } 463553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector getSelector() const { return S; } 464553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 4654f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} 4664f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek 4674f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace llvm { 468553cf18cd44769a7624fc942493f076498527529Ted Kremenektemplate <> struct DenseMapInfo<ObjCSummaryKey> { 469553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getEmptyKey() { 470553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getEmptyKey(), 471553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::getEmptyKey()); 472553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 474553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getTombstoneKey() { 475553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getTombstoneKey(), 4761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump DenseMapInfo<Selector>::getTombstoneKey()); 477553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 479553cf18cd44769a7624fc942493f076498527529Ted Kremenek static unsigned getHashValue(const ObjCSummaryKey &V) { 48028b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer typedef std::pair<IdentifierInfo*, Selector> PairTy; 48128b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer return DenseMapInfo<PairTy>::getHashValue(PairTy(V.getIdentifier(), 48228b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer V.getSelector())); 483553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 485553cf18cd44769a7624fc942493f076498527529Ted Kremenek static bool isEqual(const ObjCSummaryKey& LHS, const ObjCSummaryKey& RHS) { 48628b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer return LHS.getIdentifier() == RHS.getIdentifier() && 48728b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer LHS.getSelector() == RHS.getSelector(); 488553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 490553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 49106159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <> 49206159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<ObjCSummaryKey> { static const bool value = true; }; 493553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end llvm namespace 4941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 495553cf18cd44769a7624fc942493f076498527529Ted Kremeneknamespace { 496ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryCache { 49793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<ObjCSummaryKey, const RetainSummary *> MapTy; 498553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy M; 499553cf18cd44769a7624fc942493f076498527529Ted Kremenekpublic: 500553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryCache() {} 5011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 50293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, Selector S) { 503553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Do a lookup with the (D,S) pair. If we find a match return 504553cf18cd44769a7624fc942493f076498527529Ted Kremenek // the iterator. 505553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey K(D, S); 506553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy::iterator I = M.find(K); 5071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5084531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (I != M.end()) 509614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I->second; 5104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!D) 5114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return NULL; 5121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 513553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Walk the super chain. If we find a hit with a parent, we'll end 514553cf18cd44769a7624fc942493f076498527529Ted Kremenek // up returning that summary. We actually allow that key (null,S), as 515553cf18cd44769a7624fc942493f076498527529Ted Kremenek // we cache summaries for the null ObjCInterfaceDecl* to allow us to 516553cf18cd44769a7624fc942493f076498527529Ted Kremenek // generate initial summaries without having to worry about NSObject 517553cf18cd44769a7624fc942493f076498527529Ted Kremenek // being declared. 518553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: We may change this at some point. 5199c378f705405d37f49795d5e915989de774fe11fTed Kremenek for (ObjCInterfaceDecl *C=D->getSuperClass() ;; C=C->getSuperClass()) { 520553cf18cd44769a7624fc942493f076498527529Ted Kremenek if ((I = M.find(ObjCSummaryKey(C, S))) != M.end()) 521553cf18cd44769a7624fc942493f076498527529Ted Kremenek break; 5221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 523553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (!C) 524614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return NULL; 5254f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek } 5261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Cache the summary with original key to make the next lookup faster 528553cf18cd44769a7624fc942493f076498527529Ted Kremenek // and return the iterator. 52993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = I->second; 530614cc540a617978814e37d75bf5066926b921a0aTed Kremenek M[K] = Summ; 531614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return Summ; 532553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5340507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *find(IdentifierInfo* II, Selector S) { 535553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: Class method lookup. Right now we dont' have a good way 536553cf18cd44769a7624fc942493f076498527529Ted Kremenek // of going between IdentifierInfo* and the class hierarchy. 537614cc540a617978814e37d75bf5066926b921a0aTed Kremenek MapTy::iterator I = M.find(ObjCSummaryKey(II, S)); 5381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 539614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (I == M.end()) 540614cc540a617978814e37d75bf5066926b921a0aTed Kremenek I = M.find(ObjCSummaryKey(S)); 5411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 542614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I == M.end() ? NULL : I->second; 543553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](ObjCSummaryKey K) { 546553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[K]; 547553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](Selector S) { 550553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[ ObjCSummaryKey(S) ]; 551553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 553553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end anonymous namespace 554553cf18cd44769a7624fc942493f076498527529Ted Kremenek 555553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 556553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for managing collections of summaries. 557553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 558553cf18cd44769a7624fc942493f076498527529Ted Kremenek 5594f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 560ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummaryManager { 561d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 562d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 563d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Typedefs. 564d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<const FunctionDecl*, const RetainSummary *> 567d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy; 5681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5694f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek typedef ObjCSummaryCache ObjCMethodSummariesTy; 5701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 571ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose typedef llvm::FoldingSetNodeWrapper<RetainSummary> CachedSummaryNode; 572ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 573d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 574d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Data. 575d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 577553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ctx - The ASTContext object for the analyzed ASTs. 5789c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &Ctx; 579179064eb831125630c296556dd6d67e67f716143Ted Kremenek 580553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// GCEnabled - Records whether or not the analyzed code runs in GC mode. 581377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek const bool GCEnabled; 5821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 583f85e193739c953358c865005855253af4f68a497John McCall /// Records whether or not the analyzed code runs in ARC mode. 584f85e193739c953358c865005855253af4f68a497John McCall const bool ARCEnabled; 585f85e193739c953358c865005855253af4f68a497John McCall 586553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// FuncSummaries - A map from FunctionDecls to summaries. 5871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump FuncSummariesTy FuncSummaries; 5881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 589553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCClassMethodSummaries - A map from selectors (for instance methods) 590553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// to summaries. 5911f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCClassMethodSummaries; 592d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 593553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCMethodSummaries - A map from selectors to summaries. 5941f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCMethodSummaries; 595d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 596553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// BPAlloc - A BumpPtrAllocator used for allocating summaries, ArgEffects, 597553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// and all other data used by the checker. 598d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek llvm::BumpPtrAllocator BPAlloc; 5991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 600b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek /// AF - A factory for ArgEffects objects. 6011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ArgEffects::Factory AF; 6021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 603553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ScratchArgs - A holding buffer for construct ArgEffects. 6040507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffects ScratchArgs; 6051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 606ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// ObjCAllocRetE - Default return effect for methods returning Objective-C 607ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// objects. 608ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek RetEffect ObjCAllocRetE; 609547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek 6101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// ObjCInitRetE - Default return effect for init methods returning 611ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek /// Objective-C objects. 612547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek RetEffect ObjCInitRetE; 6131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 614ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// SimpleSummaries - Used for uniquing summaries that don't have special 615ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// effects. 616ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSet<CachedSummaryNode> SimpleSummaries; 6171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 618d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 619d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Methods. 620d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 6211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 622553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArgEffects - Returns a persistent ArgEffects object based on the 623553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// data in ScratchArgs. 624b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects getArgEffects(); 62500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 6261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum UnaryFuncKind { cfretain, cfrelease, cfmakecollectable }; 62793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek 6280507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getUnarySummary(const FunctionType* FT, 62993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek UnaryFuncKind func); 6301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6310507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryCreateRule(const FunctionDecl *FD); 6320507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryGetRule(const FunctionDecl *FD); 6330507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFCreateGetRuleSummary(const FunctionDecl *FD); 6341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 635ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(const RetainSummary &OldSumm); 636706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 637ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(RetEffect RetEff, 63893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect ReceiverEff = DoNothing, 63993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect DefaultEff = MayEscape) { 640ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummary Summ(getArgEffects(), RetEff, DefaultEff, ReceiverEff); 641ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(Summ); 6429c32d08925045b32d7c39516e35d860159252e1dTed Kremenek } 6431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 644c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek const RetainSummary *getDoNothingSummary() { 645c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 646c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } 647c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek 648ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getDefaultSummary() { 649ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 650ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose DoNothing, MayEscape); 651ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 652706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 653ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentStopSummary() { 654ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 655ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose StopTracking, StopTracking); 6561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 657b309525445c8ec3d36e49568382029efc2740554Ted Kremenek 6581f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeClassMethodSummaries(); 6591f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeMethodSummaries(); 660896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekprivate: 66193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectClsMethSummary(Selector S, const RetainSummary *Summ) { 662553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCClassMethodSummaries[S] = Summ; 663553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 66593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectMethSummary(Selector S, const RetainSummary *Summ) { 666553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCMethodSummaries[S] = Summ; 667553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6683aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek 669a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek void addClassMethSummary(const char* Cls, const char* name, 670a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek const RetainSummary *Summ, bool isNullary = true) { 6713aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 672a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek Selector S = isNullary ? GetNullarySelector(name, Ctx) 673a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek : GetUnarySelector(name, Ctx); 6743aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6753aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek } 6761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6776c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek void addInstMethSummary(const char* Cls, const char* nullaryName, 67893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ) { 6796c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6806c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6816c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek ObjCMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6826c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek } 6831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 684de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector generateSelector(va_list argp) { 6855f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<IdentifierInfo*, 10> II; 686de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6879e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek while (const char* s = va_arg(argp, const char*)) 6889e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek II.push_back(&Ctx.Idents.get(s)); 689de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return Ctx.Selectors.getSelector(II.size(), &II[0]); 691de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 6921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 693de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addMethodSummary(IdentifierInfo *ClsII, ObjCMethodSummariesTy& Summaries, 69493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * Summ, va_list argp) { 695de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector S = generateSelector(argp); 696de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Summaries[ObjCSummaryKey(ClsII, S)] = Summ; 69770a733e64e2379a654631a14fa29e46761d5f80dTed Kremenek } 6981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 69993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addInstMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 700af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_list argp; 701af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_start(argp, Summ); 702de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls), ObjCMethodSummaries, Summ, argp); 7031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump va_end(argp); 704af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek } 7051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 707de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 708de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 709de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls),ObjCClassMethodSummaries, Summ, argp); 710de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 711de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(IdentifierInfo *II, const RetainSummary * Summ, ...) { 714de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 715de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 716de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(II, ObjCClassMethodSummaries, Summ, argp); 717de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 718de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 719de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7206b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 7211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7229c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummaryManager(ASTContext &ctx, bool gcenabled, bool usesARC) 723179064eb831125630c296556dd6d67e67f716143Ted Kremenek : Ctx(ctx), 724f85e193739c953358c865005855253af4f68a497John McCall GCEnabled(gcenabled), 725f85e193739c953358c865005855253af4f68a497John McCall ARCEnabled(usesARC), 726f85e193739c953358c865005855253af4f68a497John McCall AF(BPAlloc), ScratchArgs(AF.getEmptyMap()), 727f85e193739c953358c865005855253af4f68a497John McCall ObjCAllocRetE(gcenabled 728f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 729f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 730f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwned(RetEffect::ObjC, true))), 731f85e193739c953358c865005855253af4f68a497John McCall ObjCInitRetE(gcenabled 732f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 733f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 734ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose : RetEffect::MakeOwnedWhenTrackedReceiver())) { 735553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeClassMethodSummaries(); 736553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeMethodSummaries(); 737553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 7381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7394531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getSummary(const CallEvent &Call, 7404531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State = 0); 7411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getFunctionSummary(const FunctionDecl *FD); 7434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 7444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getMethodSummary(Selector S, const ObjCInterfaceDecl *ID, 745f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, 746f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose QualType RetTy, 747f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries); 748f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 749cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const RetainSummary *getInstanceMethodSummary(const ObjCMethodCall &M, 7504531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State); 751dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 752cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const RetainSummary *getClassMethodSummary(const ObjCMethodCall &M) { 7534531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(!M.isInstanceMessage()); 7544531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCInterfaceDecl *Class = M.getReceiverInterface(); 7551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7564531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(M.getSelector(), Class, M.getDecl(), 7574531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose M.getResultType(), ObjCClassMethodSummaries); 758fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek } 759552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek 760552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// getMethodSummary - This version of getMethodSummary is used to query 761552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// the summary for the current method being analyzed. 76293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getMethodSummary(const ObjCMethodDecl *MD) { 763a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID = MD->getClassInterface(); 76470a6576c9c8d21ff2361574f4937a2e73bd57779Ted Kremenek Selector S = MD->getSelector(); 765552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek QualType ResultTy = MD->getResultType(); 7661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 767f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy *CachedSummaries; 768552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek if (MD->isInstanceMethod()) 769f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCMethodSummaries; 770552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek else 771f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCClassMethodSummaries; 772f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 7734531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(S, ID, MD, ResultTy, *CachedSummaries); 774552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek } 7751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 776f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *getStandardMethodSummary(const ObjCMethodDecl *MD, 7774531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Selector S, QualType RetTy); 778a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek 77993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7804dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD); 7814dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 78293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7834dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD); 7844dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 7854531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose void updateSummaryForCall(const RetainSummary *&Summ, 7864531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &Call); 7874531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 788d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek bool isGCEnabled() const { return GCEnabled; } 7891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 790f85e193739c953358c865005855253af4f68a497John McCall bool isARCEnabled() const { return ARCEnabled; } 791f85e193739c953358c865005855253af4f68a497John McCall 792f85e193739c953358c865005855253af4f68a497John McCall bool isARCorGCEnabled() const { return GCEnabled || ARCEnabled; } 7934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 7944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetEffect getObjAllocRetEffect() const { return ObjCAllocRetE; } 7954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 7964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose friend class RetainSummaryTemplate; 7976b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 7981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7990fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// Used to avoid allocating long-term (BPAlloc'd) memory for default retain 8000fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// summaries. If a function or method looks like it has a default summary, but 8010fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// it has annotations, the annotations are added to the stack-based template 8020fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// and then copied into managed memory. 8030fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Roseclass RetainSummaryTemplate { 8040fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &Manager; 80593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *&RealSummary; 8060fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary ScratchSummary; 8070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose bool Accessed; 8080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rosepublic: 8094531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate(const RetainSummary *&real, RetainSummaryManager &mgr) 8104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose : Manager(mgr), RealSummary(real), ScratchSummary(*real), Accessed(false) {} 8110fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8120fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose ~RetainSummaryTemplate() { 81393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek if (Accessed) 814ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RealSummary = Manager.getPersistentSummary(ScratchSummary); 8150fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8160fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8170fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary &operator*() { 8180fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 81993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return ScratchSummary; 8200fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8210fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8220fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *operator->() { 8230fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 82493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return &ScratchSummary; 8250fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8260fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose}; 8270fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8286b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end anonymous namespace 8296b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 8306b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8316b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek// Implementation of checker data structures. 8326b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8336b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 834b77449cead63264650958c92cb30609c942cc5e9Ted KremenekArgEffects RetainSummaryManager::getArgEffects() { 835b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects AE = ScratchArgs; 8363baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.getEmptyMap(); 837b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return AE; 83800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 83900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 84093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 841ef94588752babc1b7c46b955e57945fc4c183db2Jordy RoseRetainSummaryManager::getPersistentSummary(const RetainSummary &OldSumm) { 842ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose // Unique "simple" summaries -- those without ArgEffects. 843ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (OldSumm.isSimple()) { 844ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSetNodeID ID; 845ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose OldSumm.Profile(ID); 846ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 847ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void *Pos; 848ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose CachedSummaryNode *N = SimpleSummaries.FindNodeOrInsertPos(ID, Pos); 849ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 850ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (!N) { 851ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose N = (CachedSummaryNode *) BPAlloc.Allocate<CachedSummaryNode>(); 852ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (N) CachedSummaryNode(OldSumm); 853ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose SimpleSummaries.InsertNode(N, Pos); 854ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 855ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 856ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return &N->getValue(); 857ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 858ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 85993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 860ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (Summ) RetainSummary(OldSumm); 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 8824531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rosestatic ArgEffect getStopTrackingEquivalent(ArgEffect E) { 8834531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose switch (E) { 8844531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DoNothing: 8854531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case Autorelease: 8864531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefBridgedTransfered: 8874531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRef: 8884531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRefMsg: 8894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MakeCollectable: 8904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MayEscape: 8914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case NewAutoreleasePool: 8924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case StopTracking: 8934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return StopTracking; 8944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRef: 8954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefAndStopTracking: 8964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return DecRefAndStopTracking; 8974531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsg: 8984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsgAndStopTracking: 8994531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return DecRefMsgAndStopTracking; 9004531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case Dealloc: 9014531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return Dealloc; 9024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9034531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose llvm_unreachable("Unknown ArgEffect kind"); 9054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 9064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9074531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rosevoid RetainSummaryManager::updateSummaryForCall(const RetainSummary *&S, 9084531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &Call) { 9094531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Call.hasNonZeroCallbackArg()) { 9104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffect RecEffect = getStopTrackingEquivalent(S->getReceiverEffect()); 9114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffect DefEffect = getStopTrackingEquivalent(S->getDefaultArgEffect()); 9124531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9134531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffects CustomArgEffects = S->getArgEffects(); 9144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose for (ArgEffects::iterator I = CustomArgEffects.begin(), 9154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = CustomArgEffects.end(); 9164531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose I != E; ++I) { 9174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffect Translated = getStopTrackingEquivalent(I->second); 9184531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Translated != DefEffect) 9194531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ScratchArgs = AF.add(ScratchArgs, I->first, Translated); 9204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9214531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9224531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetEffect RE = RetEffect::MakeNoRet(); 9234531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9244531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // Special cases where the callback argument CANNOT free the return value. 9254531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // This can generally only happen if we know that the callback will only be 9264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // called when the return value is already being deallocated. 9274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const FunctionCall *FC = dyn_cast<FunctionCall>(&Call)) { 9284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose IdentifierInfo *Name = FC->getDecl()->getIdentifier(); 9294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9304531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // This callback frees the associated buffer. 9314531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Name->isStr("CGBitmapContextCreateWithData")) 9324531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = S->getRetEffect(); 9334531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9344531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9354531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose S = getPersistentSummary(RE, RecEffect, DefEffect); 9364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9374531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 9384531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9394531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Roseconst RetainSummary * 9404531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getSummary(const CallEvent &Call, 9414531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State) { 9424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ; 9434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose switch (Call.getKind()) { 9444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_Function: 9454531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getFunctionSummary(cast<FunctionCall>(Call).getDecl()); 9464531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 9474531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_CXXMember: 948fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose case CE_CXXMemberOperator: 9494531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_Block: 9504531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_CXXConstructor: 9518d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose case CE_CXXDestructor: 95270cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 9534531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: These calls are currently unsupported. 9544531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getPersistentStopSummary(); 9558919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case CE_ObjCMessage: { 956cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCMethodCall &Msg = cast<ObjCMethodCall>(Call); 9574531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Msg.isInstanceMessage()) 9584531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getInstanceMethodSummary(Msg, State); 9594531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose else 9604531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getClassMethodSummary(Msg); 9614531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 9624531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9634531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9644531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9654531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose updateSummaryForCall(Summ, Call); 9664531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9674531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Unknown call type?"); 9684531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return Summ; 9694531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 9704531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 97158822c403cc8855adeecba92248612ee08dc1f3aAnna Zaksconst RetainSummary * 9724531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getFunctionSummary(const FunctionDecl *FD) { 9734531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we don't know what function we're calling, use our default summary. 9744531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!FD) 9754531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getDefaultSummary(); 9764531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 977891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 978d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 979d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 980891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 981891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 982e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 98393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *S = 0; 9841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 98537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 9861261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 9871261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 9881261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 9891261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 9901261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 9911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 992183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 99399890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 994183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 99548c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 99648c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 99748c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 998b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 999b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 10001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1001bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 1002bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 1003b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 10041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10051261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 10061261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 10071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10081261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 10091261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 1010008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 1011e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1012befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek if (FName == "pthread_create" || FName == "pthread_setspecific") { 1013befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // Part of: <rdar://problem/7299394> and <rdar://problem/11282706>. 1014befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // This will be addressed better with IPA. 1015b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 1016b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 1017b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 1018b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 1019b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 1020b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 1021b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 1022b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 1023b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 1024537dd3a8c87765245aad792a3356852a87380a30Ted Kremenek FName == "IORegistryEntrySearchCFProperty" || 1025b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 1026b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 1027b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 1028b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 1029b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 1030b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 1031b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 1032b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 1033b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 1034b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 1035b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 10363baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 1037b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1038b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 1039b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 1040b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 1041b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 10423baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 1043b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1044b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 1045b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 1046b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 1047b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 1048b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 1049b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 1050b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 10513baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 1052b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1053b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 1054b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 1055b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 1056b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 1057b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 10583baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 1059b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 1060b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 1061b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 1062b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 1063b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 1064b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 1065b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 1066b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 10673baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 1068b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 106906911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek } else if (FName == "dispatch_set_context") { 107006911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // <rdar://problem/11059275> - The analyzer currently doesn't have 107106911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // a good way to reason about the finalizer function for libdispatch. 107206911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // If we pass a context object that is memory managed, stop tracking it. 107306911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // FIXME: this hack should possibly go away once we can handle 107406911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // libdispatch finalizers. 107506911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 107606911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1077c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } else if (FName.startswith("NSLog")) { 1078c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek S = getDoNothingSummary(); 107962a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks } else if (FName.startswith("NS") && 108062a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks (FName.find("Insert") != StringRef::npos)) { 108162a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // Whitelist NSXXInsertXX, for example NSMapInsertIfAbsent, since they can 108262a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // be deallocated by NSMapRemove. (radar://11152419) 108362a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 108462a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 2, StopTracking); 108562a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1086b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 10871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1088b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 1089b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 1090b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 109161991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 109261991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Enable this code once the semantics of NSDeallocateObject are resolved 109361991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // for GC. <rdar://problem/6619988> 109461991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#if 0 109561991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // Handle: NSDeallocateObject(id anObject); 109661991903335144605031c3597a5c99e1565b0bd4Ted Kremenek // This method does allow 'nil' (although we don't check it now). 10971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (strcmp(FName, "NSDeallocateObject") == 0) { 109861991903335144605031c3597a5c99e1565b0bd4Ted Kremenek return RetTy == Ctx.VoidTy 109961991903335144605031c3597a5c99e1565b0bd4Ted Kremenek ? getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, Dealloc) 110061991903335144605031c3597a5c99e1565b0bd4Ted Kremenek : getPersistentStopSummary(); 110161991903335144605031c3597a5c99e1565b0bd4Ted Kremenek } 110261991903335144605031c3597a5c99e1565b0bd4Ted Kremenek#endif 11031261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11041261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (RetTy->isPointerType()) { 11051261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 110678acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 11071261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 11081261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 110976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 11101261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 11111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 11127df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 11131261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 111437d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 111537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11161261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11171261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 111878acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 11191261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 11201261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 11211261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 11227df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 11231261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 112437d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 112537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11261261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11271261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 112878acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 112978acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 113078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 11317df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1132706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1133706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 11341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11351261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 113637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11371261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11381261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 11391261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 11401261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1141e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1142b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1143e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1144bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 11451261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 11461261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1147b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11486818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 11496818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 11506818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 11516818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 11526818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 11531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 11546818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 11551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 11566818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 11576818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 11586818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1159c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1160c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1161c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1162c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1163e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1164e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1165e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1166e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1167c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 11686818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 11691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11706818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 11711261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 117264e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 117337d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 117437d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 11751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11764531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we got all the way here without any luck, use a default summary. 11774531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!S) 11784531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose S = getDefaultSummary(); 11794531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 11804dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 11814df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(S, FD); 11821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1183d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 11841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 11852fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 11862fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 118793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11887df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 11897df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 119086ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 11911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1192d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 119300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 119400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 119593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 11966ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 11976ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 11986ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 11991261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 12001261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 120172564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 12021261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 12031261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 12041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1205b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 12061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 120776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1208377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 120976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 121076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 121176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 1212940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 121376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 121476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 121576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 121600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 121700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 121893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12199c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1220b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 12211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12222d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 122300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 122400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 122593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12269c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 12271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 12282d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 12292d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 123000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 123100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 12326b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1233d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1234d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1235d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 12364dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 123793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 12384dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 12394dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 12404dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 12414dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 12424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Must have a summary to add annotations to."); 12434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate Template(Summ, *this); 12444df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 124511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 124611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 124711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 124898b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 124911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 125011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 12514df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 12520fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 12534df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 12544df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 12550fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 125611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 125711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 125811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1259b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 12601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12614dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 126278acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 126340b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 12640fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 12654dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 126640b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 12670fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1268b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 12696041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>()) { 12700fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 12716041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12726041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 12730fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 12746041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 12754df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (RetTy->getAs<PointerType>()) { 127640b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 12770fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 12784dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1279d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 12800fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1281d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 12824dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 12834dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 12844dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 12854dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 128693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 128793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD) { 12884dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 12894dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 12904dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 12914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Must have a valid summary to add annotations to"); 12924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate Template(Summ, *this); 12936d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 12941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 129512b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 129612b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 129711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 12980fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 129911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 130011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 130111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 130211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1303491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1304491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 130511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 130611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 130711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 130811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 13090fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 131011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 131111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 13120fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 131311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 131412b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 131512b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 13164dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 131778acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 131840b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 13190fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 13206d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 13214dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 13226041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>()) { 13230fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 13246041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 13256041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13276d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 13280fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 13296217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 13300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 13311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13326041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 13336041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 13340fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 13356041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 13360fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 13376041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13384dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 13394dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 134093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1341f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy RoseRetainSummaryManager::getStandardMethodSummary(const ObjCMethodDecl *MD, 1342f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Selector S, QualType RetTy) { 13438ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek 1344fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek if (MD) { 1345376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Scan the method decl for 'void*' arguments. These should be treated 1346376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // as 'StopTracking' because they are often used with delegates. 1347376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // Delegates are a frequent form of false positives with the retain 1348376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek // count checker. 1349376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek unsigned i = 0; 1350491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator I = MD->param_begin(), 1351376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek E = MD->param_end(); I != E; ++I, ++i) 1352491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis if (const ParmVarDecl *PD = *I) { 1353376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek QualType Ty = Ctx.getCanonicalType(PD->getType()); 1354a4923eb7c4b04d360cb2747641a5e92818edf804Douglas Gregor if (Ty.getLocalUnqualifiedType() == Ctx.VoidPtrTy) 13553baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, i, StopTracking); 1356376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 1357376d1e72c31c8b362eb3a035751c662140a7e5d7Ted Kremenek } 13581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1359e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Any special effects? 13608ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 1361e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetEffect ResultEff = RetEffect::MakeNoRet(); 1362e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose 1363e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Check the method family, and apply any default annotations. 1364e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (MD ? MD->getMethodFamily() : S.getMethodFamily()) { 1365e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_None: 1366e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_performSelector: 1367e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Assume all Objective-C methods follow Cocoa Memory Management rules. 1368e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // FIXME: Does the non-threaded performSelector family really belong here? 1369e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // The selector could be, say, @selector(copy). 1370e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1371e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::ObjC); 1372e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) { 1373e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // ObjCMethodDecl currently doesn't consider CF objects as valid return 1374e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // values for alloc, new, copy, or mutableCopy, so we have to 1375e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // double-check with the selector. This is ugly, but there aren't that 1376e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // many Objective-C methods that return CF objects, right? 1377e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (MD) { 1378e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (S.getMethodFamily()) { 1379e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1380e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1381e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1382e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1383e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1384e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1385e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose default: 1386e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1387e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1388e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1389e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } else { 1390e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1391e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1392e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1393e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1394e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_init: 1395e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCInitRetE; 1396e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1397e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1398e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1399e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1400e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1401e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1402e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1403e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCAllocRetE; 1404e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) 1405e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1406e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1407e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_autorelease: 1408e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Autorelease; 1409e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1410e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retain: 1411e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = IncRefMsg; 1412e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1413e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_release: 1414e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1415e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1416e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_dealloc: 1417e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Dealloc; 1418e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1419e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_self: 1420e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // -self is handled specially by the ExprEngine to propagate the receiver. 1421e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1422e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retainCount: 1423e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_finalize: 1424e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // These methods don't return objects. 1425e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1426e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 14271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14288ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 14298ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 14308ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 14318ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 14328ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 143350571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose for (unsigned i = 0, e = S.getNumArgs(); i != e; ++i) { 143450571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose StringRef Slot = S.getNameForSlot(i); 143550571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (Slot.substr(Slot.size() - 8).equals_lower("delegate")) { 143650571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (ResultEff == ObjCInitRetE) 143750571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose ResultEff = RetEffect::MakeNoRet(); 143850571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose else 143950571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose ReceiverEff = StopTracking; 144050571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 144150571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 14428ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 14431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1444e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing && 1445e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff.getKind() == RetEffect::NoRet) 144693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 14471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1448e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose return getPersistentSummary(ResultEff, ReceiverEff, MayEscape); 1449250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1450250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 145193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1452cde8cdbd6a662c636164465ad309b5f17ff01064Jordan RoseRetainSummaryManager::getInstanceMethodSummary(const ObjCMethodCall &Msg, 14534531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State) { 14544531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCInterfaceDecl *ReceiverClass = 0; 14554531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 14564531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // We do better tracking of the type of the object than the core ExprEngine. 14574531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // See if we have its type in our private state. 14584531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: Eventually replace the use of state->get<RefBindings> with 14594531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // a generic API for reasoning about the Objective-C types of symbolic 14604531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // objects. 14614531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose SVal ReceiverV = Msg.getReceiverSVal(); 14624531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (SymbolRef Sym = ReceiverV.getAsLocSymbol()) 14634531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const RefVal *T = State->get<RefBindings>(Sym)) 14644531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const ObjCObjectPointerType *PT = 1465b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 14664531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverClass = PT->getInterfaceDecl(); 1467dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 14684531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we don't know what kind of object this is, fall back to its static type. 14694531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!ReceiverClass) 14704531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverClass = Msg.getReceiverInterface(); 147104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1472b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1473b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 14744531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // id x = [NSObject class]; 14754531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // [x performSelector:... withObject:... afterDelay:...]; 14764531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Selector S = Msg.getSelector(); 14774531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCMethodDecl *Method = Msg.getDecl(); 14784531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!Method && ReceiverClass) 14794531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Method = ReceiverClass->getInstanceMethod(S); 14804531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 14814531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(S, ReceiverClass, Method, Msg.getResultType(), 14824531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ObjCMethodSummaries); 1483b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1484b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 148593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 14864531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getMethodSummary(Selector S, const ObjCInterfaceDecl *ID, 1487f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, QualType RetTy, 1488f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries) { 14891bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 14908711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 14914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ = CachedSummaries.find(ID, S); 14921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1493614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1494f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Summ = getStandardMethodSummary(MD, S, RetTy); 14954df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1496614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 14974df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 14984df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1499614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 15004531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose CachedSummaries[ObjCSummaryKey(ID, S)] = Summ; 1501614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 15021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1503e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1504c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1505c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 15061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1507ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 15081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 15096fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 15102d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 15111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15126d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 15133baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 15146fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 15156fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 15166fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 15179c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 15189c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 15191f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 15201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 15221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1523c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1524c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 152593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1526ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1527ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1528ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1529ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1530ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1531ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 15321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1533c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 153493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 153593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *CFAllocSumm = 1536a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 15371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15383c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1539500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 154093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1541553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 15421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15433c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1544500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1545553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 15461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1547299e8158d63d69830cca0187f4003cba1e66081fTed Kremenek // Create the "drain" selector. 1548500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, isGCEnabled() ? DoNothing : DecRef); 1549553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); 15501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1551f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1552500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1553f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 15543c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 15553c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1556500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1557553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 15581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1559f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek // Specially handle NSAutoreleasePool. 15606c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek addInstMethSummary("NSAutoreleasePool", "init", 1561500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose getPersistentSummary(NoRet, NewAutoreleasePool)); 15621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 156489e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 156589e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 156689e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 156789e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 15683aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 156993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 157078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 157178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 15721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 157399d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 157499d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 15753aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#if 0 157678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1577af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 157978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSWindow", NoTrackYet, "initWithContentRect", 1580af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 15813aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek#endif 15821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1583179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1584179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 158599d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 158699d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 158799d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 15881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 158978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#if 0 159078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1591af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", NULL); 15921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 159378a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek addInstMethSummary("NSPanel", NoTrackYet, "initWithContentRect", 1594af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek "styleMask", "backing", "defer", "screen", NULL); 159578a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek#endif 15961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1597ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // Don't track allocated autorelease pools yet, as it is okay to prematurely 1598ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1599ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1600a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek addClassMethSummary("NSAutoreleasePool", "allocWithZone", NoTrackYet, false); 1601553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1602767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1603767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1604767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1605767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1606767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1607767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1608211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1609a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1610a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1611a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1612767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1613a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 16141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1615a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1616211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1617b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1618b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1619d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 16204d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek// AutoreleaseBindings - State used to track objects in autorelease pools. 16216d34893fc886f4153f104de8880876764981cb7fTed Kremenek//===----------------------------------------------------------------------===// 16226d34893fc886f4153f104de8880876764981cb7fTed Kremenek 16234d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, unsigned> ARCounts; 16244d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, ARCounts> ARPoolContents; 16254d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenektypedef llvm::ImmutableList<SymbolRef> ARStack; 1626f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek 16274d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenekstatic int AutoRCIndex = 0; 16286d34893fc886f4153f104de8880876764981cb7fTed Kremenekstatic int AutoRBIndex = 0; 16296d34893fc886f4153f104de8880876764981cb7fTed Kremenek 1630ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleasePoolContents {}; } 1631ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamnamespace { class AutoreleaseStack {}; } 16324d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 16336d34893fc886f4153f104de8880876764981cb7fTed Kremeneknamespace clang { 16349ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 163518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleaseStack> 163618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARStack> { 16379c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRBIndex; } 16384d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 16394d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek 164018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> struct ProgramStateTrait<AutoreleasePoolContents> 164118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<ARPoolContents> { 16429c378f705405d37f49795d5e915989de774fe11fTed Kremenek static inline void *GDMIndex() { return &AutoRCIndex; } 16434d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek}; 16445a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 16454d3957da69d41f69a5e1a00829efbf9803d809e3Ted Kremenek} // end clang namespace 16466d34893fc886f4153f104de8880876764981cb7fTed Kremenek 16478bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic SymbolRef GetCurrentAutoreleasePool(ProgramStateRef state) { 16487037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARStack stack = state->get<AutoreleaseStack>(); 16497037ab8f15950e594642adf77a56d299667debe7Ted Kremenek return stack.isEmpty() ? SymbolRef() : stack.getHead(); 16507037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 16517037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 16528bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic ProgramStateRef 16538bef8238181a30e52dea380789a7e2d760eac532Ted KremenekSendAutorelease(ProgramStateRef state, 165418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ARCounts::Factory &F, 165518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek SymbolRef sym) { 16567037ab8f15950e594642adf77a56d299667debe7Ted Kremenek SymbolRef pool = GetCurrentAutoreleasePool(state); 1657b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const ARCounts *cnts = state->get<AutoreleasePoolContents>(pool); 16587037ab8f15950e594642adf77a56d299667debe7Ted Kremenek ARCounts newCnts(0); 16591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 16607037ab8f15950e594642adf77a56d299667debe7Ted Kremenek if (cnts) { 16617037ab8f15950e594642adf77a56d299667debe7Ted Kremenek const unsigned *cnt = (*cnts).lookup(sym); 16623baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(*cnts, sym, cnt ? *cnt + 1 : 1); 16637037ab8f15950e594642adf77a56d299667debe7Ted Kremenek } 16647037ab8f15950e594642adf77a56d299667debe7Ted Kremenek else 16653baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek newCnts = F.add(F.getEmptyMap(), sym, 1); 16661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1667b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek return state->set<AutoreleasePoolContents>(pool, newCnts); 16687037ab8f15950e594642adf77a56d299667debe7Ted Kremenek} 16697037ab8f15950e594642adf77a56d299667debe7Ted Kremenek 16701392261ff4418a070fb919cb4832b76b468b6faaTed Kremenek//===----------------------------------------------------------------------===// 1671c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1672c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1673c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1674ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1675ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1676ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1677c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1678c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 16791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 16801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1681ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1682c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 168335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 16846fd4505ad67a186da8cc26fdb493c93fe4937555Ted Kremenek : BugType(name, categories::MemoryCoreFoundationObjectiveC) {} 1685c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1687c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 168835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 16891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1690c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1691c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1693ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1694c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 169535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 169735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1698c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1700c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1702ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1703c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 170435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 17051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 170635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1707bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1708bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1709b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1710c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1712ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1713c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 171435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 171535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 17161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1717c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1718369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 17191499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1720c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1722ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1723c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 172435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 172535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 17261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1727c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1728c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 172900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 17301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 17311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1732ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1733369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 173435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 173535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 17361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1737369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1738eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1739369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1740369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 17411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1742ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1743e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 174435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 174535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 17461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1747e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 17485b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1749e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1750e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1751e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 17521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1753ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1754facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer public: 1755facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer Leak(StringRef name) 1756facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer : CFRefBug(name) { 1757db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1758db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1759db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 17601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 176135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 17621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1763c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1764c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1766c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1767c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1768c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 17691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1770011534973e83db51f49098871186238fc64d5f54Jordy Rose class CFRefReportVisitor : public BugReporterVisitorImpl<CFRefReportVisitor> { 177123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1772dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1773ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 177435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 177523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1776dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 177735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 177835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1779dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 178023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1781dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1782dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1783dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1784dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1785dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 178623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 178723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 178823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 178923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 179023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 179123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 179223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 179323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 179423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 179523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 179623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 179723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 179835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1799ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 180035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 180123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 180223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 180323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 180423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1805011534973e83db51f49098871186238fc64d5f54Jordy Rose 1806011534973e83db51f49098871186238fc64d5f54Jordy Rose virtual BugReporterVisitor *clone() const { 1807011534973e83db51f49098871186238fc64d5f54Jordy Rose // The curiously-recurring template pattern only works for one level of 1808011534973e83db51f49098871186238fc64d5f54Jordy Rose // subclassing. Rather than make a new template base for 1809011534973e83db51f49098871186238fc64d5f54Jordy Rose // CFRefReportVisitor, we simply override clone() to do the right thing. 1810011534973e83db51f49098871186238fc64d5f54Jordy Rose // This could be trouble someday if BugReporterVisitorImpl is ever 1811011534973e83db51f49098871186238fc64d5f54Jordy Rose // used for something else besides a convenient implementation of clone(). 1812011534973e83db51f49098871186238fc64d5f54Jordy Rose return new CFRefLeakReportVisitor(*this); 1813011534973e83db51f49098871186238fc64d5f54Jordy Rose } 1814dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1815dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1816e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 18172058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 181835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1819c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 18202058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 18212058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 18222058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1823edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 182423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 18252058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 18262058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1827dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1828eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 18292058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 18302058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 18312058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1832edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 18332058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 18342058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1835dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 18361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1837e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1838edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1839edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1840e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1841c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1842640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1843c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1844c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1845eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1846ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1847c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 184823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1849c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 18502058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 18512058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 18526a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx); 18531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1854590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1855590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1856590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1857590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 18581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 18595216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 18605216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 18612058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 18622058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1863f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 18641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1865e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 18667f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 18672058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 186835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 186935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18717f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 18722058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 187335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 187435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18767f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 18772058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 187835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 187935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 188035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 188135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 188235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 188335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 188435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 188535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 188635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18877f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1888c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 188935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1890f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 189135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1892c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1893e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1894910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18955f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1896c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18975f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1898c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1899c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 19001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1901c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1902c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1903c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 190470fdbc366da85880aae5baebd3351e993ca05603Jordy Rosestatic bool isNumericLiteralExpression(const Expr *E) { 190570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // FIXME: This set of cases was copied from SemaExprObjC. 190670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose return isa<IntegerLiteral>(E) || 190770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CharacterLiteral>(E) || 190870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<FloatingLiteral>(E) || 190970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<ObjCBoolLiteralExpr>(E) || 191070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CXXBoolLiteralExpr>(E); 191170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 191270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 1913dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1914dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1915dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1916dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 191728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // FIXME: We will eventually need to handle non-statement-based events 191828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // (__attribute__((cleanup))). 1919f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<StmtPoint>(N->getLocation())) 19202033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 19211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19228966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 19238bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef PrevSt = PrevN->getState(); 19248bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef CurrSt = N->getState(); 19255eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = N->getLocationContext(); 19261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const RefVal* CurrT = CurrSt->get<RefBindings>(Sym); 1928c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 19291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1930b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 1931b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal *PrevT = PrevSt->get<RefBindings>(Sym); 19321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1933c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1934c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1935c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1936c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 19371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1938c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1939c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1940c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 1941f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19431a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (isa<ObjCArrayLiteral>(S)) { 19441a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSArray literal is an object with a +0 retain count"; 19451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 19461a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else if (isa<ObjCDictionaryLiteral>(S)) { 19471a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSDictionary literal is an object with a +0 retain count"; 1948c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 194970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else if (const ObjCBoxedExpr *BL = dyn_cast<ObjCBoxedExpr>(S)) { 195070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (isNumericLiteralExpression(BL->getSubExpr())) 195170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "NSNumber literal is an object with a +0 retain count"; 195270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else { 195370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ObjCInterfaceDecl *BoxClass = 0; 195470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (const ObjCMethodDecl *Method = BL->getBoxingMethod()) 195570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose BoxClass = Method->getClassInterface(); 195670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 195770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // We should always be able to find the boxing class interface, 195870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // but consider this future-proofing. 195970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (BoxClass) 196070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << *BoxClass << " b"; 196170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else 196270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "B"; 196370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 196470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "oxed expression produces an object with a +0 retain count"; 196570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 196670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 19671a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19681a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 19691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Get the name of the callee (if it is available). 19701a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee(), LCtx); 19711a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 19721a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "Call to function '" << *FD << '\''; 19731a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else 19741a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "function call"; 19751a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19761a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19778919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose assert(isa<ObjCMessageExpr>(S)); 1978d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &Mgr = CurrSt->getStateManager().getCallEventManager(); 1979d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<ObjCMethodCall> Call 1980d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = Mgr.getObjCMethodCall(cast<ObjCMessageExpr>(S), CurrSt, LCtx); 1981d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 1982d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose switch (Call->getMessageKind()) { 19838919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Message: 19848919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Method"; 19858919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19868919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_PropertyAccess: 19878919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Property"; 19888919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19898919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Subscript: 19908919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Subscript"; 19918919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19928919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 19931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19951a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 19961a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns a Core Foundation object with a "; 19971a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19981a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19991a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 20001a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns an Objective-C object with a "; 20011a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 20021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20031a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.isOwned()) { 20041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+1 retain count"; 20051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (GCEnabled) { 20071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 20081a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << ". " 20091a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek "Core Foundation objects are not automatically garbage collected."; 20101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 20111a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 20121a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 20131a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.isNotOwned()); 20141a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+0 retain count"; 2015c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2016cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 20171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2018220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2019220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 2020c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 2021cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 20221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2023c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 2024c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 20255f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 20261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2027ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 2028ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 2029c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 2030c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 2031f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 20321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20335f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 2034c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 2035c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 2036c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 20371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20385f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 2039c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 20401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2041c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 2042c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 20435eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI, LCtx).getAsLocSymbol() != Sym) 2044c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 20451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2046c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 2047c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 2048c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2049c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 205104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 20525eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver, LCtx) 20535eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek .getAsLocSymbol() == Sym) { 2054c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 2055c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 2056c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2057c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20581c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 20591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2060c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 2061c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 2062c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 20631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2064c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 206535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 2066c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2067c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 2068c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 2069c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 2070c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2071f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 2072c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 2073f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 2074f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 2075c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2077c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 2078c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 2079c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 2080f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 20815eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = 20825eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee(), LCtx); 20839c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 20841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 208535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 2086c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2087c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 20881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2089b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "In GC mode a call to '" << *FD 2090c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 2091c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 20921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2093c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2094c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 2095c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 2096c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 2097c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2098c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2099c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 2100c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 2101c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 21023eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 21031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 2104b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "When GC is not enabled a call to '" << *FD 2105c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 21061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2107c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 2108c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2109c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 2112c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 2113c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 21141ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 21151ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 21161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2117f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 2118f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 2119f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 2120f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 21211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2122264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 2123eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 2124f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 2125f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 21261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2127c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 2128c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 2129c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2130c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 21311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2132c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 2133c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 21341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2135c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 213635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 213774b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << " The object is not eligible for garbage collection until " 213874b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "the retain count reaches 0 again."; 2139c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2141c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21431ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2144c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 21451ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 21461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2147c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 214874b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose // Autoreleases can be applied after marking a node ReturnedOwned. 214974b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose if (CurrV.getAutoreleaseCount()) 215074b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose return NULL; 215174b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose 215274b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << "Object returned to caller as an owning reference (single " 215374b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "retain count transferred to caller)"; 2154c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2156c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2157f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2158c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2160c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2161c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2162c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2164c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 21655f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2166c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 21671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2168c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 216935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2170c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2171c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2172c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2173c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2174c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2175c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2176c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2177c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2178c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2179c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2180c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2181c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2182c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 21841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2185c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2186c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 21872033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 2188f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 2189220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2190220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 21919c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 21921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2193c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2194c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 21951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 21965f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 21979c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 21985eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp, LCtx).getAsLocSymbol() == Sym) { 2199c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2200c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2201c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 22021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2203c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2204c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2205c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2206e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// Find the first node in the current function context that referred to the 2207e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// tracked symbol and the memory location that value was stored to. Note, the 2208e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// value is only reported if the allocation occurred in the same function as 2209e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// the leak. 2210c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 221118c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2212c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 22139c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 22141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 2215e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks const LocationContext *LeakContext = N->getLocationContext(); 22161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2217c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 22188bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St = N->getState(); 2219c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefBindings B = St->get<RefBindings>(); 22201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2221c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!B.lookup(Sym)) 2222940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 22231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 222427b867ea1c9cb4b40f9b817c303d6df3ee753da9Anna Zaks StoreManager::FindUniqueBinding FB(Sym); 22251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 22261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 22271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2228e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // Allocation node, is the last node in the current context in which the 2229e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // symbol was tracked. 2230e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() == LeakContext) 2231e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks Last = N; 2232e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 22331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 22341ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 22351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2236e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // If allocation happened in a function different from the leak node context, 2237e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // do not report the binding. 2238e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() != LeakContext) { 2239e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks FirstBinding = 0; 2240e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks } 2241e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 2242c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 22436b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 22446b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2245c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 224623f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 224723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 224823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 224976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 225023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2251c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2252fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2253c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 225423f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 225523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 225623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 22571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22588966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2259c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 226076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 22611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2262c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2263c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2264c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 22659c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2266c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 22671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2268c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2269f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 22701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22714fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 22721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2273c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2274c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2275c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 22769c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 22774fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 22781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2279c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2280c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 22811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2282f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 22831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2284f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2285f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2286f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2287f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2288f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2289f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 22901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2291c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 2292c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const RefVal* RV = EndN->getState()->get<RefBindings>(Sym); 22931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2294c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2295c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 22965b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2297c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2298d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2299d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2300d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek os << " is returned from a method whose name ('" 2301d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << MD->getSelector().getAsString() 2302d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 23035b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose " This violates the naming convention rules" 2304f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " given in the Memory Management Guide for Cocoa"; 2305d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2306d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2307d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2308b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek os << " is returned from a function whose name ('" 2309a59d20b135bfde058a5a69045bab5ec4e2553f74Benjamin Kramer << *FD 2310d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 2311b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek " convention rules given in the Memory Management Guide for Core" 2312f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " Foundation"; 2313d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2314c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2315e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 23169c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2317e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 231882f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 231982f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 232082f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 232182f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2322e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2323c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2324abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2325f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 23261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2327c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2328c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2329cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 23302058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 23312058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 23322058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 23336a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx) 23342058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 23351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2336fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2337c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2338c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2339c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2340c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2341c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2342c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2343c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 23449c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 23451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23466a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const SourceManager& SMgr = Ctx.getSourceManager(); 2347590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2348c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 23496a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks GetAllocationSite(Ctx.getStateManager(), getErrorNode(), sym); 23501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2351c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2352852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: This will crash the analyzer if an allocation comes from an 2353852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // implicit call. (Currently there are no such allocations in Cocoa, though.) 2354852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const Stmt *AllocStmt; 2355c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 2356852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CallExitEnd *Exit = dyn_cast<CallExitEnd>(&P)) 2357852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose AllocStmt = Exit->getCalleeContext()->getCallSite(); 2358852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose else 2359852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose AllocStmt = cast<PostStmt>(P).getStmt(); 2360852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose assert(AllocStmt && "All allocations must come from explicit calls"); 2361590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2362590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2363c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2364c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2365c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2366dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 23672058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2368dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2369212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << "of an object"; 23701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2371c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2372c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2373212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << " stored into '" << AllocBinding->getString() << '\''; 2374dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 23752058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2376c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2377c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2378c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2379c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2380c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2381c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2382d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2383910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 23849c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 238538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 23869c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 238738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::EndPath, 23886704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2389f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 23901a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCArrayLiteral>, 23911a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCDictionaryLiteral>, 239270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose check::PostStmt<ObjCBoxedExpr>, 2393fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose check::PostCall, 2394f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 23956704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 239676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 239776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 23986f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 23996f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 24006f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 24016f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 24026f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 240338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 240438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 240538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 240638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 240738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 240838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 24096f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> Summaries; 24106f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> SummariesGC; 2411b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 2412e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose mutable ARCounts::Factory ARCountFactory; 2413e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 24149c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 24159c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 24169c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24172f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2418910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 241938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2420910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 242138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 242238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 242338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 24249c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 24259c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 24269c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 24279c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 24289c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 24299c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 24309c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 24319c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 24329c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 24339c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 24349c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 24351ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 24361ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 24371ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 24381ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 24391ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 24401ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 24419c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 24429c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 24439c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 24449c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 24451ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 24469c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 24479c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 24489c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 24499c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24509c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 24519c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 24529c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 24539c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 24549c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 24559c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 24569c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24579c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 24581ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 24591ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 246017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 246117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 246217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2463db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2464facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunctionGC.reset(new Leak("Leak of object when using " 2465facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 246617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2467db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2468db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2469e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2470facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak of object when not using " 2471facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in " 2472facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "dual GC/non-GC code")); 2473db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2474facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak")); 2475db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2476db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 247717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunction.get(); 2478db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2479db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2480db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 248117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakAtReturnBug(const LangOptions &LOpts, bool GCEnabled) const { 248217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2483db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturnGC) 2484facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturnGC.reset(new Leak("Leak of returned object when using " 2485facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 248617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2487db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2488db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2489e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2490facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object when not using " 2491facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in dual " 2492facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "GC/non-GC code")); 2493db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2494facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object")); 2495db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2496db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 249717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturn.get(); 2498db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2499db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2500db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 250117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(ASTContext &Ctx, 250217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 250317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // FIXME: We don't support ARC being turned on and off during one analysis. 250417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // (nor, for that matter, do we support changing ASTContexts) 25054e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie bool ARCEnabled = (bool)Ctx.getLangOpts().ObjCAutoRefCount; 250617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 250717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!SummariesGC) 2508b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose SummariesGC.reset(new RetainSummaryManager(Ctx, true, ARCEnabled)); 250917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 251017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(SummariesGC->isARCEnabled() == ARCEnabled); 2511b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *SummariesGC; 2512b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } else { 251317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!Summaries) 2514b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose Summaries.reset(new RetainSummaryManager(Ctx, false, ARCEnabled)); 251517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 251617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(Summaries->isARCEnabled() == ARCEnabled); 2517b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *Summaries; 2518b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2519b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2520b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 252117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(CheckerContext &C) const { 252217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return getSummaryManager(C.getASTContext(), C.isObjCGCEnabled()); 252317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 252417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 25258bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void printState(raw_ostream &Out, ProgramStateRef State, 2526dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const char *NL, const char *Sep) const; 2527dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 2528390909c89c98ab1807e15e033a72e975f866fb23Anna Zaks void checkBind(SVal loc, SVal val, const Stmt *S, CheckerContext &C) const; 2529ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const; 2530ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const CastExpr *CE, CheckerContext &C) const; 2531f85e193739c953358c865005855253af4f68a497John McCall 25321a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCArrayLiteral *AL, CheckerContext &C) const; 25331a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCDictionaryLiteral *DL, CheckerContext &C) const; 253470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose void checkPostStmt(const ObjCBoxedExpr *BE, CheckerContext &C) const; 253570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2536fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose void checkPostCall(const CallEvent &Call, CheckerContext &C) const; 25371a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25384531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose void checkSummary(const RetainSummary &Summ, const CallEvent &Call, 2539e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2540294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 254176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 254276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 25438bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond, 2544ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 25456704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25468bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 25478bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek checkRegionChanges(ProgramStateRef state, 2548537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 2549537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 255066c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 2551740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const; 2552ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 25538bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool wantsRegionChangeUpdate(ProgramStateRef state) const { 25542f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2555ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2556294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2557f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2558f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2559f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 25608bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek SymbolRef Sym, ProgramStateRef state) const; 2561f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 256238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 2563af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks void checkEndPath(CheckerContext &C) const; 256438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25658bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef updateSymbol(ProgramStateRef state, SymbolRef sym, 256617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 256717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CheckerContext &C) const; 2568e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 25698bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void processNonLeakError(ProgramStateRef St, SourceRange ErrorRange, 2570294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2571294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 25721a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25731a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void processObjCLiterals(CheckerContext &C, const Expr *Ex) const; 2574294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 257538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 257638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25778bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef handleSymbolDeath(ProgramStateRef state, 257838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef sid, RefVal V, 257938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const; 258038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25818bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ExplodedNode *, ProgramStateRef > 25828bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek handleAutoreleaseCounts(ProgramStateRef state, 25838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose GenericNodeBuilderRefCount Bd, ExplodedNode *Pred, 25846a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, SymbolRef Sym, RefVal V) const; 25858d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 25868bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *processLeaks(ProgramStateRef state, 258738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 258838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose GenericNodeBuilderRefCount &Builder, 25896a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 259038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2591d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2592d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2593d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 25946704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 25956704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 25968bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 25976704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 25988bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek StopTrackingCallback(ProgramStateRef st) : state(st) {} 25998bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return state; } 26006704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 26016704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 26026704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 26036704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 26046704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 26056704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 26066704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 26076704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2608910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2609910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2610910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 26116704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2612910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2613910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2614dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2615910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2616dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2617469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 261838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2619dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 26208bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 262138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 26225eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek cast<BlockDataRegion>(state->getSVal(BE, 26235eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsRegion()); 2624dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 262538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 262638cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2627dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 262838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 262938cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2630dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 263167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 263267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 263367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 26345f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 263539ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2636c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2637dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 263867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 263967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion *VR = *I; 264067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 264167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 264267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 264367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 264467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2645dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 264667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 264767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 264867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 26490bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 265038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 265138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2652910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2653910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2654f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2655f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2656f85e193739c953358c865005855253af4f68a497John McCall return; 2657f85e193739c953358c865005855253af4f68a497John McCall 265871c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2659f85e193739c953358c865005855253af4f68a497John McCall 2660f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2661f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2662f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2663f85e193739c953358c865005855253af4f68a497John McCall return; 2664f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2665f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2666f85e193739c953358c865005855253af4f68a497John McCall break; 2667f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2668f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2669f85e193739c953358c865005855253af4f68a497John McCall break; 2670f85e193739c953358c865005855253af4f68a497John McCall } 2671f85e193739c953358c865005855253af4f68a497John McCall 26728bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26735eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CE, C.getLocationContext()).getAsLocSymbol(); 2674f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2675f85e193739c953358c865005855253af4f68a497John McCall return; 2676f85e193739c953358c865005855253af4f68a497John McCall const RefVal* T = state->get<RefBindings>(Sym); 2677f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2678f85e193739c953358c865005855253af4f68a497John McCall return; 2679f85e193739c953358c865005855253af4f68a497John McCall 2680f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 268117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2682f85e193739c953358c865005855253af4f68a497John McCall 2683f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2684e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2685e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2686f85e193739c953358c865005855253af4f68a497John McCall return; 2687f85e193739c953358c865005855253af4f68a497John McCall } 2688f85e193739c953358c865005855253af4f68a497John McCall 26890bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 2690f85e193739c953358c865005855253af4f68a497John McCall} 2691f85e193739c953358c865005855253af4f68a497John McCall 26921a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::processObjCLiterals(CheckerContext &C, 26931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Expr *Ex) const { 26941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ProgramStateRef state = C.getState(); 26951a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const ExplodedNode *pred = C.getPredecessor(); 26961a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek for (Stmt::const_child_iterator it = Ex->child_begin(), et = Ex->child_end() ; 26971a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek it != et ; ++it) { 26981a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Stmt *child = *it; 26991a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal V = state->getSVal(child, pred->getLocationContext()); 27001a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = V.getAsSymbol()) 27011a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const RefVal* T = state->get<RefBindings>(sym)) { 27021a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek RefVal::Kind hasErr = (RefVal::Kind) 0; 27031a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = updateSymbol(state, sym, *T, MayEscape, hasErr, C); 27041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (hasErr) { 27051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processNonLeakError(state, child->getSourceRange(), hasErr, sym, C); 27061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek return; 27071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27081a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27091a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27111a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Return the object as autoreleased. 27121a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // RetEffect RE = RetEffect::MakeNotOwned(RetEffect::ObjC); 27131a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = 27141a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state->getSVal(Ex, pred->getLocationContext()).getAsSymbol()) { 27151a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek QualType ResultTy = Ex->getType(); 27161a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = state->set<RefBindings>(sym, RefVal::makeNotOwned(RetEffect::ObjC, 27171a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ResultTy)); 27181a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 27191a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27201a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek C.addTransition(state); 27211a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27221a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27231a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCArrayLiteral *AL, 27241a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27251a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all values. 27261a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, AL); 27271a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27281a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27291a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCDictionaryLiteral *DL, 27301a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27311a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all keys and values. 27321a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, DL); 27331a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27341a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 273570fdbc366da85880aae5baebd3351e993ca05603Jordy Rosevoid RetainCountChecker::checkPostStmt(const ObjCBoxedExpr *Ex, 273670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose CheckerContext &C) const { 273770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ExplodedNode *Pred = C.getPredecessor(); 273870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const LocationContext *LCtx = Pred->getLocationContext(); 273970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose ProgramStateRef State = Pred->getState(); 274070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 274170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (SymbolRef Sym = State->getSVal(Ex, LCtx).getAsSymbol()) { 274270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose QualType ResultTy = Ex->getType(); 274370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose State = State->set<RefBindings>(Sym, RefVal::makeNotOwned(RetEffect::ObjC, 274470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose ResultTy)); 274570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 274670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 274770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose C.addTransition(State); 274870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 274970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2750fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rosevoid RetainCountChecker::checkPostCall(const CallEvent &Call, 2751fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose CheckerContext &C) const { 2752fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose if (C.wasInlined) 2753fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose return; 2754b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 2755fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2756fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose const RetainSummary *Summ = Summaries.getSummary(Call, C.getState()); 2757fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose checkSummary(*Summ, Call, C); 2758294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2759294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2760910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2761910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2762bed28ac1d1463adca3ecf24fca5c30646fa9dbb2Sylvestre Ledru/// While the return type can be queried directly from RetEx, when 2763910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2764910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2765910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2766910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2767910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2768910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2769910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2770910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2771910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2772910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2773910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2774910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2775910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2776910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2777910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2778910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2779910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2780910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2781910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2782910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2783910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2784910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2785910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2786910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2787910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2788910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 27894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &CallOrMsg, 2790910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 27918bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2792294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2793294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2794294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2795294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2796294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2797294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2798294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2799537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2800294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2801294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 2802294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RefBindings::data_type *T = state->get<RefBindings>(Sym)) { 280317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2804294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2805294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2806294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2807294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2808294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2809294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2810294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2811294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2812294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2813294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2814294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 28154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!hasErr) { 2816cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCMethodCall *MsgInvocation = dyn_cast<ObjCMethodCall>(&CallOrMsg); 28174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (MsgInvocation) { 28184531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (SymbolRef Sym = MsgInvocation->getReceiverSVal().getAsLocSymbol()) { 28194531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const RefVal *T = state->get<RefBindings>(Sym)) { 28204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverIsTracked = true; 28214531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 28224531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose hasErr, C); 28234531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (hasErr) { 28248919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ErrorRange = MsgInvocation->getOriginExpr()->getReceiverRange(); 28254531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ErrorSym = Sym; 28264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 2827294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2828294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2829294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2830294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2831294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2832294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2833294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2834294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2835294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2836294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2837294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2838294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2839294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2840294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2841294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2842b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 284317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2844b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2845294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2846294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2847294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2848294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2849294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 28507530c034c0c71a64c5a9173206d9742ae847af8bDavid Blaikie llvm_unreachable("Unhandled RetEffect."); 2851294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2852294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2853294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2854294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2855294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2856294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2857294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 28585eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 28595eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsSymbol(); 2860294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2861294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2862294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 28634531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // Use the result type from the CallEvent as it automatically adjusts 2864294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 28654531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose QualType ResultTy = CallOrMsg.getResultType(); 2866294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeOwned(RE.getObjKind(), 2867294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2868294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2869294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2870294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // *not* fail. (The code below is out-of-date, though.) 2871294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#if 0 2872294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedAllocatedSymbol) { 2873294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool isFeasible; 2874294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state.assume(loc::SymbolVal(Sym), true, isFeasible); 2875294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose assert(isFeasible && "Cannot assume fresh symbol is non-null."); 2876294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2877294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose#endif 2878294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2879294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2880294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2881294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2882294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2883294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2884294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2885294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 28865eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(Ex, C.getLocationContext()).getAsSymbol(); 2887294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2888294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2889294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2890294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2891294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 2892294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, RefVal::makeNotOwned(RE.getObjKind(), 2893294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ResultTy)); 2894294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2895294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2896294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2897294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2898294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2899294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2900294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2901294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2902294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2903294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2904294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 29050bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks NewNode = C.addTransition(state); 2906294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2907294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 29089c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 29099c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 29109c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 29119c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 29129c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 29139c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 29149c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2915ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 29169c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2917294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2918294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2919e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 29208bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 29218bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::updateSymbol(ProgramStateRef state, SymbolRef sym, 2922910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2923910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2924e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2925910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 292617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 292717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 29284e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie IgnoreRetainMsg = (bool)C.getASTContext().getLangOpts().ObjCAutoRefCount; 292917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2930e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 29314531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose default: 29324531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29334531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRefMsg: 29344531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? DoNothing : IncRef; 29354531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsg: 29374531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? DoNothing : DecRef; 29384531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29394531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsgAndStopTracking: 29404531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? StopTracking : DecRefAndStopTracking; 29414531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MakeCollectable: 29434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = C.isObjCGCEnabled() ? DecRef : DoNothing; 29444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29454531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case NewAutoreleasePool: 29464531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = C.isObjCGCEnabled() ? DoNothing : NewAutoreleasePool; 29474531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 2948e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2949e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2950e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 295117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2952e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2953e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2954e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2955e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2956e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2957e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2958e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2959e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2960e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 29614531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsgAndStopTracking: 2962e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2963e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2964e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2965e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 296617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2967e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2968e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2969e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2970e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2971e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2972e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2973e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2974e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2975e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2976e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2977e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2978e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 2979e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 2980e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2981e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2982e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2983e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2984e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2985e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2986e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2987e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case NewAutoreleasePool: 298817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!C.isObjCGCEnabled()); 2989e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->add<AutoreleaseStack>(sym); 2990e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2991e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 2992e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 2993e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2994e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2995e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2996e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2997e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2998e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2999e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 3000e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 3001e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3002e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 300317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 3004e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 3005e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3006e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 3007e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose state = SendAutorelease(state, ARCountFactory, sym); 3008e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 3009e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3010e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3011e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 3012e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->remove<RefBindings>(sym); 3013e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3014e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 3015e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3016e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3017e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 3018e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3019e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 3020e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 3021e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3022e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3023e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 302417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3025e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 3026e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3027e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3028e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3029e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3030e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 3031e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 30324531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefAndStopTracking: 3033e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3034e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3035e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 3036e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 3037e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3038e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3039e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 3040e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 3041e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 3042e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 30434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose else if (E == DecRefAndStopTracking) 30444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return state->remove<RefBindings>(sym); 30454531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 3046e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3047e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3048e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3049e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 30504531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (V.getCount() > 0) { 30514531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (E == DecRefAndStopTracking) 30524531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return state->remove<RefBindings>(sym); 3053e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 30544531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } else { 3055e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 3056e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3057e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3058e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3059e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3060e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3061e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 306217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3063e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 3064e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3065e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3066e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3067e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3068e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3069e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state->set<RefBindings>(sym, V); 3070e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 3071e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 30728bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::processNonLeakError(ProgramStateRef St, 3073910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 3074910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 3075910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 3076910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3077294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 3078294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 3079294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 3080294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3081294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 3082294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 3083294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 3084294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 3085294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 3086d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 3087d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 3088d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 3089294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3090294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 3091d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 3092d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 3093d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 3094294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3095294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 3096d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 3097d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 3098d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 3099294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3100294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 3101d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 3102d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 3103d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 3104294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3105294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3106294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3107d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 31084e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOpts(), 310917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 311017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 3111294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 3112294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.EmitReport(report); 3113294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 3114294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3115910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3116910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 3117910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3118910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3119910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 312076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 31218bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3122b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *FD = C.getCalleeDecl(CE); 312376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 312476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 312576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 312676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 312776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 312876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 312976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 313076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 313176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 313276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 313376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 313476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 313576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 313676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 313776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 313876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 313976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 314076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 314176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 314276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 314376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3144b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks QualType ResultTy = CE->getCallReturnType(); 314576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 314676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 314776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 314876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 314976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 315076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 315176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 315276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 315376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 315476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 315576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 315676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 315776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 315876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 315976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 316076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 316176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 31625eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = C.getLocationContext(); 31635eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal RetVal = state->getSVal(CE->getArg(0), LCtx); 316476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 316576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 316676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 31675d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 31687373ead8719ceedd21c108419159ea74b02b2461Benjamin Kramer RetVal = SVB.getConjuredSymbolVal(0, CE, LCtx, ResultTy, Count); 316976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 31705eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal, false); 317176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3172294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3173294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3174294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3175294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3176294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 3177294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefBindings::data_type *Binding = 0; 3178294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 3179294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose Binding = state->get<RefBindings>(Sym); 318076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3181294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 31825d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks unsigned Count = C.getCurrentBlockCount(); 31833133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek state = state->invalidateRegions(ArgRegion, CE, Count, LCtx); 318476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3185294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3186294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 3187294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose state = state->set<RefBindings>(Sym, *Binding); 3188294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3189294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 31900bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 319176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 319276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 319376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3194910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3195910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3196910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3197f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3198e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek// Return true if the current LocationContext has no caller context. 3199e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenekstatic bool inTopFrame(CheckerContext &C) { 3200e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek const LocationContext *LC = C.getLocationContext(); 3201e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return LC->getParent() == 0; 3202e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek} 3203e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3204910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3205910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3206e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3207e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // Only adjust the reference count if this is the top-level call frame, 3208e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // and not the result of inlining. In the future, we should do 3209e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // better checking even for inlined calls, and see if they match 3210e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // with their expected semantics (e.g., the method should return a retained 3211e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // object, etc.). 3212e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek if (!inTopFrame(C)) 3213e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return; 3214e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3215f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3216f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3217f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3218f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32198bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 32205eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = 32215eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state->getSValAsScalarOrLoc(RetE, C.getLocationContext()).getAsLocSymbol(); 3222f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3223f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3224f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3225f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 3226f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const RefVal *T = state->get<RefBindings>(Sym); 3227f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3228f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3229f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3230f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3231f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3232f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3233f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3234f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3235f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3236f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3237f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3238f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3239f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3240f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3241f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3242f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3243f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3244f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3245f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3246f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3247f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3248f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3249f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3250f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3251f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3252f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3253f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3254f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3255f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3256f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3257f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3258f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 3259f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 32600bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *Pred = C.addTransition(state); 3261f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3262f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3263f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3264f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3265f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3266f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3267f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3268f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3269f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3270f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3271f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3272910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 32734eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, &AutoreleaseTag); 32746a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, Sym, X); 3275f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3276f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 32778d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!Pred) 3278f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3279f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3280f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 3281f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose T = state->get<RefBindings>(Sym); 3282f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3283f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3284f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3285f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 328617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3287f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 32884531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetEffect RE = RetEffect::MakeNoRet(); 3289f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: What is the convention for blocks? Is there one? 3291f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3292b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 32934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = Summ->getRetEffect(); 32944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 32954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!isa<CXXMethodDecl>(FD)) { 32964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ = Summaries.getFunctionSummary(FD); 32974531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = Summ->getRetEffect(); 32984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 3299f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3300f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33014531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3302f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3303f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3304910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3305910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3306910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3307910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3308910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 33098bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state) const { 3310f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3311f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3312f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3313f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 331417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3315f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3316f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3317f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3318f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3319f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3320f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3321f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3322f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3323f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3324f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3325f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3326f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3327f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3328f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3329f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3330f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3331f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 3332f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X); 3333f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3334f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3335910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 33360bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnOwnLeakTag); 3337f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 33384e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = C.getASTContext().getLangOpts(); 333917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3340f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 334117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 334217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 33436a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks N, Sym, C); 3344f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3345f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3346f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3347f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3348f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3349f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3350f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3351f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 3352f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose state = state->set<RefBindings>(Sym, X ^ RefVal::ErrorReturnedNotOwned); 3353f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3354f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3355910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 33560bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnNotOwnedTag); 3357f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3358d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3359d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3360d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3361f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3362d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 33634e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie C.getASTContext().getLangOpts(), 336417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3365f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3366f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3367f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3368f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3369f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3370f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33718d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3372910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3373910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3374910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3375390909c89c98ab1807e15e033a72e975f866fb23Anna Zaksvoid RetainCountChecker::checkBind(SVal loc, SVal val, const Stmt *S, 3376910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3377910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3378910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3379910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3380910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3381910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3382910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3383910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3384910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3385910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 33868bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3387910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3388910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (loc::MemRegionVal *regionLoc = dyn_cast<loc::MemRegionVal>(&loc)) { 3389910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3390910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3391910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3392910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3393910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3394910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3395e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // Do this only if we know that the store is not supposed to generate the 3396e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // same state. 3397e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks SVal StoredVal = state->getSVal(regionLoc->getRegion()); 3398e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks if (StoredVal != val) 3399e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks escapes = (state == (state->bindLoc(*regionLoc, val))); 3400910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3401de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek if (!escapes) { 3402de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // Case 4: We do not currently model what happens when a symbol is 3403de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // assigned to a struct field, so be conservative here and let the symbol 3404de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // go. TODO: This could definitely be improved upon. 3405de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek escapes = !isa<VarRegion>(regionLoc->getRegion()); 3406de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek } 3407910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3408910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3409910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3410910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3411910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3412910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3413910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3414910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3415910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3416910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3417910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 34180bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 3419910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3420910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34218bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef RetainCountChecker::evalAssume(ProgramStateRef state, 3422910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3423910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3424910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3425910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3426910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3427910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3428910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3429910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3430910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3431910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings B = state->get<RefBindings>(); 3432910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3433910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3434910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3435910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3436910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3437910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings::Factory &RefBFactory = state->get_context<RefBindings>(); 3438910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3439910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3440910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Check if the symbol is null (or equal to any constant). 3441910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If this is the case, stop tracking the symbol. 3442910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (state->getSymVal(I.getKey())) { 3443910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3444910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3445910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3446910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3447910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3448910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3449910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3450910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3451910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3452910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3453910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34548bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 34558bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::checkRegionChanges(ProgramStateRef state, 3456910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 3457910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 345866c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 3459740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const { 3460910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3461910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3462910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3463910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3464910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3465910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3466910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3467910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3468910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3469910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3470910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (StoreManager::InvalidatedSymbols::const_iterator I=invalidated->begin(), 3471910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3472910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3473910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3474910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3475910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 3476910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->remove<RefBindings>(sym); 3477910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3478910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3479910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3480910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3481910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 34828d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 34838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 34848d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34858bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstd::pair<ExplodedNode *, ProgramStateRef > 34868bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleAutoreleaseCounts(ProgramStateRef state, 3487910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount Bd, 34886a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred, 34896a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 3490910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 34918d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 34928d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34938d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 34948d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 34958d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(Pred, state); 34968d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34976a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks assert(!Ctx.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 34988d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 34998d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35008d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 35018d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35028d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 35038d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 35048d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35058d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 35068d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 35078d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 35088d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 35098d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 35108d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 35118d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 35128d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 35138d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setCount(Cnt - ACnt); 35148d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 35158d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35168d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 35178d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ExplodedNode *N = Bd.MakeNode(state, Pred); 35188d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (N == 0) 35198d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = 0; 35208d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(N, state); 35218d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35228d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35238d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 35248d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 35258d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 35268d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = state->set<RefBindings>(Sym, V); 35278d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3528f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks if (ExplodedNode *N = Bd.MakeNode(state, Pred, true)) { 3529f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<128> sbuf; 35308d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 35318d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 35328d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 35338d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 35348d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 35358d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3536d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3537d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3538d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 35394e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35408d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3541d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3542d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 35436a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 35448d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35458d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35468bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek return std::make_pair((ExplodedNode *)0, (ProgramStateRef )0); 35478d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 354838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35498bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 35508bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleSymbolDeath(ProgramStateRef state, 3551910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 355238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 35535337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 355438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 355538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 355638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 355738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 355838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 355938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 356038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->remove<RefBindings>(sid); 356138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 356338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return state->set<RefBindings>(sid, V ^ RefVal::ErrorLeak); 356438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 356538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 35678bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::processLeaks(ProgramStateRef state, 3568910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 3569910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose GenericNodeBuilderRefCount &Builder, 35706a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 35716a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred) const { 357238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (Leaked.empty()) 357338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return Pred; 357438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 357638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *N = Builder.MakeNode(state, Pred); 357738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 357938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 358038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 358138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35824e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35836a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks bool GCEnabled = Ctx.isObjCGCEnabled(); 358417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 358517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 358638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 35872058956954802229bf98604e8063fa57677abff4Jordy Rose 358817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 35896a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks SummaryLog, N, *I, Ctx); 35906a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 359138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 359238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 359338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 359438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 359538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 359638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3597af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaksvoid RetainCountChecker::checkEndPath(CheckerContext &Ctx) const { 35988bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Ctx.getState(); 3599af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks GenericNodeBuilderRefCount Bd(Ctx); 360038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 3601af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred = Ctx.getPredecessor(); 360238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 360338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 36046a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, Ctx, 36058d22863184419faa2348bd5148c663197bc4bb00Jordy Rose I->first, I->second); 36068d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 360738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 360838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 360938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36100cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // If the current LocationContext has a parent, don't check for leaks. 36110cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // We will do that later. 36120cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // FIXME: we should instead check for imblances of the retain/releases, 36130cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // and suggest annotations. 36140cf3d471546251b12bdceff360f66c079c40526cTed Kremenek if (Ctx.getLocationContext()->getParent()) 36150cf3d471546251b12bdceff360f66c079c40526cTed Kremenek return; 36160cf3d471546251b12bdceff360f66c079c40526cTed Kremenek 361738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 361838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 361938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 362038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) 36218d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 362238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36236a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks processLeaks(state, Leaked, Bd, Ctx, Pred); 362438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 362538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 362638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3627910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 362838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 362938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 3630f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<64> buf; 363138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3632f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks out << "RetainCountChecker : Dead Symbol : "; 3633f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks sym->dumpToStream(out); 363438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 363538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 363638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 363738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 363838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3639910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3640910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 364138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 364238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36438bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 364438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 364538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 364638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 364738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 364838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 364938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 365038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 365138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 365238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 36534eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, getDeadSymbolTag(Sym)); 36546a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Bd, Pred, C, 36558d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Sym, *T); 36568d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 365738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 365838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 365938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 366038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 366138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 366238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 366338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 366438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 366538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 366638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(*I)) 366738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = handleSymbolDeath(state, *I, *T, Leaked); 366838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 366938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose { 36714eff823b8e015e003d05953c386d685ee6bb6235Anna Zaks GenericNodeBuilderRefCount Bd(C, this); 36726a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Pred = processLeaks(state, Leaked, Bd, C, Pred); 367338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 367438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 367638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 367738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 367838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 368038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings::Factory &F = state->get_context<RefBindings>(); 368138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 368238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 368338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) 368438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 368538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 368638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 36870bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state, Pred); 368838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 368938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3690d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek//===----------------------------------------------------------------------===// 3691dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose// Debug printing of refcount bindings and autorelease pools. 3692dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3693dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3694dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rosestatic void PrintPool(raw_ostream &Out, SymbolRef Sym, 36958bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State) { 3696dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ' '; 3697dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (Sym) 3698f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks Sym->dumpToStream(Out); 3699dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose else 3700dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "<pool>"; 3701dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << ":{"; 3702dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3703dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Get the contents of the pool. 3704dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (const ARCounts *Cnts = State->get<AutoreleasePoolContents>(Sym)) 3705dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARCounts::iterator I = Cnts->begin(), E = Cnts->end(); I != E; ++I) 3706dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '(' << I.getKey() << ',' << I.getData() << ')'; 3707dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3708dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << '}'; 3709dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3710dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 37118bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstatic bool UsesAutorelease(ProgramStateRef state) { 3712dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // A state uses autorelease if it allocated an autorelease pool or if it has 3713dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // objects in the caller's autorelease pool. 3714dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose return !state->get<AutoreleaseStack>().isEmpty() || 3715dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose state->get<AutoreleasePoolContents>(SymbolRef()); 3716dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3717dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 37188bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::printState(raw_ostream &Out, ProgramStateRef State, 3719910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3720dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3721dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose RefBindings B = State->get<RefBindings>(); 3722dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3723dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3724dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3725dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3726dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3727dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3728dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3729dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3730dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3731dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3732dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose // Print the autorelease stack. 3733dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (UsesAutorelease(State)) { 3734dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL << "AR pool stack:"; 3735dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose ARStack Stack = State->get<AutoreleaseStack>(); 3736dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3737dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, SymbolRef(), State); // Print the caller's pool. 3738dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (ARStack::iterator I = Stack.begin(), E = Stack.end(); I != E; ++I) 3739dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose PrintPool(Out, *I, State); 3740dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3741dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3742dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3743dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3744dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3745dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3746910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 37476b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 37486b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 374917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3750910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 375117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 375217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3753