RetainCountChecker.cpp revision 554067f290282f366ccf65a27e0b914aa67a52c6
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 4305cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek//===----------------------------------------------------------------------===// 44553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Primitives used for constructing summaries for function/method calls. 4505cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek//===----------------------------------------------------------------------===// 4605cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek 47553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// ArgEffect is used to summarize a function/method call's effect on a 48553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// particular argument. 49bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Roseenum ArgEffect { DoNothing, Autorelease, Dealloc, DecRef, DecRefMsg, 50f85e193739c953358c865005855253af4f68a497John McCall DecRefBridgedTransfered, 51bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Rose IncRefMsg, IncRef, MakeCollectable, MayEscape, 52554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks NewAutoreleasePool, 53554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 54554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Stop tracking the argument - the effect of the call is 55554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // unknown. 56554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks StopTracking, 57554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 58554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // In some cases, we obtain a better summary for this checker 59554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // by looking at the call site than by inlining the function. 60554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Signifies that we should stop tracking the symbol even if 61554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // the function is inlined. 62554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks StopTrackingHard, 63554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 64554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // The function decrements the reference count and the checker 65554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // should stop tracking the argument. 66554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks DecRefAndStopTrackingHard, DecRefMsgAndStopTrackingHard 67554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks }; 68553cf18cd44769a7624fc942493f076498527529Ted Kremenek 696b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremeneknamespace llvm { 70b77449cead63264650958c92cb30609c942cc5e9Ted Kremenektemplate <> struct FoldingSetTrait<ArgEffect> { 71b77449cead63264650958c92cb30609c942cc5e9Ted Kremenekstatic inline void Profile(const ArgEffect X, FoldingSetNodeID& ID) { 72b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ID.AddInteger((unsigned) X); 73b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek} 74553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 756b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end llvm namespace 766b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 77b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek/// ArgEffects summarizes the effects of a function/method call on all of 78b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek/// its arguments. 79b77449cead63264650958c92cb30609c942cc5e9Ted Kremenektypedef llvm::ImmutableMap<unsigned,ArgEffect> ArgEffects; 80b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek 816b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremeneknamespace { 82553cf18cd44769a7624fc942493f076498527529Ted Kremenek 83553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// RetEffect is used to summarize a function/method call's behavior with 841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// respect to its return value. 85ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetEffect { 866b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 8776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose enum Kind { NoRet, OwnedSymbol, OwnedAllocatedSymbol, 88f85e193739c953358c865005855253af4f68a497John McCall NotOwnedSymbol, GCNotOwnedSymbol, ARCNotOwnedSymbol, 89554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks OwnedWhenTrackedReceiver, 90554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Treat this function as returning a non-tracked symbol even if 91554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // the function has been inlined. This is used where the call 92554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // site summary is more presise than the summary indirectly produced 93554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // by inlining the function 94554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks NoRetHard 95554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks }; 961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum ObjKind { CF, ObjC, AnyObj }; 982d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 996b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekprivate: 1002d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek Kind K; 1012d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek ObjKind O; 1022d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 10376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose RetEffect(Kind k, ObjKind o = AnyObj) : K(k), O(o) {} 1041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1056b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 1062d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek Kind getKind() const { return K; } 1072d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek 1082d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek ObjKind getObjKind() const { return O; } 1091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 110a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek bool isOwned() const { 11178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek return K == OwnedSymbol || K == OwnedAllocatedSymbol || 11278a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek K == OwnedWhenTrackedReceiver; 113a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek } 1141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1154df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetEffect &Other) const { 1164df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return K == Other.K && O == Other.O; 1174df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 1184df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 11978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek static RetEffect MakeOwnedWhenTrackedReceiver() { 12078a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek return RetEffect(OwnedWhenTrackedReceiver, ObjC); 12178a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek } 1221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1232d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek static RetEffect MakeOwned(ObjKind o, bool isAllocated = false) { 1242d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return RetEffect(isAllocated ? OwnedAllocatedSymbol : OwnedSymbol, o); 1251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1262d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek static RetEffect MakeNotOwned(ObjKind o) { 1272d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return RetEffect(NotOwnedSymbol, o); 128e798e7c5a107ff5262005431817409a855a67922Ted Kremenek } 129e798e7c5a107ff5262005431817409a855a67922Ted Kremenek static RetEffect MakeGCNotOwned() { 130e798e7c5a107ff5262005431817409a855a67922Ted Kremenek return RetEffect(GCNotOwnedSymbol, ObjC); 131e798e7c5a107ff5262005431817409a855a67922Ted Kremenek } 132f85e193739c953358c865005855253af4f68a497John McCall static RetEffect MakeARCNotOwned() { 133f85e193739c953358c865005855253af4f68a497John McCall return RetEffect(ARCNotOwnedSymbol, ObjC); 134f85e193739c953358c865005855253af4f68a497John McCall } 135553cf18cd44769a7624fc942493f076498527529Ted Kremenek static RetEffect MakeNoRet() { 136553cf18cd44769a7624fc942493f076498527529Ted Kremenek return RetEffect(NoRet); 137a73447013c919d43f40c05451f5e4b662c043d6dTed Kremenek } 138554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks static RetEffect MakeNoRetHard() { 139554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return RetEffect(NoRetHard); 140554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 141ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 142ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void Profile(llvm::FoldingSetNodeID& ID) const { 143ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.AddInteger((unsigned) K); 144ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.AddInteger((unsigned) O); 145ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 1466b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 1471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 148b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 149b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// Reference-counting logic (typestate + counts). 150b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 1511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 152ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RefVal { 153b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 154b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek enum Kind { 155b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Owned = 0, // Owning reference. 156b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek NotOwned, // Reference is not owned by still valid (not freed). 157b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Released, // Object has been released. 158b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedOwned, // Returned object passes ownership to caller. 159b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ReturnedNotOwned, // Return object does not pass ownership to caller. 160b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_START, 161b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocNotOwned, // -dealloc called on non-owned object. 162b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorDeallocGC, // Calling -dealloc with GC enabled. 163b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorUseAfterRelease, // Object used after released. 164b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReleaseNotOwned, // Release of an object that was not owned. 165b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ERROR_LEAK_START, 166b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeak, // A memory leak due to excessive reference counts. 167b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorLeakReturned, // A memory leak due to the returning method not having 168b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // the correct naming conventions. 169b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorGCLeakReturned, 170b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorOverAutorelease, 171b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ErrorReturnedNotOwned 172b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek }; 173dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 174b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekprivate: 175b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind kind; 176b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind okind; 177b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Cnt; 178b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned ACnt; 179b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType T; 180dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 181b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal(Kind k, RetEffect::ObjKind o, unsigned cnt, unsigned acnt, QualType t) 182b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek : kind(k), okind(o), Cnt(cnt), ACnt(acnt), T(t) {} 183dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 184b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenekpublic: 185b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Kind getKind() const { return kind; } 186dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 187b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RetEffect::ObjKind getObjKind() const { return okind; } 188dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 189b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCount() const { return Cnt; } 190b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getAutoreleaseCount() const { return ACnt; } 191b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned getCombinedCounts() const { return Cnt + ACnt; } 192b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void clearCounts() { Cnt = 0; ACnt = 0; } 193b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setCount(unsigned i) { Cnt = i; } 194b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void setAutoreleaseCount(unsigned i) { ACnt = i; } 195dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 196b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek QualType getType() const { return T; } 197dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 198b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isOwned() const { 199b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == Owned; 200b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 201dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 202b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isNotOwned() const { 203b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == NotOwned; 204b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 205dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 206b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedOwned() const { 207b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedOwned; 208b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 209dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 210b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool isReturnedNotOwned() const { 211b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return getKind() == ReturnedNotOwned; 212b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 213dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 214b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeOwned(RetEffect::ObjKind o, QualType t, 215b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 1) { 216b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(Owned, o, Count, 0, t); 217b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 218dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 219b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek static RefVal makeNotOwned(RetEffect::ObjKind o, QualType t, 220b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned Count = 0) { 221b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(NotOwned, o, Count, 0, t); 222b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 223dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 224b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // Comparison, profiling, and pretty-printing. 225dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 226b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek bool operator==(const RefVal& X) const { 227b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return kind == X.kind && Cnt == X.Cnt && T == X.T && ACnt == X.ACnt; 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+(size_t i) const { 236b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount() + i, 237b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getAutoreleaseCount(), getType()); 238b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 239dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 240b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal operator^(Kind k) const { 241b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(k, getObjKind(), getCount(), getAutoreleaseCount(), 242b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 243b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 244dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 245b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek RefVal autorelease() const { 246b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek return RefVal(getKind(), getObjKind(), getCount(), getAutoreleaseCount()+1, 247b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek getType()); 248b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 249dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 250b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 251b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger((unsigned) kind); 252b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(Cnt); 253b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.AddInteger(ACnt); 254b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek ID.Add(T); 255b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 256dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2579c378f705405d37f49795d5e915989de774fe11fTed Kremenek void print(raw_ostream &Out) const; 258b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek}; 259b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 2609c378f705405d37f49795d5e915989de774fe11fTed Kremenekvoid RefVal::print(raw_ostream &Out) const { 261b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (!T.isNull()) 262dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << "Tracked " << T.getAsString() << '/'; 263dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 264b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek switch (getKind()) { 265910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose default: llvm_unreachable("Invalid RefVal kind"); 266b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Owned: { 267b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Owned"; 268b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 269b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 270b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 271b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 272dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 273b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case NotOwned: { 274b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "NotOwned"; 275b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 276b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 277b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 278b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 279dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 280b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedOwned: { 281b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedOwned"; 282b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 283b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 284b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 285b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 286dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 287b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ReturnedNotOwned: { 288b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "ReturnedNotOwned"; 289b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek unsigned cnt = getCount(); 290b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (cnt) Out << " (+ " << cnt << ")"; 291b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 292b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 293dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 294b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case Released: 295b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Released"; 296b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 297dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 298b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocGC: 299b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (GC)"; 300b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 301dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 302b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorDeallocNotOwned: 303b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "-dealloc (not-owned)"; 304b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 305dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 306b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeak: 307b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked"; 308b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 309dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 310b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorLeakReturned: 311b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (Bad naming)"; 312b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 313dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 314b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorGCLeakReturned: 315b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Leaked (GC-ed at return)"; 316b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 317dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 318b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorUseAfterRelease: 319b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Use-After-Release [ERROR]"; 320b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 321dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 322b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case ErrorReleaseNotOwned: 323b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Release of Not-Owned [ERROR]"; 324b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 325dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 326b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorOverAutorelease: 327b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Over autoreleased"; 328b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 329dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 330b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek case RefVal::ErrorReturnedNotOwned: 331b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << "Non-owned object returned instead of owned"; 332b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek break; 333b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 334dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 335b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek if (ACnt) { 336b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek Out << " [ARC +" << ACnt << ']'; 337b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek } 338b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 339b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} //end anonymous namespace 340b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 341b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 342b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek// RefBindings - State used to track object reference counts. 343b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 344b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 345b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenektypedef llvm::ImmutableMap<SymbolRef, RefVal> RefBindings; 346b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 347b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace clang { 3489ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 34918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenektemplate<> 35018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenekstruct ProgramStateTrait<RefBindings> 35118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek : public ProgramStatePartialTrait<RefBindings> { 35218c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static void *GDMIndex() { 35318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek static int RefBIndex = 0; 35418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek return &RefBIndex; 35518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek } 35618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek}; 357b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 3585a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} 359b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 3608d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaksstatic inline const RefVal *getRefBinding(ProgramStateRef State, 3618d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SymbolRef Sym) { 3628d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return State->get<RefBindings>(Sym); 3638d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks} 3648d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks 3658d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaksstatic inline ProgramStateRef setRefBinding(ProgramStateRef State, 3668d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SymbolRef Sym, RefVal Val) { 3678d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return State->set<RefBindings>(Sym, Val); 3688d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks} 3698d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks 3708d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaksstatic ProgramStateRef removeRefBinding(ProgramStateRef State, SymbolRef Sym) { 3718d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return State->remove<RefBindings>(Sym); 3728d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks} 3738d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks 374b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 375910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Function/Method behavior summaries. 376b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 377b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 378b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace { 379ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummary { 380ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// Args - a map of (index, ArgEffect) pairs, where index 3811bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// specifies the argument (starting from 0). This can be sparsely 3821bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// populated; arguments with no entry in Args use 'DefaultArgEffect'. 383b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects Args; 3841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3851bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// DefaultArgEffect - The default ArgEffect to apply to arguments that 3861bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// do not have an entry in Args. 3870507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect DefaultArgEffect; 3881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 389553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Receiver - If this summary applies to an Objective-C message expression, 390553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// this is the effect applied to the state of the receiver. 3910507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect Receiver; 3921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 393553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ret - The effect on the return value. Used to indicate if the 39476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose /// function/method call returns a new tracked symbol. 3950507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek RetEffect Ret; 3961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3976b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 398b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetainSummary(ArgEffects A, RetEffect R, ArgEffect defaultEff, 399e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect ReceiverEff) 400e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose : Args(A), DefaultArgEffect(defaultEff), Receiver(ReceiverEff), Ret(R) {} 4011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 402553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArg - Return the argument effect on the argument specified by 403553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// idx (starting from 0). 4041ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek ArgEffect getArg(unsigned idx) const { 405b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek if (const ArgEffect *AE = Args.lookup(idx)) 406b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return *AE; 4071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4081bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek return DefaultArgEffect; 4091ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 41011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 41111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek void addArg(ArgEffects::Factory &af, unsigned idx, ArgEffect e) { 41211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek Args = af.add(Args, idx, e); 41311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 4141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 415885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setDefaultArgEffect - Set the default argument effect. 416885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setDefaultArgEffect(ArgEffect E) { 417885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek DefaultArgEffect = E; 418885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek } 4191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 420553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getRetEffect - Returns the effect on the return value of the call. 421b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetEffect getRetEffect() const { return Ret; } 4221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 423885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setRetEffect - Set the effect of the return value of the call. 424885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setRetEffect(RetEffect E) { Ret = E; } 4251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 42612b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 42712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek /// Sets the effect on the receiver of the message. 42812b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek void setReceiverEffect(ArgEffect e) { Receiver = e; } 42912b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 430553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getReceiverEffect - Returns the effect on the receiver of the call. 431553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// This is only meaningful if the summary applies to an ObjCMessageExpr*. 432b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffect getReceiverEffect() const { return Receiver; } 4334df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 4344df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// Test if two retain summaries are identical. Note that merely equivalent 4354df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// summaries are not necessarily identical (for example, if an explicit 4364df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// argument effect matches the default effect). 4374df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetainSummary &Other) const { 4384df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return Args == Other.Args && DefaultArgEffect == Other.DefaultArgEffect && 4394df54feb02d72b76249e846053d5d53d820bf832Jordy Rose Receiver == Other.Receiver && Ret == Other.Ret; 4404df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 441ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 442ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// Profile this summary for inclusion in a FoldingSet. 443ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void Profile(llvm::FoldingSetNodeID& ID) const { 444ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Args); 445ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(DefaultArgEffect); 446ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Receiver); 447ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Ret); 448ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 449ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 450ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// A retain summary is simple if it has no ArgEffects other than the default. 451ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose bool isSimple() const { 452ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return Args.isEmpty(); 453ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 4544531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 4554531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Roseprivate: 4564531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffects getArgEffects() const { return Args; } 4574531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffect getDefaultArgEffect() const { return DefaultArgEffect; } 4584531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 4594531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose friend class RetainSummaryManager; 4606b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 4614f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} // end anonymous namespace 4626b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 463553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 464553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for constructing summaries. 465553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 466553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4674f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 468ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryKey { 469553cf18cd44769a7624fc942493f076498527529Ted Kremenek IdentifierInfo* II; 470553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector S; 4711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 472553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(IdentifierInfo* ii, Selector s) 473553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(ii), S(s) {} 474553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4759c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, Selector s) 476553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(d ? d->getIdentifier() : 0), S(s) {} 47770b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek 478553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(Selector s) 479553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(0), S(s) {} 4801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4810507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek IdentifierInfo *getIdentifier() const { return II; } 482553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector getSelector() const { return S; } 483553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 4844f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} 4854f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek 4864f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace llvm { 487553cf18cd44769a7624fc942493f076498527529Ted Kremenektemplate <> struct DenseMapInfo<ObjCSummaryKey> { 488553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getEmptyKey() { 489553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getEmptyKey(), 490553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::getEmptyKey()); 491553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 493553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getTombstoneKey() { 494553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getTombstoneKey(), 4951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump DenseMapInfo<Selector>::getTombstoneKey()); 496553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 498553cf18cd44769a7624fc942493f076498527529Ted Kremenek static unsigned getHashValue(const ObjCSummaryKey &V) { 49928b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer typedef std::pair<IdentifierInfo*, Selector> PairTy; 50028b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer return DenseMapInfo<PairTy>::getHashValue(PairTy(V.getIdentifier(), 50128b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer V.getSelector())); 502553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 504553cf18cd44769a7624fc942493f076498527529Ted Kremenek static bool isEqual(const ObjCSummaryKey& LHS, const ObjCSummaryKey& RHS) { 50528b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer return LHS.getIdentifier() == RHS.getIdentifier() && 50628b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer LHS.getSelector() == RHS.getSelector(); 507553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 509553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 51006159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <> 51106159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<ObjCSummaryKey> { static const bool value = true; }; 512553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end llvm namespace 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 514553cf18cd44769a7624fc942493f076498527529Ted Kremeneknamespace { 515ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryCache { 51693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<ObjCSummaryKey, const RetainSummary *> MapTy; 517553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy M; 518553cf18cd44769a7624fc942493f076498527529Ted Kremenekpublic: 519553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryCache() {} 5201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 52193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, Selector S) { 522553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Do a lookup with the (D,S) pair. If we find a match return 523553cf18cd44769a7624fc942493f076498527529Ted Kremenek // the iterator. 524553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey K(D, S); 525553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy::iterator I = M.find(K); 5261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (I != M.end()) 528614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I->second; 5294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!D) 5304531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return NULL; 5311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 532553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Walk the super chain. If we find a hit with a parent, we'll end 533553cf18cd44769a7624fc942493f076498527529Ted Kremenek // up returning that summary. We actually allow that key (null,S), as 534553cf18cd44769a7624fc942493f076498527529Ted Kremenek // we cache summaries for the null ObjCInterfaceDecl* to allow us to 535553cf18cd44769a7624fc942493f076498527529Ted Kremenek // generate initial summaries without having to worry about NSObject 536553cf18cd44769a7624fc942493f076498527529Ted Kremenek // being declared. 537553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: We may change this at some point. 5389c378f705405d37f49795d5e915989de774fe11fTed Kremenek for (ObjCInterfaceDecl *C=D->getSuperClass() ;; C=C->getSuperClass()) { 539553cf18cd44769a7624fc942493f076498527529Ted Kremenek if ((I = M.find(ObjCSummaryKey(C, S))) != M.end()) 540553cf18cd44769a7624fc942493f076498527529Ted Kremenek break; 5411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 542553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (!C) 543614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return NULL; 5444f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek } 5451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Cache the summary with original key to make the next lookup faster 547553cf18cd44769a7624fc942493f076498527529Ted Kremenek // and return the iterator. 54893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = I->second; 549614cc540a617978814e37d75bf5066926b921a0aTed Kremenek M[K] = Summ; 550614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return Summ; 551553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5530507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *find(IdentifierInfo* II, Selector S) { 554553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: Class method lookup. Right now we dont' have a good way 555553cf18cd44769a7624fc942493f076498527529Ted Kremenek // of going between IdentifierInfo* and the class hierarchy. 556614cc540a617978814e37d75bf5066926b921a0aTed Kremenek MapTy::iterator I = M.find(ObjCSummaryKey(II, S)); 5571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 558614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (I == M.end()) 559614cc540a617978814e37d75bf5066926b921a0aTed Kremenek I = M.find(ObjCSummaryKey(S)); 5601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 561614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I == M.end() ? NULL : I->second; 562553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](ObjCSummaryKey K) { 565553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[K]; 566553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](Selector S) { 569553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[ ObjCSummaryKey(S) ]; 570553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 572553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end anonymous namespace 573553cf18cd44769a7624fc942493f076498527529Ted Kremenek 574553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 575553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for managing collections of summaries. 576553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 577553cf18cd44769a7624fc942493f076498527529Ted Kremenek 5784f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 579ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummaryManager { 580d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 581d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 582d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Typedefs. 583d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 58593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<const FunctionDecl*, const RetainSummary *> 586d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy; 5871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5884f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek typedef ObjCSummaryCache ObjCMethodSummariesTy; 5891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 590ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose typedef llvm::FoldingSetNodeWrapper<RetainSummary> CachedSummaryNode; 591ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 592d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 593d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Data. 594d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 596553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ctx - The ASTContext object for the analyzed ASTs. 5979c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &Ctx; 598179064eb831125630c296556dd6d67e67f716143Ted Kremenek 599553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// GCEnabled - Records whether or not the analyzed code runs in GC mode. 600377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek const bool GCEnabled; 6011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 602f85e193739c953358c865005855253af4f68a497John McCall /// Records whether or not the analyzed code runs in ARC mode. 603f85e193739c953358c865005855253af4f68a497John McCall const bool ARCEnabled; 604f85e193739c953358c865005855253af4f68a497John McCall 605553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// FuncSummaries - A map from FunctionDecls to summaries. 6061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump FuncSummariesTy FuncSummaries; 6071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 608553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCClassMethodSummaries - A map from selectors (for instance methods) 609553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// to summaries. 6101f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCClassMethodSummaries; 611d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 612553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCMethodSummaries - A map from selectors to summaries. 6131f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCMethodSummaries; 614d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 615553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// BPAlloc - A BumpPtrAllocator used for allocating summaries, ArgEffects, 616553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// and all other data used by the checker. 617d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek llvm::BumpPtrAllocator BPAlloc; 6181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 619b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek /// AF - A factory for ArgEffects objects. 6201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ArgEffects::Factory AF; 6211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 622553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ScratchArgs - A holding buffer for construct ArgEffects. 6230507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffects ScratchArgs; 6241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 625ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// ObjCAllocRetE - Default return effect for methods returning Objective-C 626ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// objects. 627ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek RetEffect ObjCAllocRetE; 628547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek 6291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// ObjCInitRetE - Default return effect for init methods returning 630ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek /// Objective-C objects. 631547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek RetEffect ObjCInitRetE; 6321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 633ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// SimpleSummaries - Used for uniquing summaries that don't have special 634ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// effects. 635ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSet<CachedSummaryNode> SimpleSummaries; 6361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 637d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 638d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Methods. 639d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 6401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 641553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArgEffects - Returns a persistent ArgEffects object based on the 642553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// data in ScratchArgs. 643b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects getArgEffects(); 64400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 6451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum UnaryFuncKind { cfretain, cfrelease, cfmakecollectable }; 64693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek 6470507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getUnarySummary(const FunctionType* FT, 64893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek UnaryFuncKind func); 6491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6500507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryCreateRule(const FunctionDecl *FD); 6510507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryGetRule(const FunctionDecl *FD); 6520507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFCreateGetRuleSummary(const FunctionDecl *FD); 6531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 654ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(const RetainSummary &OldSumm); 655706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 656ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(RetEffect RetEff, 65793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect ReceiverEff = DoNothing, 65893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect DefaultEff = MayEscape) { 659ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummary Summ(getArgEffects(), RetEff, DefaultEff, ReceiverEff); 660ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(Summ); 6619c32d08925045b32d7c39516e35d860159252e1dTed Kremenek } 6621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 663c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek const RetainSummary *getDoNothingSummary() { 664c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 665c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } 666c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek 667ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getDefaultSummary() { 668ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 669ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose DoNothing, MayEscape); 670ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 671706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 672ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentStopSummary() { 673ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 674ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose StopTracking, StopTracking); 6751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 676b309525445c8ec3d36e49568382029efc2740554Ted Kremenek 6771f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeClassMethodSummaries(); 6781f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeMethodSummaries(); 679896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekprivate: 68093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectClsMethSummary(Selector S, const RetainSummary *Summ) { 681553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCClassMethodSummaries[S] = Summ; 682553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectMethSummary(Selector S, const RetainSummary *Summ) { 685553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCMethodSummaries[S] = Summ; 686553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6873aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek 688a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek void addClassMethSummary(const char* Cls, const char* name, 689a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek const RetainSummary *Summ, bool isNullary = true) { 6903aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 691a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek Selector S = isNullary ? GetNullarySelector(name, Ctx) 692a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek : GetUnarySelector(name, Ctx); 6933aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6943aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek } 6951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6966c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek void addInstMethSummary(const char* Cls, const char* nullaryName, 69793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ) { 6986c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6996c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 7006c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek ObjCMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 7016c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek } 7021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 703de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector generateSelector(va_list argp) { 7045f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<IdentifierInfo*, 10> II; 705de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7069e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek while (const char* s = va_arg(argp, const char*)) 7079e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek II.push_back(&Ctx.Idents.get(s)); 708de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return Ctx.Selectors.getSelector(II.size(), &II[0]); 710de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 712de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addMethodSummary(IdentifierInfo *ClsII, ObjCMethodSummariesTy& Summaries, 71393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * Summ, va_list argp) { 714de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector S = generateSelector(argp); 715de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Summaries[ObjCSummaryKey(ClsII, S)] = Summ; 71670a733e64e2379a654631a14fa29e46761d5f80dTed Kremenek } 7171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addInstMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 719af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_list argp; 720af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_start(argp, Summ); 721de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls), ObjCMethodSummaries, Summ, argp); 7221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump va_end(argp); 723af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek } 7241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 72593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 726de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 727de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 728de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls),ObjCClassMethodSummaries, Summ, argp); 729de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 730de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(IdentifierInfo *II, const RetainSummary * Summ, ...) { 733de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 734de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 735de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(II, ObjCClassMethodSummaries, Summ, argp); 736de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 737de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 738de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7396b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 7401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7419c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummaryManager(ASTContext &ctx, bool gcenabled, bool usesARC) 742179064eb831125630c296556dd6d67e67f716143Ted Kremenek : Ctx(ctx), 743f85e193739c953358c865005855253af4f68a497John McCall GCEnabled(gcenabled), 744f85e193739c953358c865005855253af4f68a497John McCall ARCEnabled(usesARC), 745f85e193739c953358c865005855253af4f68a497John McCall AF(BPAlloc), ScratchArgs(AF.getEmptyMap()), 746f85e193739c953358c865005855253af4f68a497John McCall ObjCAllocRetE(gcenabled 747f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 748f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 749f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwned(RetEffect::ObjC, true))), 750f85e193739c953358c865005855253af4f68a497John McCall ObjCInitRetE(gcenabled 751f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 752f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 753ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose : RetEffect::MakeOwnedWhenTrackedReceiver())) { 754553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeClassMethodSummaries(); 755553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeMethodSummaries(); 756553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 7571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7584531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getSummary(const CallEvent &Call, 7594531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State = 0); 7601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7614531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getFunctionSummary(const FunctionDecl *FD); 7624531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 7634531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getMethodSummary(Selector S, const ObjCInterfaceDecl *ID, 764f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, 765f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose QualType RetTy, 766f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries); 767f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 768cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const RetainSummary *getInstanceMethodSummary(const ObjCMethodCall &M, 7694531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State); 770dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 771cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const RetainSummary *getClassMethodSummary(const ObjCMethodCall &M) { 7724531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(!M.isInstanceMessage()); 7734531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCInterfaceDecl *Class = M.getReceiverInterface(); 7741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7754531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(M.getSelector(), Class, M.getDecl(), 7764531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose M.getResultType(), ObjCClassMethodSummaries); 777fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek } 778552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek 779552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// getMethodSummary - This version of getMethodSummary is used to query 780552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// the summary for the current method being analyzed. 78193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getMethodSummary(const ObjCMethodDecl *MD) { 782a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID = MD->getClassInterface(); 78370a6576c9c8d21ff2361574f4937a2e73bd57779Ted Kremenek Selector S = MD->getSelector(); 784552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek QualType ResultTy = MD->getResultType(); 7851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 786f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy *CachedSummaries; 787552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek if (MD->isInstanceMethod()) 788f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCMethodSummaries; 789552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek else 790f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCClassMethodSummaries; 791f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 7924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(S, ID, MD, ResultTy, *CachedSummaries); 793552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek } 7941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 795f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *getStandardMethodSummary(const ObjCMethodDecl *MD, 7964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Selector S, QualType RetTy); 797a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek 79893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7994dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD); 8004dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 80193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 8024dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD); 8034dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 8044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose void updateSummaryForCall(const RetainSummary *&Summ, 8054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &Call); 8064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 807d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek bool isGCEnabled() const { return GCEnabled; } 8081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 809f85e193739c953358c865005855253af4f68a497John McCall bool isARCEnabled() const { return ARCEnabled; } 810f85e193739c953358c865005855253af4f68a497John McCall 811f85e193739c953358c865005855253af4f68a497John McCall bool isARCorGCEnabled() const { return GCEnabled || ARCEnabled; } 8124531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 8134531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetEffect getObjAllocRetEffect() const { return ObjCAllocRetE; } 8144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 8154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose friend class RetainSummaryTemplate; 8166b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 8171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8180fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// Used to avoid allocating long-term (BPAlloc'd) memory for default retain 8190fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// summaries. If a function or method looks like it has a default summary, but 8200fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// it has annotations, the annotations are added to the stack-based template 8210fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// and then copied into managed memory. 8220fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Roseclass RetainSummaryTemplate { 8230fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &Manager; 82493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *&RealSummary; 8250fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary ScratchSummary; 8260fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose bool Accessed; 8270fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rosepublic: 8284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate(const RetainSummary *&real, RetainSummaryManager &mgr) 8294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose : Manager(mgr), RealSummary(real), ScratchSummary(*real), Accessed(false) {} 8300fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8310fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose ~RetainSummaryTemplate() { 83293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek if (Accessed) 833ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RealSummary = Manager.getPersistentSummary(ScratchSummary); 8340fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8350fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8360fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary &operator*() { 8370fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 83893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return ScratchSummary; 8390fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8400fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8410fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *operator->() { 8420fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 84393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return &ScratchSummary; 8440fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8450fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose}; 8460fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8476b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end anonymous namespace 8486b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 8496b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8506b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek// Implementation of checker data structures. 8516b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8526b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 853b77449cead63264650958c92cb30609c942cc5e9Ted KremenekArgEffects RetainSummaryManager::getArgEffects() { 854b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects AE = ScratchArgs; 8553baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.getEmptyMap(); 856b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return AE; 85700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 85800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 85993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 860ef94588752babc1b7c46b955e57945fc4c183db2Jordy RoseRetainSummaryManager::getPersistentSummary(const RetainSummary &OldSumm) { 861ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose // Unique "simple" summaries -- those without ArgEffects. 862ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (OldSumm.isSimple()) { 863ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSetNodeID ID; 864ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose OldSumm.Profile(ID); 865ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 866ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void *Pos; 867ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose CachedSummaryNode *N = SimpleSummaries.FindNodeOrInsertPos(ID, Pos); 868ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 869ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (!N) { 870ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose N = (CachedSummaryNode *) BPAlloc.Allocate<CachedSummaryNode>(); 871ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (N) CachedSummaryNode(OldSumm); 872ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose SimpleSummaries.InsertNode(N, Pos); 873ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 874ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 875ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return &N->getValue(); 876ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 877ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 87893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 879ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (Summ) RetainSummary(OldSumm); 88000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek return Summ; 88100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 88200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 883d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 884d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for functions (largely uses of Core Foundation). 885d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 88600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 8879c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRetain(const FunctionDecl *FD, StringRef FName) { 888b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Retain"); 8891261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8901261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 8919c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRelease(const FunctionDecl *FD, StringRef FName) { 892b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Release"); 8931261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8941261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 89576c506fba2359296d1f19e64998bd11d7b864563Jordy Rosestatic bool isMakeCollectable(const FunctionDecl *FD, StringRef FName) { 89676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Remove FunctionDecl parameter. 89776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Is it really okay if MakeCollectable isn't a suffix? 89876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return FName.find("MakeCollectable") != StringRef::npos; 89976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 90076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 901554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaksstatic ArgEffect getStopTrackingHardEquivalent(ArgEffect E) { 9024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose switch (E) { 9034531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DoNothing: 9044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case Autorelease: 9054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefBridgedTransfered: 9064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRef: 9074531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRefMsg: 9084531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MakeCollectable: 9094531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MayEscape: 9104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case NewAutoreleasePool: 9114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case StopTracking: 912554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case StopTrackingHard: 913554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return StopTrackingHard; 9144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRef: 915554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefAndStopTrackingHard: 916554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return DecRefAndStopTrackingHard; 9174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsg: 918554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefMsgAndStopTrackingHard: 919554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return DecRefMsgAndStopTrackingHard; 9204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case Dealloc: 9214531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return Dealloc; 9224531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9234531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9244531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose llvm_unreachable("Unknown ArgEffect kind"); 9254531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 9264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rosevoid RetainSummaryManager::updateSummaryForCall(const RetainSummary *&S, 9284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &Call) { 9294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Call.hasNonZeroCallbackArg()) { 930554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ArgEffect RecEffect = 931554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks getStopTrackingHardEquivalent(S->getReceiverEffect()); 932554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ArgEffect DefEffect = 933554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks getStopTrackingHardEquivalent(S->getDefaultArgEffect()); 9344531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9354531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffects CustomArgEffects = S->getArgEffects(); 9364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose for (ArgEffects::iterator I = CustomArgEffects.begin(), 9374531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = CustomArgEffects.end(); 9384531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose I != E; ++I) { 939554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ArgEffect Translated = getStopTrackingHardEquivalent(I->second); 9404531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Translated != DefEffect) 9414531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ScratchArgs = AF.add(ScratchArgs, I->first, Translated); 9424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 944554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks RetEffect RE = RetEffect::MakeNoRetHard(); 9454531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9464531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // Special cases where the callback argument CANNOT free the return value. 9474531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // This can generally only happen if we know that the callback will only be 9484531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // called when the return value is already being deallocated. 9494531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const FunctionCall *FC = dyn_cast<FunctionCall>(&Call)) { 9504531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose IdentifierInfo *Name = FC->getDecl()->getIdentifier(); 9514531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9524531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // This callback frees the associated buffer. 9534531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Name->isStr("CGBitmapContextCreateWithData")) 9544531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = S->getRetEffect(); 9554531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9564531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9574531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose S = getPersistentSummary(RE, RecEffect, DefEffect); 9584531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9595a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9605a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Special case '[super init];' and '[self init];' 9615a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // 9625a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Even though calling '[super init]' without assigning the result to self 9635a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // and checking if the parent returns 'nil' is a bad pattern, it is common. 9645a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Additionally, our Self Init checker already warns about it. To avoid 9655a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // overwhelming the user with messages from both checkers, we model the case 9665a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // of '[super init]' in cases when it is not consumed by another expression 9675a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // as if the call preserves the value of 'self'; essentially, assuming it can 9685a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // never fail and return 'nil'. 9695a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Note, we don't want to just stop tracking the value since we want the 9705a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // RetainCount checker to report leaks and use-after-free if SelfInit checker 9715a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // is turned off. 9725a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (const ObjCMethodCall *MC = dyn_cast<ObjCMethodCall>(&Call)) { 9735a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (MC->getMethodFamily() == OMF_init && MC->isReceiverSelfOrSuper()) { 9745a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9755a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Check if the message is not consumed, we know it will not be used in 9765a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // an assignment, ex: "self = [super init]". 9775a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks const Expr *ME = MC->getOriginExpr(); 9785a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks const LocationContext *LCtx = MC->getLocationContext(); 9795a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ParentMap &PM = LCtx->getAnalysisDeclContext()->getParentMap(); 9805a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (!PM.isConsumedExpr(ME)) { 9815a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks RetainSummaryTemplate ModifiableSummaryTemplate(S, *this); 9825a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ModifiableSummaryTemplate->setReceiverEffect(DoNothing); 9835a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ModifiableSummaryTemplate->setRetEffect(RetEffect::MakeNoRet()); 9845a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9855a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9865a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9875a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9884531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 9894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Roseconst RetainSummary * 9914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getSummary(const CallEvent &Call, 9924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State) { 9934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ; 9944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose switch (Call.getKind()) { 9954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_Function: 9964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getFunctionSummary(cast<FunctionCall>(Call).getDecl()); 9974531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 9984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_CXXMember: 999fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose case CE_CXXMemberOperator: 10004531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_Block: 10014531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_CXXConstructor: 10028d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose case CE_CXXDestructor: 100370cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 10044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: These calls are currently unsupported. 10054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getPersistentStopSummary(); 10068919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case CE_ObjCMessage: { 1007cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCMethodCall &Msg = cast<ObjCMethodCall>(Call); 10084531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Msg.isInstanceMessage()) 10094531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getInstanceMethodSummary(Msg, State); 10104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose else 10114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getClassMethodSummary(Msg); 10124531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 10134531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 10144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 10154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 10164531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose updateSummaryForCall(Summ, Call); 10174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 10184531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Unknown call type?"); 10194531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return Summ; 10204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 10214531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 102258822c403cc8855adeecba92248612ee08dc1f3aAnna Zaksconst RetainSummary * 10234531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getFunctionSummary(const FunctionDecl *FD) { 10244531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we don't know what function we're calling, use our default summary. 10254531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!FD) 10264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getDefaultSummary(); 10274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 1028891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 1029d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 1030d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 1031891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 1032891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 1033e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 103493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *S = 0; 103515d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose bool AllowAnnotations = true; 10361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 10381261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 10391261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 10401261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 10411261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 10421261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 10431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1044183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 104599890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 1046183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 104748c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 104848c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 104948c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 1050b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 1051b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 10521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1053bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 1054bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 1055b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 10561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10571261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 10581261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 10591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10601261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 10611261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 1062008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 1063e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1064befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek if (FName == "pthread_create" || FName == "pthread_setspecific") { 1065befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // Part of: <rdar://problem/7299394> and <rdar://problem/11282706>. 1066befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // This will be addressed better with IPA. 1067b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 1068b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 1069b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 1070b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 1071b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 1072b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 107315d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose // The headers on OS X 10.8 use cf_consumed/ns_returns_retained, 107415d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose // but we can fully model NSMakeCollectable ourselves. 107515d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose AllowAnnotations = false; 1076b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 1077b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 1078b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 1079537dd3a8c87765245aad792a3356852a87380a30Ted Kremenek FName == "IORegistryEntrySearchCFProperty" || 1080b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 1081b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 1082b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 1083b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 1084b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 1085b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 1086b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 1087b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 1088b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 1089b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 1090b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 10913baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 1092b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1093b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 1094b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 1095b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 1096b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 10973baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 1098b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1099b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 1100b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 1101b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 1102b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 1103b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 1104b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 1105b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 11063baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 1107b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1108b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 1109b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 1110b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 1111b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 1112b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 11133baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 1114b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 1115b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 1116b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 1117b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 1118b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 1119b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 1120b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 1121b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 11223baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 1123b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 112406911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek } else if (FName == "dispatch_set_context") { 112506911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // <rdar://problem/11059275> - The analyzer currently doesn't have 112606911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // a good way to reason about the finalizer function for libdispatch. 112706911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // If we pass a context object that is memory managed, stop tracking it. 112806911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // FIXME: this hack should possibly go away once we can handle 112906911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // libdispatch finalizers. 113006911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 113106911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1132c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } else if (FName.startswith("NSLog")) { 1133c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek S = getDoNothingSummary(); 113462a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks } else if (FName.startswith("NS") && 113562a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks (FName.find("Insert") != StringRef::npos)) { 113662a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // Whitelist NSXXInsertXX, for example NSMapInsertIfAbsent, since they can 113762a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // be deallocated by NSMapRemove. (radar://11152419) 113862a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 113962a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 2, StopTracking); 114062a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1141b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 11421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1143b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 1144b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 1145b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 114661991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 11471261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (RetTy->isPointerType()) { 11481261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 114978acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 11501261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 11511261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 115276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 11531261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 11541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 11557df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 11561261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 115737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 115837d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11591261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11601261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 116178acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 11621261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 11631261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 11641261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 11657df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 11661261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 116737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 116837d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11691261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11701261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 117178acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 117278acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 117378acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 11747df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1175706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1176706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 11771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11781261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 117937d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11801261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11811261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 11821261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 11831261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1184e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1185b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1186e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1187bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 11881261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 11891261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1190b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11916818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 11926818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 11936818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 11946818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 11956818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 11961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 11976818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 11981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 11996818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 12006818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 12016818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1202c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1203c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1204c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1205c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1206e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1207e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1208e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1209e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1210c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 12116818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 12121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12136818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 12141261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 121564e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 121637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 121737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 12181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12194531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we got all the way here without any luck, use a default summary. 12204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!S) 12214531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose S = getDefaultSummary(); 12224531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 12234dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 122415d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose if (AllowAnnotations) 122515d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose updateSummaryFromAnnotations(S, FD); 12261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1227d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 12281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 12292fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 12302fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 123193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12327df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 12337df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 123486ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 12351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1236d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 123700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 123800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 123993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12406ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 12416ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 12426ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 12431261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 12441261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 124572564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 12461261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 12471261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 12481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1249b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 12501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 125176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1252377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 125376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 125476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 125576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 1256940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 125776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 125876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 125976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 126000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 126100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 126293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12639c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1264b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 12651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12662d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 126700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 126800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 126993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12709c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 12711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 12722d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 12732d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 127400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 127500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 12766b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1277d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1278d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1279d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 12804dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 128193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 12824dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 12834dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 12844dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 12854dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 12864531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Must have a summary to add annotations to."); 12874531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate Template(Summ, *this); 12884df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 128911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 129011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 129111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 129298b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 129311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 129411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 12954df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 12960fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 12974df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 12984df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 12990fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 130011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 130111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 130211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1303b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 13041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13054dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 130678acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 130740b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 13080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 13094dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 131040b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 13110fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1312b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 13136041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>()) { 13140fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 13156041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13166041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 13170fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 13186041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13194df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (RetTy->getAs<PointerType>()) { 132040b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 13210fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 13224dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1323d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 13240fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1325d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 13264dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 13274dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 13284dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 13294dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 133093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 133193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD) { 13324dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 13334dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 13344dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 13354531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Must have a valid summary to add annotations to"); 13364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate Template(Summ, *this); 13376d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 13381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 133912b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 134012b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 134111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 13420fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 134311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 134411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 134511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 134611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1347491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1348491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 134911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 135011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 135111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 135211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 13530fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 135411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 135511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 13560fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 135711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 135812b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 135912b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 13604dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 136178acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 136240b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 13630fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 13646d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 13654dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 13666041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>()) { 13670fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 13686041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 13696041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13716d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 13720fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 13736217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 13740fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 13751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13766041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 13776041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 13780fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 13796041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 13800fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 13816041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13824dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 13834dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 138493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1385f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy RoseRetainSummaryManager::getStandardMethodSummary(const ObjCMethodDecl *MD, 1386f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Selector S, QualType RetTy) { 1387e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Any special effects? 13888ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 1389e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetEffect ResultEff = RetEffect::MakeNoRet(); 1390e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose 1391e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Check the method family, and apply any default annotations. 1392e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (MD ? MD->getMethodFamily() : S.getMethodFamily()) { 1393e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_None: 1394e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_performSelector: 1395e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Assume all Objective-C methods follow Cocoa Memory Management rules. 1396e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // FIXME: Does the non-threaded performSelector family really belong here? 1397e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // The selector could be, say, @selector(copy). 1398e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1399e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::ObjC); 1400e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) { 1401e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // ObjCMethodDecl currently doesn't consider CF objects as valid return 1402e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // values for alloc, new, copy, or mutableCopy, so we have to 1403e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // double-check with the selector. This is ugly, but there aren't that 1404e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // many Objective-C methods that return CF objects, right? 1405e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (MD) { 1406e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (S.getMethodFamily()) { 1407e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1408e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1409e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1410e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1411e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1412e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1413e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose default: 1414e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1415e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1416e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1417e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } else { 1418e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1419e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1420e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1421e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1422e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_init: 1423e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCInitRetE; 1424e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1425e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1426e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1427e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1428e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1429e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1430e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1431e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCAllocRetE; 1432e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) 1433e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1434e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1435e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_autorelease: 1436e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Autorelease; 1437e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1438e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retain: 1439e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = IncRefMsg; 1440e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1441e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_release: 1442e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1443e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1444e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_dealloc: 1445e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Dealloc; 1446e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1447e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_self: 1448e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // -self is handled specially by the ExprEngine to propagate the receiver. 1449e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1450e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retainCount: 1451e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_finalize: 1452e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // These methods don't return objects. 1453e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1454e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 14551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14568ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 14578ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 14588ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 14598ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 14608ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 146150571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose for (unsigned i = 0, e = S.getNumArgs(); i != e; ++i) { 146250571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose StringRef Slot = S.getNameForSlot(i); 146350571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (Slot.substr(Slot.size() - 8).equals_lower("delegate")) { 146450571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (ResultEff == ObjCInitRetE) 1465554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ResultEff = RetEffect::MakeNoRetHard(); 146650571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose else 1467554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ReceiverEff = StopTrackingHard; 146850571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 146950571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 14708ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 14711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1472e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing && 1473e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff.getKind() == RetEffect::NoRet) 147493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 14751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1476e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose return getPersistentSummary(ResultEff, ReceiverEff, MayEscape); 1477250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1478250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 147993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1480cde8cdbd6a662c636164465ad309b5f17ff01064Jordan RoseRetainSummaryManager::getInstanceMethodSummary(const ObjCMethodCall &Msg, 14814531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State) { 14824531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCInterfaceDecl *ReceiverClass = 0; 14834531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 14844531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // We do better tracking of the type of the object than the core ExprEngine. 14854531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // See if we have its type in our private state. 14864531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: Eventually replace the use of state->get<RefBindings> with 14874531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // a generic API for reasoning about the Objective-C types of symbolic 14884531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // objects. 14894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose SVal ReceiverV = Msg.getReceiverSVal(); 14904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (SymbolRef Sym = ReceiverV.getAsLocSymbol()) 14918d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(State, Sym)) 14924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const ObjCObjectPointerType *PT = 1493b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 14944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverClass = PT->getInterfaceDecl(); 1495dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 14964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we don't know what kind of object this is, fall back to its static type. 14974531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!ReceiverClass) 14984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverClass = Msg.getReceiverInterface(); 149904badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1500b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1501b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 15024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // id x = [NSObject class]; 15034531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // [x performSelector:... withObject:... afterDelay:...]; 15044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Selector S = Msg.getSelector(); 15054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCMethodDecl *Method = Msg.getDecl(); 15064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!Method && ReceiverClass) 15074531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Method = ReceiverClass->getInstanceMethod(S); 15084531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 15094531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(S, ReceiverClass, Method, Msg.getResultType(), 15104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ObjCMethodSummaries); 1511b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1512b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 151393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 15144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getMethodSummary(Selector S, const ObjCInterfaceDecl *ID, 1515f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, QualType RetTy, 1516f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries) { 15171bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 15188711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 15194531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ = CachedSummaries.find(ID, S); 15201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1521614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1522f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Summ = getStandardMethodSummary(MD, S, RetTy); 15234df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1524614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 15254df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 15264df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1527614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 15284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose CachedSummaries[ObjCSummaryKey(ID, S)] = Summ; 1529614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 15301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1531e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1532c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1533c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 15341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1535ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 15361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 15376fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 15382d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 15391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15406d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 15413baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 15426fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 15436fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 15446fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 15459c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 15469c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 15471f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 15481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 15501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1551c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1552c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 155393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1554ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1555ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1556ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1557ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1558ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1559ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 15601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1561c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 156293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 156393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *CFAllocSumm = 1564a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 15651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15663c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1567500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 156893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1569553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 15701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15713c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1572500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1573553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 15741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1575299e8158d63d69830cca0187f4003cba1e66081fTed Kremenek // Create the "drain" selector. 1576500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, isGCEnabled() ? DoNothing : DecRef); 1577553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); 15781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1579f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1580500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1581f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 15823c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 15833c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1584500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1585553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 15861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1587f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek // Specially handle NSAutoreleasePool. 15886c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek addInstMethSummary("NSAutoreleasePool", "init", 1589500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose getPersistentSummary(NoRet, NewAutoreleasePool)); 15901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 159289e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 159389e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 159489e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 159589e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 15963aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 159793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 159878a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 159978a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 16001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 160199d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 160299d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 1603179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1604179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 160599d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 160699d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 160799d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 16081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1609ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // Don't track allocated autorelease pools yet, as it is okay to prematurely 1610ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1611ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1612a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek addClassMethSummary("NSAutoreleasePool", "allocWithZone", NoTrackYet, false); 1613553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1614767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1615767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1616767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1617767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1618767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1619767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1620211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1621a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1622a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1623a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1624767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1625a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 16261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1627a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1628211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1629b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1630b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1631d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1632c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1633c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1634c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1635ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1636ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1637ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1638c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1639c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 16401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 16411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1642ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1643c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 164435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 16456fd4505ad67a186da8cc26fdb493c93fe4937555Ted Kremenek : BugType(name, categories::MemoryCoreFoundationObjectiveC) {} 1646c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1648c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 164935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 16501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1651c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1652c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1654ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1655c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 165635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 165835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1659c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1661c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1663ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1664c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 166535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 16661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 166735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1668bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1669bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1670b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1671c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1673ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1674c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 167535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 167635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 16771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1678c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1679369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 16801499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1681c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1683ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1684c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 168535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 168635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 16871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1688c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1689c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 169000a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 16911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1693ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1694369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 169535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 169635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 16971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1698369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1699eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1700369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1701369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 17021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1703ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1704e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 170535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 170635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 17071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1708e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 17095b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1710e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1711e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1712e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 17131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1714ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1715facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer public: 1716facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer Leak(StringRef name) 1717facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer : CFRefBug(name) { 1718db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1719db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1720db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 17211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 172235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 17231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1724c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1725c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1727c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1728c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1729c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 17301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1731011534973e83db51f49098871186238fc64d5f54Jordy Rose class CFRefReportVisitor : public BugReporterVisitorImpl<CFRefReportVisitor> { 173223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1733dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1734ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 173535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 173623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1737dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 173835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 173935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1740dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 174123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1742dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1743dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1744dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1745dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1746dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 174723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 174823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 174923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 175023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 175123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 175223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 175323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 175423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 175523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 175623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 175723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 175823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 175935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1760ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 176135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 176223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 176323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 176423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 176523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1766011534973e83db51f49098871186238fc64d5f54Jordy Rose 1767011534973e83db51f49098871186238fc64d5f54Jordy Rose virtual BugReporterVisitor *clone() const { 1768011534973e83db51f49098871186238fc64d5f54Jordy Rose // The curiously-recurring template pattern only works for one level of 1769011534973e83db51f49098871186238fc64d5f54Jordy Rose // subclassing. Rather than make a new template base for 1770011534973e83db51f49098871186238fc64d5f54Jordy Rose // CFRefReportVisitor, we simply override clone() to do the right thing. 1771011534973e83db51f49098871186238fc64d5f54Jordy Rose // This could be trouble someday if BugReporterVisitorImpl is ever 1772011534973e83db51f49098871186238fc64d5f54Jordy Rose // used for something else besides a convenient implementation of clone(). 1773011534973e83db51f49098871186238fc64d5f54Jordy Rose return new CFRefLeakReportVisitor(*this); 1774011534973e83db51f49098871186238fc64d5f54Jordy Rose } 1775dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1776dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1777e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 17782058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 177935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1780c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17812058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17822058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17832058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1784edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 178523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 17862058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17872058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1788dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1789eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 17902058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17912058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17922058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1793edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 17942058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17952058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1796dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 17971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1798e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1799edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1800edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1801e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1802c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1803640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1804c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1805c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1806eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1807ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1808c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 180923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1810c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 18112058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 18122058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 18136a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx); 18141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1815590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1816590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1817590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1818590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 18191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 18205216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 18215216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 18222058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 18232058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1824f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 18251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1826e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 18277f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 18282058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 182935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 183035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18327f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 18332058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 183435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 183535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18377f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 18382058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 183935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 184035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 184135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 184235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 184335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 184435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 184535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 184635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 184735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18487f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1849c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 185035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1851f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 185235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1853c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1854e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1855910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18565f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1857c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18585f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1859c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1860c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 18611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1862c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1863c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1864c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 186570fdbc366da85880aae5baebd3351e993ca05603Jordy Rosestatic bool isNumericLiteralExpression(const Expr *E) { 186670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // FIXME: This set of cases was copied from SemaExprObjC. 186770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose return isa<IntegerLiteral>(E) || 186870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CharacterLiteral>(E) || 186970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<FloatingLiteral>(E) || 187070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<ObjCBoolLiteralExpr>(E) || 187170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CXXBoolLiteralExpr>(E); 187270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 187370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 1874dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1875dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1876dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1877dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 187828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // FIXME: We will eventually need to handle non-statement-based events 187928038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // (__attribute__((cleanup))). 1880f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<StmtPoint>(N->getLocation())) 18812033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 18821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18838966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 18848bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef PrevSt = PrevN->getState(); 18858bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef CurrSt = N->getState(); 18865eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = N->getLocationContext(); 18871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18888d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* CurrT = getRefBinding(CurrSt, Sym); 1889c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 18901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1891b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 18928d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *PrevT = getRefBinding(PrevSt, Sym); 18931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1894c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1895c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1896c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1897c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 18981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1899c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1900c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1901c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 1902f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (isa<ObjCArrayLiteral>(S)) { 19051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSArray literal is an object with a +0 retain count"; 19061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 19071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else if (isa<ObjCDictionaryLiteral>(S)) { 19081a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSDictionary literal is an object with a +0 retain count"; 1909c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 191070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else if (const ObjCBoxedExpr *BL = dyn_cast<ObjCBoxedExpr>(S)) { 191170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (isNumericLiteralExpression(BL->getSubExpr())) 191270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "NSNumber literal is an object with a +0 retain count"; 191370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else { 191470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ObjCInterfaceDecl *BoxClass = 0; 191570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (const ObjCMethodDecl *Method = BL->getBoxingMethod()) 191670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose BoxClass = Method->getClassInterface(); 191770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 191870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // We should always be able to find the boxing class interface, 191970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // but consider this future-proofing. 192070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (BoxClass) 192170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << *BoxClass << " b"; 192270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else 192370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "B"; 192470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 192570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "oxed expression produces an object with a +0 retain count"; 192670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 192770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 19281a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19291a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 19301a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Get the name of the callee (if it is available). 19311a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee(), LCtx); 19321a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 19331a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "Call to function '" << *FD << '\''; 19341a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else 19351a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "function call"; 19361a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19371a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19388919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose assert(isa<ObjCMessageExpr>(S)); 1939d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &Mgr = CurrSt->getStateManager().getCallEventManager(); 1940d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<ObjCMethodCall> Call 1941d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = Mgr.getObjCMethodCall(cast<ObjCMessageExpr>(S), CurrSt, LCtx); 1942d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 1943d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose switch (Call->getMessageKind()) { 19448919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Message: 19458919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Method"; 19468919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19478919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_PropertyAccess: 19488919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Property"; 19498919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19508919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Subscript: 19518919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Subscript"; 19528919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19538919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 19541a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19561a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 19571a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns a Core Foundation object with a "; 19581a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19591a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19601a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 19611a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns an Objective-C object with a "; 19621a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19641a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.isOwned()) { 19651a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+1 retain count"; 19661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19671a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (GCEnabled) { 19681a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 19691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << ". " 19701a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek "Core Foundation objects are not automatically garbage collected."; 19711a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19721a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19731a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19741a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.isNotOwned()); 19751a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+0 retain count"; 1976c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1977cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1979220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 1980220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 1981c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 1982cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1984c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 1985c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 19865f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 19871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1988ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 1989ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 1990c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 1991c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 1992f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19945f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1995c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 1996c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 1997c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 19981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19995f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 2000c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 20011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2002c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 2003c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 20045eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI, LCtx).getAsLocSymbol() != Sym) 2005c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 20061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2007c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 2008c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 2009c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2010c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 201204badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 20135eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver, LCtx) 20145eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek .getAsLocSymbol() == Sym) { 2015c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 2016c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 2017c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2018c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20191c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 20201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2021c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 2022c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 2023c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 20241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2025c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 202635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 2027c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2028c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 2029c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 2030c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 2031c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2032f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 2033c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 2034f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 2035f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 2036c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2038c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 2039c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 2040c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 2041f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 20425eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = 20435eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee(), LCtx); 20449c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 20451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 204635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 2047c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2048c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 20491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2050b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "In GC mode a call to '" << *FD 2051c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 2052c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 20531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2054c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2055c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 2056c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 2057c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 2058c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2059c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2060c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 2061c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 2062c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 20633eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 20641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 2065b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "When GC is not enabled a call to '" << *FD 2066c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 20671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2068c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 2069c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2070c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 2073c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 2074c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 20751ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 20761ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 20771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2078f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 2079f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 2080f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 2081f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 20821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2083264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 2084eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 2085f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 2086f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 20871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2088c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 2089c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 2090c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2091c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 20921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2093c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 2094c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 20951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2096c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 209735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 209874b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << " The object is not eligible for garbage collection until " 209974b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "the retain count reaches 0 again."; 2100c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2102c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21041ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2105c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 21061ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 21071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2108c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 210974b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose // Autoreleases can be applied after marking a node ReturnedOwned. 211074b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose if (CurrV.getAutoreleaseCount()) 211174b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose return NULL; 211274b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose 211374b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << "Object returned to caller as an owning reference (single " 211474b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "retain count transferred to caller)"; 2115c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2117c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2118f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2119c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2121c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2122c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2123c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2125c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 21265f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2127c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 21281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2129c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 213035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2131c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2132c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2133c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2134c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2135c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2136c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2137c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2138c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2139c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2140c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2141c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2142c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2143c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 21451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2146c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2147c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 21482033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 2149f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 2150220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2151220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 21529c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 21531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2154c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2155c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 21561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 21575f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 21589c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 21595eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp, LCtx).getAsLocSymbol() == Sym) { 2160c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2161c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2162c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2164c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2165c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2166c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2167e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// Find the first node in the current function context that referred to the 2168e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// tracked symbol and the memory location that value was stored to. Note, the 2169e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// value is only reported if the allocation occurred in the same function as 2170e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// the leak. 2171c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 217218c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2173c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 21749c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 21751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 2176e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks const LocationContext *LeakContext = N->getLocationContext(); 21771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2178c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 21798bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St = N->getState(); 21801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21818d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (!getRefBinding(St, Sym)) 2182940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 21831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 218427b867ea1c9cb4b40f9b817c303d6df3ee753da9Anna Zaks StoreManager::FindUniqueBinding FB(Sym); 21851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 21861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 21871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2188e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // Allocation node, is the last node in the current context in which the 2189e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // symbol was tracked. 2190e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() == LeakContext) 2191e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks Last = N; 2192e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 21931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 21941ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 21951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2196e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // If allocation happened in a function different from the leak node context, 2197e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // do not report the binding. 2198e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() != LeakContext) { 2199e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks FirstBinding = 0; 2200e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks } 2201e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 2202c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 22036b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 22046b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2205c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 220623f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 220723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 220823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 220976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 221023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2211c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2212fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2213c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 221423f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 221523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 221623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 22171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22188966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2219c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 222076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 22211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2222c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2223c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2224c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 22259c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2226c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 22271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2228c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2229f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 22301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22314fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 22321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2233c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2234c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2235c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 22369c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 22374fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 22381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2239c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2240c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 22411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2242f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 22431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2244f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2245f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2246f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2247f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2248f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2249f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 22501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2251c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 22528d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* RV = getRefBinding(EndN->getState(), Sym); 22531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2254c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2255c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 22565b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2257c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2258d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2259d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2260d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek os << " is returned from a method whose name ('" 2261d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << MD->getSelector().getAsString() 2262d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 22635b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose " This violates the naming convention rules" 2264f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " given in the Memory Management Guide for Cocoa"; 2265d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2266d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2267d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2268b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek os << " is returned from a function whose name ('" 2269a59d20b135bfde058a5a69045bab5ec4e2553f74Benjamin Kramer << *FD 2270d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 2271b7dcddf1820f4d2e5c2605c12090ea7d17f9fa82Ted Kremenek " convention rules given in the Memory Management Guide for Core" 2272f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek " Foundation"; 2273d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek } 2274c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2275e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 22769c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2277e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 227882f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 227982f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 228082f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 228182f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2282e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2283c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2284abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2285f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 22861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2287c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2288c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2289cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 22902058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 22912058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 22922058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 22936a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx) 22942058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 22951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2296fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2297c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2298c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2299c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2300c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2301c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2302c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2303c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 23049c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 23051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23066a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const SourceManager& SMgr = Ctx.getSourceManager(); 2307590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2308c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 23096a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks GetAllocationSite(Ctx.getStateManager(), getErrorNode(), sym); 23101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2311c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2312852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: This will crash the analyzer if an allocation comes from an 2313852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // implicit call. (Currently there are no such allocations in Cocoa, though.) 2314852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const Stmt *AllocStmt; 2315c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 2316852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CallExitEnd *Exit = dyn_cast<CallExitEnd>(&P)) 2317852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose AllocStmt = Exit->getCalleeContext()->getCallSite(); 2318852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose else 2319852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose AllocStmt = cast<PostStmt>(P).getStmt(); 2320852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose assert(AllocStmt && "All allocations must come from explicit calls"); 2321590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2322590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2323c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2324c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2325c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2326dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 23272058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2328dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2329212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << "of an object"; 23301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2331c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2332c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2333212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << " stored into '" << AllocBinding->getString() << '\''; 2334dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 23352058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2336c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2337c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2338c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2339c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2340c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2341c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2342d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2343910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 23449c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 234538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 23469c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 234738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::EndPath, 23486704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2349f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 23501a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCArrayLiteral>, 23511a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCDictionaryLiteral>, 235270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose check::PostStmt<ObjCBoxedExpr>, 2353fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose check::PostCall, 2354f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 23556704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 235676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 235776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 23586f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 23596f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 23606f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 23616f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 23626f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 236338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 236438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 236538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 236638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 236738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 236838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23696f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> Summaries; 23706f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> SummariesGC; 23719c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 23729c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 23739c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23742f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2375910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 237638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2377910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 237838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 237938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 238038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23819c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 23829c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 23839c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 23849c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 23859c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 23869c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 23879c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 23889c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 23899c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 23909c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 23919c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 23921ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23931ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 23941ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 23951ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 23961ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 23971ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23989c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 23999c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 24009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 24019c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 24021ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 24039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 24049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 24059c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 24069c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24079c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 24089c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 24099c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 24109c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 24119c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 24129c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 24139c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24149c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 24151ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 24161ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 241717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 241817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 241917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2420db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2421facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunctionGC.reset(new Leak("Leak of object when using " 2422facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 242317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2424db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2425db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2426e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2427facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak of object when not using " 2428facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in " 2429facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "dual GC/non-GC code")); 2430db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2431facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak")); 2432db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2433db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 243417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunction.get(); 2435db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2436db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2437db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 243817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakAtReturnBug(const LangOptions &LOpts, bool GCEnabled) const { 243917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2440db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturnGC) 2441facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturnGC.reset(new Leak("Leak of returned object when using " 2442facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 244317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2444db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2445db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2446e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2447facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object when not using " 2448facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in dual " 2449facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "GC/non-GC code")); 2450db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2451facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object")); 2452db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2453db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 245417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturn.get(); 2455db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2456db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2457db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 245817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(ASTContext &Ctx, 245917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 246017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // FIXME: We don't support ARC being turned on and off during one analysis. 246117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // (nor, for that matter, do we support changing ASTContexts) 24624e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie bool ARCEnabled = (bool)Ctx.getLangOpts().ObjCAutoRefCount; 246317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 246417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!SummariesGC) 2465b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose SummariesGC.reset(new RetainSummaryManager(Ctx, true, ARCEnabled)); 246617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 246717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(SummariesGC->isARCEnabled() == ARCEnabled); 2468b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *SummariesGC; 2469b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } else { 247017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!Summaries) 2471b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose Summaries.reset(new RetainSummaryManager(Ctx, false, ARCEnabled)); 247217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 247317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(Summaries->isARCEnabled() == ARCEnabled); 2474b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *Summaries; 2475b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2476b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2477b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 247817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(CheckerContext &C) const { 247917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return getSummaryManager(C.getASTContext(), C.isObjCGCEnabled()); 248017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 248117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 24828bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void printState(raw_ostream &Out, ProgramStateRef State, 2483dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const char *NL, const char *Sep) const; 2484dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 2485390909c89c98ab1807e15e033a72e975f866fb23Anna Zaks void checkBind(SVal loc, SVal val, const Stmt *S, CheckerContext &C) const; 2486ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const; 2487ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const CastExpr *CE, CheckerContext &C) const; 2488f85e193739c953358c865005855253af4f68a497John McCall 24891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCArrayLiteral *AL, CheckerContext &C) const; 24901a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCDictionaryLiteral *DL, CheckerContext &C) const; 249170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose void checkPostStmt(const ObjCBoxedExpr *BE, CheckerContext &C) const; 249270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2493fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose void checkPostCall(const CallEvent &Call, CheckerContext &C) const; 24941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 24954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose void checkSummary(const RetainSummary &Summ, const CallEvent &Call, 2496e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2497294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2498554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks void processSummaryOfInlined(const RetainSummary &Summ, 2499554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const CallEvent &Call, 2500554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const; 2501554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 250276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 250376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 25048bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond, 2505ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 25066704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25078bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 25088bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek checkRegionChanges(ProgramStateRef state, 2509537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 2510537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 251166c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 2512740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const; 2513ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 25148bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool wantsRegionChangeUpdate(ProgramStateRef state) const { 25152f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2516ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2517294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2518f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2519f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2520f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 25218bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek SymbolRef Sym, ProgramStateRef state) const; 2522f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 252338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 2524af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks void checkEndPath(CheckerContext &C) const; 252538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25268bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef updateSymbol(ProgramStateRef state, SymbolRef sym, 2527554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2528554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const; 2529e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 25308bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void processNonLeakError(ProgramStateRef St, SourceRange ErrorRange, 2531294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2532294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 25331a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25341a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void processObjCLiterals(CheckerContext &C, const Expr *Ex) const; 2535294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 253638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 253738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25388bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef handleSymbolDeath(ProgramStateRef state, 25398d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SymbolRef sid, RefVal V, 25408d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SmallVectorImpl<SymbolRef> &Leaked) const; 254138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25428bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ExplodedNode *, ProgramStateRef > 25432bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose handleAutoreleaseCounts(ProgramStateRef state, ExplodedNode *Pred, 25442bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag, CheckerContext &Ctx, 25452bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose SymbolRef Sym, RefVal V) const; 25468d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 25478bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *processLeaks(ProgramStateRef state, 254838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 25496a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 255038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2551d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2552d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2553d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 25546704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 25556704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 25568bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 25576704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 25588bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek StopTrackingCallback(ProgramStateRef st) : state(st) {} 25598bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return state; } 25606704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25616704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 25626704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 25636704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 25646704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 25656704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 25666704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 25676704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2568910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2569910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2570910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 25716704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2572910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2573910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2574dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2575910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2576dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2577469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 257838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2579dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 25808bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 258138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 25825eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek cast<BlockDataRegion>(state->getSVal(BE, 25835eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsRegion()); 2584dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 258638cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2587dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 258938cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2590dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 259167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 259267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 259367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 25945f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 259539ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2596c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2597dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 259867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 259967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion *VR = *I; 260067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 260167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 260267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 260367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 260467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2605dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 260667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 260767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 260867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 26090bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 261038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 261138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2612910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2613910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2614f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2615f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2616f85e193739c953358c865005855253af4f68a497John McCall return; 2617f85e193739c953358c865005855253af4f68a497John McCall 261871c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2619f85e193739c953358c865005855253af4f68a497John McCall 2620f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2621f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2622f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2623f85e193739c953358c865005855253af4f68a497John McCall return; 2624f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2625f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2626f85e193739c953358c865005855253af4f68a497John McCall break; 2627f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2628f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2629f85e193739c953358c865005855253af4f68a497John McCall break; 2630f85e193739c953358c865005855253af4f68a497John McCall } 2631f85e193739c953358c865005855253af4f68a497John McCall 26328bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26335eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CE, C.getLocationContext()).getAsLocSymbol(); 2634f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2635f85e193739c953358c865005855253af4f68a497John McCall return; 26368d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* T = getRefBinding(state, Sym); 2637f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2638f85e193739c953358c865005855253af4f68a497John McCall return; 2639f85e193739c953358c865005855253af4f68a497John McCall 2640f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 264117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2642f85e193739c953358c865005855253af4f68a497John McCall 2643f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2644e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2645e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2646f85e193739c953358c865005855253af4f68a497John McCall return; 2647f85e193739c953358c865005855253af4f68a497John McCall } 2648f85e193739c953358c865005855253af4f68a497John McCall 26490bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 2650f85e193739c953358c865005855253af4f68a497John McCall} 2651f85e193739c953358c865005855253af4f68a497John McCall 26521a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::processObjCLiterals(CheckerContext &C, 26531a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Expr *Ex) const { 26541a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ProgramStateRef state = C.getState(); 26551a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const ExplodedNode *pred = C.getPredecessor(); 26561a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek for (Stmt::const_child_iterator it = Ex->child_begin(), et = Ex->child_end() ; 26571a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek it != et ; ++it) { 26581a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Stmt *child = *it; 26591a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal V = state->getSVal(child, pred->getLocationContext()); 26601a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = V.getAsSymbol()) 26618d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal* T = getRefBinding(state, sym)) { 26621a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek RefVal::Kind hasErr = (RefVal::Kind) 0; 26631a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = updateSymbol(state, sym, *T, MayEscape, hasErr, C); 26641a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (hasErr) { 26651a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processNonLeakError(state, child->getSourceRange(), hasErr, sym, C); 26661a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek return; 26671a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26681a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26701a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26711a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Return the object as autoreleased. 26721a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // RetEffect RE = RetEffect::MakeNotOwned(RetEffect::ObjC); 26731a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = 26741a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state->getSVal(Ex, pred->getLocationContext()).getAsSymbol()) { 26751a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek QualType ResultTy = Ex->getType(); 26768d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, sym, 26778d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks RefVal::makeNotOwned(RetEffect::ObjC, ResultTy)); 26781a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26791a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26801a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek C.addTransition(state); 26811a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 26821a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26831a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCArrayLiteral *AL, 26841a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 26851a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all values. 26861a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, AL); 26871a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 26881a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCDictionaryLiteral *DL, 26901a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 26911a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all keys and values. 26921a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, DL); 26931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 26941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 269570fdbc366da85880aae5baebd3351e993ca05603Jordy Rosevoid RetainCountChecker::checkPostStmt(const ObjCBoxedExpr *Ex, 269670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose CheckerContext &C) const { 269770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ExplodedNode *Pred = C.getPredecessor(); 269870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const LocationContext *LCtx = Pred->getLocationContext(); 269970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose ProgramStateRef State = Pred->getState(); 270070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 270170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (SymbolRef Sym = State->getSVal(Ex, LCtx).getAsSymbol()) { 270270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose QualType ResultTy = Ex->getType(); 27038d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks State = setRefBinding(State, Sym, 27048d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks RefVal::makeNotOwned(RetEffect::ObjC, ResultTy)); 270570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 270670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 270770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose C.addTransition(State); 270870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 270970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2710fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rosevoid RetainCountChecker::checkPostCall(const CallEvent &Call, 2711fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose CheckerContext &C) const { 2712fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2713fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose const RetainSummary *Summ = Summaries.getSummary(Call, C.getState()); 2714554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2715554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (C.wasInlined) { 2716554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks processSummaryOfInlined(*Summ, Call, C); 2717554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return; 2718554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2719fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose checkSummary(*Summ, Call, C); 2720294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2721294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2722910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2723910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2724bed28ac1d1463adca3ecf24fca5c30646fa9dbb2Sylvestre Ledru/// While the return type can be queried directly from RetEx, when 2725910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2726910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2727910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2728910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2729910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2730910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2731910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2732910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2733910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2734910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2735910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2736910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2737910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2738910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2739910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2740910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2741910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2742910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2743910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2744910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2745910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2746910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2747910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2748910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2749910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2750554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// We don't always get the exact modeling of the function with regards to the 2751554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// retain count checker even when the function is inlined. For example, we need 2752554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// to stop tracking the symbols which were marked with StopTrackingHard. 2753554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaksvoid RetainCountChecker::processSummaryOfInlined(const RetainSummary &Summ, 2754554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const CallEvent &CallOrMsg, 2755554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const { 2756554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ProgramStateRef state = C.getState(); 2757554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2758554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Evaluate the effect of the arguments. 2759554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2760554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Summ.getArg(idx) == StopTrackingHard) { 2761554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks SVal V = CallOrMsg.getArgSVal(idx); 2762554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (SymbolRef Sym = V.getAsLocSymbol()) { 2763554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2764554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2765554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2766554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2767554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2768554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Evaluate the effect on the message receiver. 2769554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const ObjCMethodCall *MsgInvocation = dyn_cast<ObjCMethodCall>(&CallOrMsg); 2770554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (MsgInvocation) { 2771554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (SymbolRef Sym = MsgInvocation->getReceiverSVal().getAsLocSymbol()) { 2772554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Summ.getReceiverEffect() == StopTrackingHard) { 2773554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2774554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2775554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2776554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2777554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2778554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Consult the summary for the return value. 2779554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks RetEffect RE = Summ.getRetEffect(); 2780554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (RE.getKind() == RetEffect::NoRetHard) { 2781554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 2782554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks C.getLocationContext()).getAsSymbol(); 2783554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Sym) 2784554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2785554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2786554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2787554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks C.addTransition(state); 2788554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks} 2789554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2790910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 27914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &CallOrMsg, 2792910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 27938bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2794294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2795294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2796294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2797294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2798294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2799294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2800294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2801537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2802294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2803294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 28048d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(state, Sym)) { 280517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2806294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2807294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2808294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2809294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2810294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2811294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2812294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2813294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2814294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2815294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2816294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 28174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!hasErr) { 2818cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCMethodCall *MsgInvocation = dyn_cast<ObjCMethodCall>(&CallOrMsg); 28194531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (MsgInvocation) { 28204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (SymbolRef Sym = MsgInvocation->getReceiverSVal().getAsLocSymbol()) { 28218d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(state, Sym)) { 28224531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverIsTracked = true; 28234531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 2824554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks hasErr, C); 28254531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (hasErr) { 28268919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ErrorRange = MsgInvocation->getOriginExpr()->getReceiverRange(); 28274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ErrorSym = Sym; 28284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 2829294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2830294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2831294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2832294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2833294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2834294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2835294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2836294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2837294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2838294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2839294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2840294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2841294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2842294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2843294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2844b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 284517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2846b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2847294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2848294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2849294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2850294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2851294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 28527530c034c0c71a64c5a9173206d9742ae847af8bDavid Blaikie llvm_unreachable("Unhandled RetEffect."); 2853294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2854294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2855554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case RetEffect::NoRetHard: 2856294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2857294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2858294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2859294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2860294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 28615eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 28625eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsSymbol(); 2863294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2864294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2865294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 28664531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // Use the result type from the CallEvent as it automatically adjusts 2867294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 28684531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose QualType ResultTy = CallOrMsg.getResultType(); 28698d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, RefVal::makeOwned(RE.getObjKind(), 28708d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks ResultTy)); 2871294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2872294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2873c6ba23f207410efcaf93132790218b9f9bcebe43Anna Zaks // *not* fail. 2874294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2875294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2876294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2877294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2878294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2879294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2880294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 28815eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(Ex, C.getLocationContext()).getAsSymbol(); 2882294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2883294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2884294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2885294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2886294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 28878d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, RefVal::makeNotOwned(RE.getObjKind(), 28888d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks ResultTy)); 2889294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2890294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2891294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2892294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2893294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2894294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2895294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2896294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2897294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2898294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2899294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 29000bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks NewNode = C.addTransition(state); 2901294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2902294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 29039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 29049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 29059c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 29069c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 29079c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 29089c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 29099c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2910ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 29119c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2912294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2913294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2914e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 29158bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 29168bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::updateSymbol(ProgramStateRef state, SymbolRef sym, 2917910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2918910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2919e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2920910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 292117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 292217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 29234e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie IgnoreRetainMsg = (bool)C.getASTContext().getLangOpts().ObjCAutoRefCount; 292417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2925e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 29264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose default: 29274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRefMsg: 29294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? DoNothing : IncRef; 29304531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29314531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsg: 29324531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? DoNothing : DecRef; 29334531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 2934554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefMsgAndStopTrackingHard: 2935554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks E = IgnoreRetainMsg ? StopTracking : DecRefAndStopTrackingHard; 29364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29374531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MakeCollectable: 29384531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = C.isObjCGCEnabled() ? DecRef : DoNothing; 29394531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29404531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case NewAutoreleasePool: 29414531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = C.isObjCGCEnabled() ? DoNothing : NewAutoreleasePool; 29424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 2943e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2944e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2945e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 294617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2947e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2948e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 29498d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 2950e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2951e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2952e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2953e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2954e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2955e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 2956554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefMsgAndStopTrackingHard: 2957e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2958e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2959e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2960e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 296117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2962e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2963e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2964e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2965e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2966e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2967e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2968e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2969e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2970e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2971e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2972e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2973e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 29748d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 2975e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2976e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2977e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2978e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2979e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2980e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2981e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2982e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case NewAutoreleasePool: 298317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!C.isObjCGCEnabled()); 2984c95bb76e85ff9a37de23821f713d947dcbc98f35Anna Zaks return state; 2985e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2986e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 2987e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 2988e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2989e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2990e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2991e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2992e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2993e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2994e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 2995e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2996e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2997e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 299817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 2999e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 3000e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 3001e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 3002e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3003e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3004e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 3005554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case StopTrackingHard: 30068d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 3007e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3008e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 3009e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3010e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3011e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 3012e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3013e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 3014e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 3015e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3016e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3017e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 301817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3019e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 3020e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3021e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3022e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3023e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3024e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 3025e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 3026554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefAndStopTrackingHard: 3027e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3028e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3029e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 3030e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 3031e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3032e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3033e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 3034e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 3035e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 3036e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 3037554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks else if (E == DecRefAndStopTrackingHard) 30388d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 30394531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 3040e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3041e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3042e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3043e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 30444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (V.getCount() > 0) { 3045554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (E == DecRefAndStopTrackingHard) 30468d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 3047e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 30484531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } else { 3049e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 3050e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3051e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3052e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3053e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3054e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3055e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 305617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3057e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 3058e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3059e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3060e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3061e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3062e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 30638d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 3064e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 3065e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 30668bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::processNonLeakError(ProgramStateRef St, 3067910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 3068910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 3069910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 3070910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3071294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 3072294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 3073294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 3074294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3075294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 3076294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 3077294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 3078294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 3079294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 3080d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 3081d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 3082d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 3083294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3084294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 3085d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 3086d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 3087d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 3088294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3089294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 3090d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 3091d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 3092d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 3093294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3094294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 3095d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 3096d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 3097d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 3098294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3099294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3100294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3101d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 31024e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOpts(), 310317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 310417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 3105294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 3106294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.EmitReport(report); 3107294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 3108294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3109910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3110910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 3111910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3112910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3113910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 311476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 31158bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3116b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *FD = C.getCalleeDecl(CE); 311776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 311876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 311976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 312076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 312176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 312276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 312376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 312476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 312576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 312676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 312776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 312876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 312976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 313076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 313176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 313276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 313376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 313476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 313576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 313676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 313776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3138b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks QualType ResultTy = CE->getCallReturnType(); 313976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 314076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 314176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 314276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 314376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 314476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 314576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 314676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 314776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 314876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 314976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 315076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 315176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 315276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 315376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 315476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 315576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 31565eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = C.getLocationContext(); 31575eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal RetVal = state->getSVal(CE->getArg(0), LCtx); 315876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 315976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 316076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 316166c486f275531df6362b3511fc3af6563561801bTed Kremenek RetVal = SVB.conjureSymbolVal(0, CE, LCtx, ResultTy, C.blockCount()); 316276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 31635eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal, false); 316476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3165294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3166294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3167294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3168294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3169294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 31708d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *Binding = 0; 3171294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 31728d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks Binding = getRefBinding(state, Sym); 317376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3174294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 317566c486f275531df6362b3511fc3af6563561801bTed Kremenek state = state->invalidateRegions(ArgRegion, CE, C.blockCount(), LCtx); 317676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3177294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3178294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 31798d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, *Binding); 3180294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3181294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 31820bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 318376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 318476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 318576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3186910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3187910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3188910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3189f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3190e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek// Return true if the current LocationContext has no caller context. 3191e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenekstatic bool inTopFrame(CheckerContext &C) { 3192e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek const LocationContext *LC = C.getLocationContext(); 3193e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return LC->getParent() == 0; 3194e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek} 3195e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3196910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3197910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3198e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3199e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // Only adjust the reference count if this is the top-level call frame, 3200e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // and not the result of inlining. In the future, we should do 3201e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // better checking even for inlined calls, and see if they match 3202e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // with their expected semantics (e.g., the method should return a retained 3203e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // object, etc.). 3204e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek if (!inTopFrame(C)) 3205e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return; 3206e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3207f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3208f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3209f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3210f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32118bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 32125eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = 32135eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state->getSValAsScalarOrLoc(RetE, C.getLocationContext()).getAsLocSymbol(); 3214f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3215f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3216f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3217f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 32188d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *T = getRefBinding(state, Sym); 3219f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3220f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3221f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3222f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3223f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3224f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3225f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3226f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3227f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3228f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3229f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3230f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3231f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3232f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3233f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3234f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3235f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3236f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3237f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3238f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3239f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3240f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3241f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3242f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3243f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3244f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3245f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3246f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3247f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3248f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3249f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3250f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 32518d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X); 32520bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *Pred = C.addTransition(state); 3253f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3254f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3255f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3256f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3257f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3258f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3259f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3260f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3261f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3262f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3263f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3264910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 32652bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Pred, &AutoreleaseTag, 32662bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose C, Sym, X); 3267f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3268f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 32698d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!Pred) 3270f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3271f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3272f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 32738d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks T = getRefBinding(state, Sym); 3274f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3275f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3276f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3277f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 327817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3279f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 32804531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetEffect RE = RetEffect::MakeNoRet(); 3281f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32824531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: What is the convention for blocks? Is there one? 3283f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3284b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 32854531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = Summ->getRetEffect(); 32864531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 32874531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!isa<CXXMethodDecl>(FD)) { 32884531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ = Summaries.getFunctionSummary(FD); 32894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = Summ->getRetEffect(); 32904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 3291f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3292f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3294f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3295f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3296910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3297910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3298910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3299910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3300910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 33018bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state) const { 3302f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3303f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3304f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3305f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 330617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3307f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3308f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3309f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3310f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3311f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3312f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3313f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3314f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3315f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3316f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3317f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3318f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3319f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3320f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3321f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3322f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3323f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 33248d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X); 3325f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3326f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3327910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 33280bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnOwnLeakTag); 3329f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 33304e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = C.getASTContext().getLangOpts(); 333117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3332f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 333317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 333417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 33356a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks N, Sym, C); 3336f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3337f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3338f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3339f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3340f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3341f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3342f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3343f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 33448d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X ^ RefVal::ErrorReturnedNotOwned); 3345f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3346f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3347910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 33480bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnNotOwnedTag); 3349f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3350d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3351d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3352d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3353f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3354d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 33554e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie C.getASTContext().getLangOpts(), 335617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3357f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3358f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3359f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3360f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3361f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3362f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33638d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3364910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3365910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3366910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3367390909c89c98ab1807e15e033a72e975f866fb23Anna Zaksvoid RetainCountChecker::checkBind(SVal loc, SVal val, const Stmt *S, 3368910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3369910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3370910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3371910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3372910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3373910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3374910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3375910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3376910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3377910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 33788bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3379910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3380910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (loc::MemRegionVal *regionLoc = dyn_cast<loc::MemRegionVal>(&loc)) { 3381910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3382910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3383910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3384910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3385910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3386910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3387e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // Do this only if we know that the store is not supposed to generate the 3388e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // same state. 3389e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks SVal StoredVal = state->getSVal(regionLoc->getRegion()); 3390e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks if (StoredVal != val) 3391e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks escapes = (state == (state->bindLoc(*regionLoc, val))); 3392910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3393de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek if (!escapes) { 3394de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // Case 4: We do not currently model what happens when a symbol is 3395de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // assigned to a struct field, so be conservative here and let the symbol 3396de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // go. TODO: This could definitely be improved upon. 3397de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek escapes = !isa<VarRegion>(regionLoc->getRegion()); 3398de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek } 3399910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3400910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3401910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3402910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3403910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3404910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3405910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3406910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3407910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3408910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3409910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 34100bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 3411910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3412910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34138bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef RetainCountChecker::evalAssume(ProgramStateRef state, 3414910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3415910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3416910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3417910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3418910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3419910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3420910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3421910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3422910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3423910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings B = state->get<RefBindings>(); 3424910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3425910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3426910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3427910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3428910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3429910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings::Factory &RefBFactory = state->get_context<RefBindings>(); 3430910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3431910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3432910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Check if the symbol is null (or equal to any constant). 3433910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If this is the case, stop tracking the symbol. 3434910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (state->getSymVal(I.getKey())) { 3435910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3436910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3437910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3438910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3439910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3440910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3441910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3442910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3443910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3444910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3445910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34468bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 34478bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::checkRegionChanges(ProgramStateRef state, 3448910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 3449910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 345066c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 3451740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const { 3452910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3453910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3454910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3455910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3456910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3457910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3458910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3459910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3460910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3461910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3462910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (StoreManager::InvalidatedSymbols::const_iterator I=invalidated->begin(), 3463910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3464910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3465910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3466910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3467910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 34688d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = removeRefBinding(state, sym); 3469910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3470910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3471910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3472910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3473910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 34748d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 34758d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 34768d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34778bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstd::pair<ExplodedNode *, ProgramStateRef > 34788bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleAutoreleaseCounts(ProgramStateRef state, 34796a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred, 34802bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag, 34816a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 3482910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 34838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 34848d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34858d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 34868d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 34878d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(Pred, state); 34888d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34896a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks assert(!Ctx.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 34908d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 34918d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34928d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 34938d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34948d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 34958d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 34968d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34978d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 34988d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 34998d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 35008d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 35018d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 35028d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 35038d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 35048d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 35058d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setCount(Cnt - ACnt); 35068d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 35078d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35088d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, V); 35092bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose ExplodedNode *N = Ctx.addTransition(state, Pred, Tag); 35108d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (N == 0) 35118d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = 0; 35128d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(N, state); 35138d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35148d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35158d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 35168d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 35178d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 35188d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, V); 35198d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3520fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose ExplodedNode *N = Ctx.generateSink(state, Pred, Tag); 35212bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose if (N) { 3522f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<128> sbuf; 35238d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 35248d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 35258d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 35268d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 35278d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 35288d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3529d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3530d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3531d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 35324e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35338d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3534d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3535d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 35366a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 35378d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35388d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35398bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek return std::make_pair((ExplodedNode *)0, (ProgramStateRef )0); 35408d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 354138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35428bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 35438bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleSymbolDeath(ProgramStateRef state, 3544910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 354538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 35465337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 354738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 354838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 354938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 355038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 355138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 355238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 35538d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sid); 355438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 355538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 35568d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sid, V ^ RefVal::ErrorLeak); 355738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 355838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 355938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 35608bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::processLeaks(ProgramStateRef state, 3561910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 35626a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 35636a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred) const { 356438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (Leaked.empty()) 356538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return Pred; 356638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 35682bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose ExplodedNode *N = Ctx.addTransition(state, Pred); 356938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 357138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 357238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 357338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35744e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35756a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks bool GCEnabled = Ctx.isObjCGCEnabled(); 357617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 357717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 357838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 35792058956954802229bf98604e8063fa57677abff4Jordy Rose 358017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 35816a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks SummaryLog, N, *I, Ctx); 35826a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 358338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 358438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 358538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 358638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 358738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 358838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3589af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaksvoid RetainCountChecker::checkEndPath(CheckerContext &Ctx) const { 35908bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Ctx.getState(); 359138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 3592af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred = Ctx.getPredecessor(); 359338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 359438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 35952bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Pred, /*Tag=*/0, 35962bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose Ctx, I->first, I->second); 35978d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 359838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 359938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 360038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36010cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // If the current LocationContext has a parent, don't check for leaks. 36020cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // We will do that later. 36038d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks // FIXME: we should instead check for imbalances of the retain/releases, 36040cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // and suggest annotations. 36050cf3d471546251b12bdceff360f66c079c40526cTed Kremenek if (Ctx.getLocationContext()->getParent()) 36060cf3d471546251b12bdceff360f66c079c40526cTed Kremenek return; 36070cf3d471546251b12bdceff360f66c079c40526cTed Kremenek 360838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 360938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 361038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 361138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) 36128d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 361338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36142bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose processLeaks(state, Leaked, Ctx, Pred); 361538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 361638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 361738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3618910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 361938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 362038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 3621f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<64> buf; 362238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3623f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks out << "RetainCountChecker : Dead Symbol : "; 3624f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks sym->dumpToStream(out); 362538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 362638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 362738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 362838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 362938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3630910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3631910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 363238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 363338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36348bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 363538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 363638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 363738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 363838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 363938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 364038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 364138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 364238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 364338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 36442bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag = getDeadSymbolTag(Sym); 36452bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Pred, Tag, C, 36468d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Sym, *T); 36478d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 364838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 364938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 365038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 365138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 365238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 365338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 365438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 365538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 365638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 365738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(*I)) 365838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = handleSymbolDeath(state, *I, *T, Leaked); 365938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 366038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36612bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose Pred = processLeaks(state, Leaked, C, Pred); 366238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 366338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 366438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 366538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 366638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 366738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 366838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings::Factory &F = state->get_context<RefBindings>(); 366938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 367138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) 367238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 367338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 36750bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state, Pred); 367638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 367738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36788bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::printState(raw_ostream &Out, ProgramStateRef State, 3679910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3680dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3681dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose RefBindings B = State->get<RefBindings>(); 3682dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3683dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3684dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3685dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3686dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3687dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3688dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3689dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3690dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3691dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3692dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3693dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3694910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 36956b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 36966b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 369717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3698910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 369917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 370017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3701