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)) { 9504a25f3056416aaffa7852985c2045634e5275876Jordan Rose if (IdentifierInfo *Name = FC->getDecl()->getIdentifier()) { 9514a25f3056416aaffa7852985c2045634e5275876Jordan Rose // When the CGBitmapContext is deallocated, the callback here will free 9524a25f3056416aaffa7852985c2045634e5275876Jordan Rose // the associated data buffer. 953a89f719ad3a7134e3eec7c9e03aa0e22031c0de9Jordan Rose if (Name->isStr("CGBitmapContextCreateWithData")) 954a89f719ad3a7134e3eec7c9e03aa0e22031c0de9Jordan Rose RE = S->getRetEffect(); 9554a25f3056416aaffa7852985c2045634e5275876Jordan Rose } 9564531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9574531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9584531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose S = getPersistentSummary(RE, RecEffect, DefEffect); 9594531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9605a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9615a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Special case '[super init];' and '[self init];' 9625a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // 9635a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Even though calling '[super init]' without assigning the result to self 9645a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // and checking if the parent returns 'nil' is a bad pattern, it is common. 9655a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Additionally, our Self Init checker already warns about it. To avoid 9665a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // overwhelming the user with messages from both checkers, we model the case 9675a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // of '[super init]' in cases when it is not consumed by another expression 9685a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // as if the call preserves the value of 'self'; essentially, assuming it can 9695a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // never fail and return 'nil'. 9705a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Note, we don't want to just stop tracking the value since we want the 9715a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // RetainCount checker to report leaks and use-after-free if SelfInit checker 9725a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // is turned off. 9735a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (const ObjCMethodCall *MC = dyn_cast<ObjCMethodCall>(&Call)) { 9745a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (MC->getMethodFamily() == OMF_init && MC->isReceiverSelfOrSuper()) { 9755a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9765a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Check if the message is not consumed, we know it will not be used in 9775a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // an assignment, ex: "self = [super init]". 9785a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks const Expr *ME = MC->getOriginExpr(); 9795a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks const LocationContext *LCtx = MC->getLocationContext(); 9805a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ParentMap &PM = LCtx->getAnalysisDeclContext()->getParentMap(); 9815a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (!PM.isConsumedExpr(ME)) { 9825a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks RetainSummaryTemplate ModifiableSummaryTemplate(S, *this); 9835a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ModifiableSummaryTemplate->setReceiverEffect(DoNothing); 9845a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ModifiableSummaryTemplate->setRetEffect(RetEffect::MakeNoRet()); 9855a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9865a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9875a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9885a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 9904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Roseconst RetainSummary * 9924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getSummary(const CallEvent &Call, 9934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State) { 9944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ; 9954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose switch (Call.getKind()) { 9964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_Function: 9974531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getFunctionSummary(cast<FunctionCall>(Call).getDecl()); 9984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 9994531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_CXXMember: 1000fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose case CE_CXXMemberOperator: 10014531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_Block: 10024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_CXXConstructor: 10038d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose case CE_CXXDestructor: 100470cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 10054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: These calls are currently unsupported. 10064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getPersistentStopSummary(); 10078919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case CE_ObjCMessage: { 1008cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCMethodCall &Msg = cast<ObjCMethodCall>(Call); 10094531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Msg.isInstanceMessage()) 10104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getInstanceMethodSummary(Msg, State); 10114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose else 10124531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getClassMethodSummary(Msg); 10134531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 10144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 10154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 10164531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 10174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose updateSummaryForCall(Summ, Call); 10184531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 10194531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Unknown call type?"); 10204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return Summ; 10214531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 10224531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 102358822c403cc8855adeecba92248612ee08dc1f3aAnna Zaksconst RetainSummary * 10244531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getFunctionSummary(const FunctionDecl *FD) { 10254531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we don't know what function we're calling, use our default summary. 10264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!FD) 10274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getDefaultSummary(); 10284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 1029891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 1030d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 1031d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 1032891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 1033891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 1034e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 103593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *S = 0; 103615d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose bool AllowAnnotations = true; 10371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103837d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 10391261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 10401261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 10411261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 10421261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 10431261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 10441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1045183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 104699890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 1047183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 104848c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 104948c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 105048c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 1051b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 1052b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 10531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1054bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 1055bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 1056b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 10571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10581261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 10591261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 10601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10611261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 10621261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 1063008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 1064e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1065befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek if (FName == "pthread_create" || FName == "pthread_setspecific") { 1066befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // Part of: <rdar://problem/7299394> and <rdar://problem/11282706>. 1067befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // This will be addressed better with IPA. 1068b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 1069b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 1070b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 1071b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 1072b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 1073b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 107415d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose // The headers on OS X 10.8 use cf_consumed/ns_returns_retained, 107515d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose // but we can fully model NSMakeCollectable ourselves. 107615d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose AllowAnnotations = false; 1077061707a86f20bf608758e7013df24bd1be12ffc6Ted Kremenek } else if (FName == "CFPlugInInstanceCreate") { 1078061707a86f20bf608758e7013df24bd1be12ffc6Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet()); 1079b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 1080b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 1081b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 1082537dd3a8c87765245aad792a3356852a87380a30Ted Kremenek FName == "IORegistryEntrySearchCFProperty" || 1083b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 1084b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 1085b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 1086b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 1087b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 1088b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 1089b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 1090b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 1091b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 1092b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 1093b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 10943baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 1095b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1096b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 1097b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 1098b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 1099b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 11003baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 1101b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1102b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 1103b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 1104b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 1105b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 1106b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 1107b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 1108b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 11093baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 1110b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1111b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 1112b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 1113b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 1114b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 1115b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 11163baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 1117b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 1118b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 1119b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 1120b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 1121b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 1122b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 1123b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 1124b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 11253baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 1126b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 112706911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek } else if (FName == "dispatch_set_context") { 112806911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // <rdar://problem/11059275> - The analyzer currently doesn't have 112906911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // a good way to reason about the finalizer function for libdispatch. 113006911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // If we pass a context object that is memory managed, stop tracking it. 113106911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // FIXME: this hack should possibly go away once we can handle 113206911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // libdispatch finalizers. 113306911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 113406911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1135c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } else if (FName.startswith("NSLog")) { 1136c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek S = getDoNothingSummary(); 113762a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks } else if (FName.startswith("NS") && 113862a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks (FName.find("Insert") != StringRef::npos)) { 113962a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // Whitelist NSXXInsertXX, for example NSMapInsertIfAbsent, since they can 114062a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // be deallocated by NSMapRemove. (radar://11152419) 114162a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 114262a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 2, StopTracking); 114362a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1144b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 11451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1146b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 1147b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 1148b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 114961991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 11501261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (RetTy->isPointerType()) { 1151e788365f513a579b03ff7f49296d5b95645ea3feTed Kremenek if (FD->getAttr<CFAuditedTransferAttr>()) { 1152e788365f513a579b03ff7f49296d5b95645ea3feTed Kremenek S = getCFCreateGetRuleSummary(FD); 1153e788365f513a579b03ff7f49296d5b95645ea3feTed Kremenek break; 1154e788365f513a579b03ff7f49296d5b95645ea3feTed Kremenek } 1155e788365f513a579b03ff7f49296d5b95645ea3feTed Kremenek 11561261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 115778acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 11581261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 11591261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 116076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 11611261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 11621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 11637df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 11641261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 116537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 116637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11671261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11681261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 116978acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 11701261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 11711261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 11721261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 11737df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 11741261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 117537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 117637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11771261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11781261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 117978acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 118078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 118178acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 11827df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1183706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1184706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 11851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11861261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 118737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11881261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11891261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 11901261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 11911261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1192e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1193b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1194e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1195bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 11961261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 11971261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1198b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11996818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 12006818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 12016818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 12026818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 12036818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 12041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 12056818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 12061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 12076818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 12086818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 12096818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1210c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1211c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1212c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1213c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1214e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1215e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1216e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1217e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1218c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 12196818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 12201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12216818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 12221261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 122364e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 122437d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 122537d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 12261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we got all the way here without any luck, use a default summary. 12284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!S) 12294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose S = getDefaultSummary(); 12304531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 12314dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 123215d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose if (AllowAnnotations) 123315d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose updateSummaryFromAnnotations(S, FD); 12341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1235d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 12361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 12372fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 12382fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 123993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12407df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 12417df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 124286ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 12431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1244d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 124500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 124600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 124793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12486ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 12496ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 12506ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 12511261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 12521261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 125372564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 12541261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 12551261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 12561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1257b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 12581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 125976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1260377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 126176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 126276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 126376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 1264940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 126576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 126676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 126776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 126800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 126900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 127093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12719c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1272b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 12731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12742d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 127500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 127600a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 127793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12789c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 12791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 12802d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 12812d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 128200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 128300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 12846b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1285d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1286d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1287d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 12884dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 128993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 12904dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 12914dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 12924dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 12934dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 12944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Must have a summary to add annotations to."); 12954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate Template(Summ, *this); 12964df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 129711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 129811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 129911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 130098b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 130111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 130211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 13034df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 13040fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 13054df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 13064df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 13070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 130811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 130911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 131011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1311b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 13121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13134dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 131478acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 131540b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 13160fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 13174dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 131840b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 13190fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1320b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 13216041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>()) { 13220fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 13236041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13246041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 13250fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 13266041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13274df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (RetTy->getAs<PointerType>()) { 132840b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 13290fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 13304dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1331d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 13320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1333d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 13344dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 13354dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 13364dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 13374dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 133893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 133993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD) { 13404dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 13414dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 13424dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 13434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Must have a valid summary to add annotations to"); 13444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate Template(Summ, *this); 13456d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 13461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 134712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 134812b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 134911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 13500fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 135111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 135211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 135311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 135411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1355491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1356491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 135711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 135811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 135911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 136011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 13610fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 136211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 136311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 13640fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 136511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 136612b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 136712b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 13684dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 136978acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 137040b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 13710fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 13726d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 13734dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 13746041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>()) { 13750fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 13766041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 13776041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13796d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 13800fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 13816217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 13820fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 13831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13846041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 13856041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 13860fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 13876041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 13880fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 13896041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13904dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 13914dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 139293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1393f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy RoseRetainSummaryManager::getStandardMethodSummary(const ObjCMethodDecl *MD, 1394f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Selector S, QualType RetTy) { 1395e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Any special effects? 13968ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 1397e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetEffect ResultEff = RetEffect::MakeNoRet(); 1398e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose 1399e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Check the method family, and apply any default annotations. 1400e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (MD ? MD->getMethodFamily() : S.getMethodFamily()) { 1401e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_None: 1402e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_performSelector: 1403e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Assume all Objective-C methods follow Cocoa Memory Management rules. 1404e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // FIXME: Does the non-threaded performSelector family really belong here? 1405e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // The selector could be, say, @selector(copy). 1406e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1407e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::ObjC); 1408e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) { 1409e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // ObjCMethodDecl currently doesn't consider CF objects as valid return 1410e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // values for alloc, new, copy, or mutableCopy, so we have to 1411e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // double-check with the selector. This is ugly, but there aren't that 1412e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // many Objective-C methods that return CF objects, right? 1413e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (MD) { 1414e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (S.getMethodFamily()) { 1415e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1416e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1417e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1418e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1419e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1420e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1421e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose default: 1422e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1423e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1424e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1425e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } else { 1426e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1427e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1428e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1429e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1430e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_init: 1431e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCInitRetE; 1432e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1433e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1434e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1435e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1436e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1437e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1438e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1439e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCAllocRetE; 1440e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) 1441e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1442e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1443e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_autorelease: 1444e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Autorelease; 1445e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1446e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retain: 1447e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = IncRefMsg; 1448e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1449e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_release: 1450e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1451e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1452e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_dealloc: 1453e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Dealloc; 1454e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1455e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_self: 1456e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // -self is handled specially by the ExprEngine to propagate the receiver. 1457e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1458e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retainCount: 1459e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_finalize: 1460e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // These methods don't return objects. 1461e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1462e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 14631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14648ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 14658ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 14668ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 14678ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 14688ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 146950571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose for (unsigned i = 0, e = S.getNumArgs(); i != e; ++i) { 147050571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose StringRef Slot = S.getNameForSlot(i); 147150571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (Slot.substr(Slot.size() - 8).equals_lower("delegate")) { 147250571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (ResultEff == ObjCInitRetE) 1473554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ResultEff = RetEffect::MakeNoRetHard(); 147450571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose else 1475554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ReceiverEff = StopTrackingHard; 147650571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 147750571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 14788ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 14791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1480e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing && 1481e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff.getKind() == RetEffect::NoRet) 148293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 14831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1484e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose return getPersistentSummary(ResultEff, ReceiverEff, MayEscape); 1485250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1486250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 148793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1488cde8cdbd6a662c636164465ad309b5f17ff01064Jordan RoseRetainSummaryManager::getInstanceMethodSummary(const ObjCMethodCall &Msg, 14894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State) { 14904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCInterfaceDecl *ReceiverClass = 0; 14914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 14924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // We do better tracking of the type of the object than the core ExprEngine. 14934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // See if we have its type in our private state. 14944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: Eventually replace the use of state->get<RefBindings> with 14954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // a generic API for reasoning about the Objective-C types of symbolic 14964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // objects. 14974531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose SVal ReceiverV = Msg.getReceiverSVal(); 14984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (SymbolRef Sym = ReceiverV.getAsLocSymbol()) 14998d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(State, Sym)) 15004531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const ObjCObjectPointerType *PT = 1501b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 15024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverClass = PT->getInterfaceDecl(); 1503dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 15044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we don't know what kind of object this is, fall back to its static type. 15054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!ReceiverClass) 15064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverClass = Msg.getReceiverInterface(); 150704badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1508b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1509b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 15104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // id x = [NSObject class]; 15114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // [x performSelector:... withObject:... afterDelay:...]; 15124531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Selector S = Msg.getSelector(); 15134531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCMethodDecl *Method = Msg.getDecl(); 15144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!Method && ReceiverClass) 15154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Method = ReceiverClass->getInstanceMethod(S); 15164531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 15174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(S, ReceiverClass, Method, Msg.getResultType(), 15184531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ObjCMethodSummaries); 1519b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1520b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 152193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 15224531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getMethodSummary(Selector S, const ObjCInterfaceDecl *ID, 1523f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, QualType RetTy, 1524f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries) { 15251bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 15268711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 15274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ = CachedSummaries.find(ID, S); 15281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1529614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1530f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Summ = getStandardMethodSummary(MD, S, RetTy); 15314df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1532614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 15334df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 15344df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1535614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 15364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose CachedSummaries[ObjCSummaryKey(ID, S)] = Summ; 1537614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 15381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1539e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1540c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1541c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 15421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1543ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 15441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 15456fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 15462d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 15471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15486d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 15493baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 15506fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 15516fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 15526fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 15539c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 15549c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 15551f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 15561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 15581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1559c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1560c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 156193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1562ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1563ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1564ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1565ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1566ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1567ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 15681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1569c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 157093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 157193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *CFAllocSumm = 1572a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 15731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15743c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1575500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 157693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1577553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 15781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15793c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1580500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1581553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 15821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1583299e8158d63d69830cca0187f4003cba1e66081fTed Kremenek // Create the "drain" selector. 1584500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, isGCEnabled() ? DoNothing : DecRef); 1585553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); 15861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1587f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1588500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1589f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 15903c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 15913c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1592500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1593553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 15941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1595f9a8e2e1cf087c1720397e3d6d0c9b77a18787efTed Kremenek // Specially handle NSAutoreleasePool. 15966c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek addInstMethSummary("NSAutoreleasePool", "init", 1597500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose getPersistentSummary(NoRet, NewAutoreleasePool)); 15981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 160089e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 160189e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 160289e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 160389e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 16043aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 160593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 160678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 160778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 16081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 160999d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 161099d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 1611179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1612179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 161399d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 161499d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 161599d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 16161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1617ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // Don't track allocated autorelease pools yet, as it is okay to prematurely 1618ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1619ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1620a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek addClassMethSummary("NSAutoreleasePool", "allocWithZone", NoTrackYet, false); 1621553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1622767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1623767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1624767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1625767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1626767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1627767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1628211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1629a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1630a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1631a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1632767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1633a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 16341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1635a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1636211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1637b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1638b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1639d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1640c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1641c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1642c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1643ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1644ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1645ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1646c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1647c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 16481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 16491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1650ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1651c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 165235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 16536fd4505ad67a186da8cc26fdb493c93fe4937555Ted Kremenek : BugType(name, categories::MemoryCoreFoundationObjectiveC) {} 1654c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1656c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 165735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 16581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1659c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1660c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1662ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1663c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 166435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 166635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1667c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1669c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1671ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1672c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 167335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 16741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 167535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1676bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1677bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1678b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1679c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1681ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1682c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 168335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 168435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 16851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1686c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1687369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 16881499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1689c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1691ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1692c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 169335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 169435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 16951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1696c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1697c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 169800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 16991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 17001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1701ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1702369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 170335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 170435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 17051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1706369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1707eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1708369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1709369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 17101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1711ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1712e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 171335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 171435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 17151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1716e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 17175b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1718e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1719e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1720e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 17211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1722ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1723facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer public: 1724facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer Leak(StringRef name) 1725facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer : CFRefBug(name) { 1726db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1727db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1728db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 17291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 173035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 17311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1732c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1733c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1735c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1736c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1737c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 17381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1739011534973e83db51f49098871186238fc64d5f54Jordy Rose class CFRefReportVisitor : public BugReporterVisitorImpl<CFRefReportVisitor> { 174023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1741dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1742ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 174335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 174423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1745dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 174635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 174735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1748dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 174923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1750dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1751dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1752dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1753dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1754dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 175523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 175623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 175723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 175823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 175923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 176023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 176123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 176223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 176323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 176423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 176523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 176623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 176735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1768ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 176935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 177023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 177123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 177223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 177323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1774011534973e83db51f49098871186238fc64d5f54Jordy Rose 1775011534973e83db51f49098871186238fc64d5f54Jordy Rose virtual BugReporterVisitor *clone() const { 1776011534973e83db51f49098871186238fc64d5f54Jordy Rose // The curiously-recurring template pattern only works for one level of 1777011534973e83db51f49098871186238fc64d5f54Jordy Rose // subclassing. Rather than make a new template base for 1778011534973e83db51f49098871186238fc64d5f54Jordy Rose // CFRefReportVisitor, we simply override clone() to do the right thing. 1779011534973e83db51f49098871186238fc64d5f54Jordy Rose // This could be trouble someday if BugReporterVisitorImpl is ever 1780011534973e83db51f49098871186238fc64d5f54Jordy Rose // used for something else besides a convenient implementation of clone(). 1781011534973e83db51f49098871186238fc64d5f54Jordy Rose return new CFRefLeakReportVisitor(*this); 1782011534973e83db51f49098871186238fc64d5f54Jordy Rose } 1783dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1784dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1785e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 17862058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 178735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1788c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17892058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17902058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17912058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1792edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 179323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 17942058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17952058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1796dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1797eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 17982058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17992058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 18002058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1801edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 18022058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 18032058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1804dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 18051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1806e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1807edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1808edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1809e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1810c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1811640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1812c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1813c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1814eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1815ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1816c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 181723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1818c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 18192058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 18202058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 18216a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx); 18221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1823590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1824590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1825590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1826590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 18271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 18285216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 18295216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 18302058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 18312058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1832f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 18331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1834e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 18357f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 18362058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 183735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 183835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18407f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 18412058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 184235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 184335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18457f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 18462058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 184735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 184835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 184935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 185035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 185135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 185235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 185335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 185435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 185535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18567f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1857c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 185835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1859f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 186035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1861c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1862e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1863910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18645f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1865c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18665f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1867c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1868c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 18691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1870c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1871c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1872c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 187370fdbc366da85880aae5baebd3351e993ca05603Jordy Rosestatic bool isNumericLiteralExpression(const Expr *E) { 187470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // FIXME: This set of cases was copied from SemaExprObjC. 187570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose return isa<IntegerLiteral>(E) || 187670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CharacterLiteral>(E) || 187770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<FloatingLiteral>(E) || 187870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<ObjCBoolLiteralExpr>(E) || 187970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CXXBoolLiteralExpr>(E); 188070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 188170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 1882dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1883dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1884dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1885dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 188628038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // FIXME: We will eventually need to handle non-statement-based events 188728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // (__attribute__((cleanup))). 1888f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!isa<StmtPoint>(N->getLocation())) 18892033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 18901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18918966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 18928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef PrevSt = PrevN->getState(); 18938bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef CurrSt = N->getState(); 18945eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = N->getLocationContext(); 18951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18968d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* CurrT = getRefBinding(CurrSt, Sym); 1897c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 18981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1899b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 19008d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *PrevT = getRefBinding(PrevSt, Sym); 19011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1902c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1903c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1904c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1905c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 19061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1907c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1908c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1909c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 1910f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 19111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19121a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (isa<ObjCArrayLiteral>(S)) { 19131a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSArray literal is an object with a +0 retain count"; 19141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 19151a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else if (isa<ObjCDictionaryLiteral>(S)) { 19161a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSDictionary literal is an object with a +0 retain count"; 1917c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 191870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else if (const ObjCBoxedExpr *BL = dyn_cast<ObjCBoxedExpr>(S)) { 191970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (isNumericLiteralExpression(BL->getSubExpr())) 192070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "NSNumber literal is an object with a +0 retain count"; 192170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else { 192270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ObjCInterfaceDecl *BoxClass = 0; 192370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (const ObjCMethodDecl *Method = BL->getBoxingMethod()) 192470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose BoxClass = Method->getClassInterface(); 192570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 192670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // We should always be able to find the boxing class interface, 192770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // but consider this future-proofing. 192870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (BoxClass) 192970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << *BoxClass << " b"; 193070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else 193170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "B"; 193270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 193370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "oxed expression produces an object with a +0 retain count"; 193470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 193570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 19361a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19371a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 19381a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Get the name of the callee (if it is available). 19391a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee(), LCtx); 19401a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 19411a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "Call to function '" << *FD << '\''; 19421a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else 19431a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "function call"; 19441a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19451a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19468919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose assert(isa<ObjCMessageExpr>(S)); 1947d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &Mgr = CurrSt->getStateManager().getCallEventManager(); 1948d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<ObjCMethodCall> Call 1949d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = Mgr.getObjCMethodCall(cast<ObjCMessageExpr>(S), CurrSt, LCtx); 1950d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 1951d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose switch (Call->getMessageKind()) { 19528919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Message: 19538919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Method"; 19548919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19558919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_PropertyAccess: 19568919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Property"; 19578919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19588919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Subscript: 19598919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Subscript"; 19608919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19618919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 19621a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19641a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 19651a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns a Core Foundation object with a "; 19661a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19671a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19681a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 19691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns an Objective-C object with a "; 19701a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19721a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.isOwned()) { 19731a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+1 retain count"; 19741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19751a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (GCEnabled) { 19761a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 19771a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << ". " 19781a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek "Core Foundation objects are not automatically garbage collected."; 19791a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19801a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19811a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19821a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.isNotOwned()); 19831a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+0 retain count"; 1984c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1985cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1987220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 1988220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 1989c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 1990cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1992c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 1993c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 19945f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 19951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1996ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 1997ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 1998c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 1999c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 2000f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 20011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20025f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 2003c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 2004c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 2005c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 20061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20075f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 2008c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 20091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2010c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 2011c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 20125eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI, LCtx).getAsLocSymbol() != Sym) 2013c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 20141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2015c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 2016c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 2017c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2018c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 202004badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 20215eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver, LCtx) 20225eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek .getAsLocSymbol() == Sym) { 2023c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 2024c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 2025c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2026c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20271c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 20281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2029c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 2030c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 2031c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 20321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2033c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 203435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 2035c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2036c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 2037c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 2038c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 2039c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2040f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 2041c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 2042f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 2043f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 2044c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2046c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 2047c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 2048c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 2049f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 20505eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = 20515eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee(), LCtx); 20529c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 20531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 205435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 2055c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2056c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 20571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2058b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "In GC mode a call to '" << *FD 2059c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 2060c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 20611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2062c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2063c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 2064c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 2065c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 2066c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2067c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2068c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 2069c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 2070c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 20713eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 20721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 2073b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "When GC is not enabled a call to '" << *FD 2074c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 20751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2076c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 2077c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2078c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 2081c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 2082c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 20831ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 20841ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 20851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2086f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 2087f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 2088f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 2089f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 20901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2091264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 2092eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 2093f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 2094f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 20951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2096c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 2097c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 2098c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2099c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 21001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2101c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 2102c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 21031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2104c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 210535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 210674b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << " The object is not eligible for garbage collection until " 210774b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "the retain count reaches 0 again."; 2108c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2110c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21121ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2113c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 21141ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 21151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2116c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 211774b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose // Autoreleases can be applied after marking a node ReturnedOwned. 211874b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose if (CurrV.getAutoreleaseCount()) 211974b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose return NULL; 212074b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose 212174b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << "Object returned to caller as an owning reference (single " 212274b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "retain count transferred to caller)"; 2123c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2125c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2126f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2127c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2129c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2130c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2131c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2133c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 21345f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2135c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 21361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2137c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 213835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2139c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2140c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2141c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2142c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2143c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2144c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2145c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2146c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2147c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2148c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2149c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2150c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2151c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 21531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2154c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2155c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 21562033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 2157f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Stmt *S = cast<StmtPoint>(N->getLocation()).getStmt(); 2158220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2159220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 21609c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 21611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2162c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2163c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 21641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 21655f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 21669c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 21675eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp, LCtx).getAsLocSymbol() == Sym) { 2168c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2169c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2170c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2172c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2173c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2174c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2175e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// Find the first node in the current function context that referred to the 2176e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// tracked symbol and the memory location that value was stored to. Note, the 2177e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// value is only reported if the allocation occurred in the same function as 2178e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// the leak. 2179c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 218018c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2181c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 21829c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 21831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 2184e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks const LocationContext *LeakContext = N->getLocationContext(); 21851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2186c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 21878bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St = N->getState(); 21881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21898d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (!getRefBinding(St, Sym)) 2190940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 21911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 219227b867ea1c9cb4b40f9b817c303d6df3ee753da9Anna Zaks StoreManager::FindUniqueBinding FB(Sym); 21931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 21941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 21951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2196e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // Allocation node, is the last node in the current context in which the 2197e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // symbol was tracked. 2198e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() == LeakContext) 2199e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks Last = N; 2200e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 22011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 22021ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 22031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2204e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // If allocation happened in a function different from the leak node context, 2205e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // do not report the binding. 2206e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() != LeakContext) { 2207e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks FirstBinding = 0; 2208e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks } 2209e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 2210c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 22116b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 22126b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2213c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 221423f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 221523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 221623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 221776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 221823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2219c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2220fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2221c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 222223f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 222323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 222423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 22251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22268966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2227c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 222876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 22291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2230c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2231c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2232c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 22339c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2234c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 22351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2236c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2237f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 22381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22394fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 22401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2241c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2242c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2243c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 22449c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 22454fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 22461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2247c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2248c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 22491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2250f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 22511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2252f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2253f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2254f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2255f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2256f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2257f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 22581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2259c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 22608d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* RV = getRefBinding(EndN->getState(), Sym); 22611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2262c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2263c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 22645b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2265c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2266d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2267ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek 2268ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << (isa<ObjCMethodDecl>(D) ? " is returned from a method " 2269ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek : " is returned from a function "); 2270ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek 2271ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek if (D->getAttr<CFReturnsNotRetainedAttr>()) 2272ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << "that is annotated as CF_RETURNS_NOT_RETAINED"; 2273ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek else if (D->getAttr<NSReturnsNotRetainedAttr>()) 2274ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << "that is annotated as NS_RETURNS_NOT_RETAINED"; 2275d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2276ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2277ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << "whose name ('" << MD->getSelector().getAsString() 2278ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 2279ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek " This violates the naming convention rules" 2280ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek " given in the Memory Management Guide for Cocoa"; 2281ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek } 2282ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek else { 2283ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2284ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << "whose name ('" << *FD 2285ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 2286ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek " convention rules given in the Memory Management Guide for Core" 2287ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek " Foundation"; 2288ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek } 2289ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek } 2290c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2291e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 22929c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2293e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 229482f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 229582f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 229682f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 229782f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2298e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2299c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2300abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2301f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 23021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2303c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2304c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2305cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 23062058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 23072058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 23082058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 23096a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx) 23102058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 23111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2312fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2313c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2314c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2315c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2316c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2317c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2318c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2319c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 23209c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 23211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23226a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const SourceManager& SMgr = Ctx.getSourceManager(); 2323590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2324c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 23256a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks GetAllocationSite(Ctx.getStateManager(), getErrorNode(), sym); 23261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2327c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2328852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: This will crash the analyzer if an allocation comes from an 2329852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // implicit call. (Currently there are no such allocations in Cocoa, though.) 2330852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const Stmt *AllocStmt; 2331c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 2332852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (CallExitEnd *Exit = dyn_cast<CallExitEnd>(&P)) 2333852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose AllocStmt = Exit->getCalleeContext()->getCallSite(); 2334852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose else 2335852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose AllocStmt = cast<PostStmt>(P).getStmt(); 2336852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose assert(AllocStmt && "All allocations must come from explicit calls"); 2337590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2338590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2339c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2340c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2341c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2342dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 23432058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2344dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2345212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << "of an object"; 23461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2347c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2348c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2349212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << " stored into '" << AllocBinding->getString() << '\''; 2350dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 23512058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2352c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2353c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2354c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2355c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2356c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2357c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2358d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2359910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 23609c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 236138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 23629c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 236338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::EndPath, 23646704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2365f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 23661a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCArrayLiteral>, 23671a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCDictionaryLiteral>, 236870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose check::PostStmt<ObjCBoxedExpr>, 2369fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose check::PostCall, 2370f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 23716704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 237276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 237376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 23746f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 23756f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 23766f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 23776f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 23786f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 237938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 238038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 238138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 238238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 238338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 238438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23856f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> Summaries; 23866f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> SummariesGC; 23879c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 23889c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 23899c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23902f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2391910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 239238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2393910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 239438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 239538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 239638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23979c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 23989c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 23999c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 24009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 24019c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 24029c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 24039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 24049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 24059c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 24069c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 24079c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 24081ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 24091ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 24101ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 24111ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 24121ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 24131ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 24149c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 24159c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 24169c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 24179c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 24181ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 24199c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 24209c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 24219c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 24229c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24239c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 24249c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 24259c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 24269c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 24279c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 24289c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 24299c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24309c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 24311ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 24321ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 243317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 243417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 243517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2436db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2437facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunctionGC.reset(new Leak("Leak of object when using " 2438facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 243917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2440db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2441db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2442e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2443facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak of object when not using " 2444facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in " 2445facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "dual GC/non-GC code")); 2446db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2447facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak")); 2448db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2449db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 245017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunction.get(); 2451db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2452db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2453db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 245417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakAtReturnBug(const LangOptions &LOpts, bool GCEnabled) const { 245517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2456db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturnGC) 2457facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturnGC.reset(new Leak("Leak of returned object when using " 2458facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 245917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2460db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2461db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2462e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2463facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object when not using " 2464facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in dual " 2465facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "GC/non-GC code")); 2466db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2467facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object")); 2468db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2469db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 247017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturn.get(); 2471db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2472db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2473db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 247417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(ASTContext &Ctx, 247517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 247617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // FIXME: We don't support ARC being turned on and off during one analysis. 247717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // (nor, for that matter, do we support changing ASTContexts) 24784e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie bool ARCEnabled = (bool)Ctx.getLangOpts().ObjCAutoRefCount; 247917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 248017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!SummariesGC) 2481b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose SummariesGC.reset(new RetainSummaryManager(Ctx, true, ARCEnabled)); 248217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 248317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(SummariesGC->isARCEnabled() == ARCEnabled); 2484b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *SummariesGC; 2485b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } else { 248617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!Summaries) 2487b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose Summaries.reset(new RetainSummaryManager(Ctx, false, ARCEnabled)); 248817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 248917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(Summaries->isARCEnabled() == ARCEnabled); 2490b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *Summaries; 2491b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2492b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2493b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 249417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(CheckerContext &C) const { 249517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return getSummaryManager(C.getASTContext(), C.isObjCGCEnabled()); 249617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 249717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 24988bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void printState(raw_ostream &Out, ProgramStateRef State, 2499dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const char *NL, const char *Sep) const; 2500dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 2501390909c89c98ab1807e15e033a72e975f866fb23Anna Zaks void checkBind(SVal loc, SVal val, const Stmt *S, CheckerContext &C) const; 2502ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const; 2503ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const CastExpr *CE, CheckerContext &C) const; 2504f85e193739c953358c865005855253af4f68a497John McCall 25051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCArrayLiteral *AL, CheckerContext &C) const; 25061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCDictionaryLiteral *DL, CheckerContext &C) const; 250770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose void checkPostStmt(const ObjCBoxedExpr *BE, CheckerContext &C) const; 250870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2509fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose void checkPostCall(const CallEvent &Call, CheckerContext &C) const; 25101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose void checkSummary(const RetainSummary &Summ, const CallEvent &Call, 2512e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2513294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2514554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks void processSummaryOfInlined(const RetainSummary &Summ, 2515554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const CallEvent &Call, 2516554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const; 2517554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 251876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 251976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 25208bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond, 2521ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 25226704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25238bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 25248bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek checkRegionChanges(ProgramStateRef state, 2525537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 2526537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 252766c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 2528740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const; 2529ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 25308bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool wantsRegionChangeUpdate(ProgramStateRef state) const { 25312f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2532ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2533294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2534f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2535f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2536f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 25378bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek SymbolRef Sym, ProgramStateRef state) const; 2538f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 253938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 2540af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks void checkEndPath(CheckerContext &C) const; 254138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25428bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef updateSymbol(ProgramStateRef state, SymbolRef sym, 2543554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2544554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const; 2545e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 25468bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void processNonLeakError(ProgramStateRef St, SourceRange ErrorRange, 2547294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2548294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 25491a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25501a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void processObjCLiterals(CheckerContext &C, const Expr *Ex) const; 2551294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 255238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 255338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25548bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef handleSymbolDeath(ProgramStateRef state, 25558d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SymbolRef sid, RefVal V, 25568d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SmallVectorImpl<SymbolRef> &Leaked) const; 255738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25588bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ExplodedNode *, ProgramStateRef > 25592bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose handleAutoreleaseCounts(ProgramStateRef state, ExplodedNode *Pred, 25602bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag, CheckerContext &Ctx, 25612bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose SymbolRef Sym, RefVal V) const; 25628d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 25638bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *processLeaks(ProgramStateRef state, 256438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 25656a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 256638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2567d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2568d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2569d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 25706704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 25716704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 25728bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 25736704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 25748bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek StopTrackingCallback(ProgramStateRef st) : state(st) {} 25758bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return state; } 25766704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25776704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 25786704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 25796704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 25806704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 25816704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 25826704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 25836704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2584910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2585910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2586910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 25876704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2588910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2589910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2590dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2591910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2592dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2593469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 259438cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2595dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 25968bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 259738cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 25985eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek cast<BlockDataRegion>(state->getSVal(BE, 25995eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsRegion()); 2600dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 260138cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 260238cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2603dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 260438cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 260538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2606dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 260767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 260867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 260967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 26105f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 261139ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2612c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2613dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 261467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 261567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion *VR = *I; 261667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 261767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 261867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 261967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 262067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2621dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 262267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 262367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 262467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 26250bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 262638cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 262738cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2628910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2629910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2630f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2631f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2632f85e193739c953358c865005855253af4f68a497John McCall return; 2633f85e193739c953358c865005855253af4f68a497John McCall 263471c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2635f85e193739c953358c865005855253af4f68a497John McCall 2636f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2637f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2638f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2639f85e193739c953358c865005855253af4f68a497John McCall return; 2640f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2641f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2642f85e193739c953358c865005855253af4f68a497John McCall break; 2643f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2644f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2645f85e193739c953358c865005855253af4f68a497John McCall break; 2646f85e193739c953358c865005855253af4f68a497John McCall } 2647f85e193739c953358c865005855253af4f68a497John McCall 26488bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26495eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CE, C.getLocationContext()).getAsLocSymbol(); 2650f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2651f85e193739c953358c865005855253af4f68a497John McCall return; 26528d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* T = getRefBinding(state, Sym); 2653f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2654f85e193739c953358c865005855253af4f68a497John McCall return; 2655f85e193739c953358c865005855253af4f68a497John McCall 2656f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 265717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2658f85e193739c953358c865005855253af4f68a497John McCall 2659f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2660e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2661e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2662f85e193739c953358c865005855253af4f68a497John McCall return; 2663f85e193739c953358c865005855253af4f68a497John McCall } 2664f85e193739c953358c865005855253af4f68a497John McCall 26650bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 2666f85e193739c953358c865005855253af4f68a497John McCall} 2667f85e193739c953358c865005855253af4f68a497John McCall 26681a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::processObjCLiterals(CheckerContext &C, 26691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Expr *Ex) const { 26701a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ProgramStateRef state = C.getState(); 26711a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const ExplodedNode *pred = C.getPredecessor(); 26721a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek for (Stmt::const_child_iterator it = Ex->child_begin(), et = Ex->child_end() ; 26731a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek it != et ; ++it) { 26741a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Stmt *child = *it; 26751a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal V = state->getSVal(child, pred->getLocationContext()); 26761a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = V.getAsSymbol()) 26778d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal* T = getRefBinding(state, sym)) { 26781a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek RefVal::Kind hasErr = (RefVal::Kind) 0; 26791a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = updateSymbol(state, sym, *T, MayEscape, hasErr, C); 26801a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (hasErr) { 26811a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processNonLeakError(state, child->getSourceRange(), hasErr, sym, C); 26821a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek return; 26831a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26841a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26851a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26861a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26871a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Return the object as autoreleased. 26881a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // RetEffect RE = RetEffect::MakeNotOwned(RetEffect::ObjC); 26891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = 26901a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state->getSVal(Ex, pred->getLocationContext()).getAsSymbol()) { 26911a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek QualType ResultTy = Ex->getType(); 26928d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, sym, 26938d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks RefVal::makeNotOwned(RetEffect::ObjC, ResultTy)); 26941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26951a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26961a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek C.addTransition(state); 26971a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 26981a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26991a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCArrayLiteral *AL, 27001a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27011a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all values. 27021a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, AL); 27031a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27041a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 27051a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCDictionaryLiteral *DL, 27061a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 27071a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all keys and values. 27081a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, DL); 27091a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 27101a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 271170fdbc366da85880aae5baebd3351e993ca05603Jordy Rosevoid RetainCountChecker::checkPostStmt(const ObjCBoxedExpr *Ex, 271270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose CheckerContext &C) const { 271370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ExplodedNode *Pred = C.getPredecessor(); 271470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const LocationContext *LCtx = Pred->getLocationContext(); 271570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose ProgramStateRef State = Pred->getState(); 271670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 271770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (SymbolRef Sym = State->getSVal(Ex, LCtx).getAsSymbol()) { 271870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose QualType ResultTy = Ex->getType(); 27198d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks State = setRefBinding(State, Sym, 27208d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks RefVal::makeNotOwned(RetEffect::ObjC, ResultTy)); 272170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 272270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 272370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose C.addTransition(State); 272470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 272570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2726fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rosevoid RetainCountChecker::checkPostCall(const CallEvent &Call, 2727fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose CheckerContext &C) const { 2728fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2729fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose const RetainSummary *Summ = Summaries.getSummary(Call, C.getState()); 2730554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2731554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (C.wasInlined) { 2732554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks processSummaryOfInlined(*Summ, Call, C); 2733554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return; 2734554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2735fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose checkSummary(*Summ, Call, C); 2736294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2737294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2738910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2739910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2740bed28ac1d1463adca3ecf24fca5c30646fa9dbb2Sylvestre Ledru/// While the return type can be queried directly from RetEx, when 2741910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2742910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2743910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2744910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2745910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2746910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2747910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2748910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2749910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2750910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2751910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2752910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2753910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2754910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2755910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2756910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2757910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2758910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2759910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2760910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2761910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2762910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2763910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2764910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2765910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2766554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// We don't always get the exact modeling of the function with regards to the 2767554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// retain count checker even when the function is inlined. For example, we need 2768554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// to stop tracking the symbols which were marked with StopTrackingHard. 2769554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaksvoid RetainCountChecker::processSummaryOfInlined(const RetainSummary &Summ, 2770554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const CallEvent &CallOrMsg, 2771554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const { 2772554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ProgramStateRef state = C.getState(); 2773554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2774554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Evaluate the effect of the arguments. 2775554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2776554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Summ.getArg(idx) == StopTrackingHard) { 2777554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks SVal V = CallOrMsg.getArgSVal(idx); 2778554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (SymbolRef Sym = V.getAsLocSymbol()) { 2779554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2780554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2781554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2782554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2783554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2784554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Evaluate the effect on the message receiver. 2785554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const ObjCMethodCall *MsgInvocation = dyn_cast<ObjCMethodCall>(&CallOrMsg); 2786554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (MsgInvocation) { 2787554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (SymbolRef Sym = MsgInvocation->getReceiverSVal().getAsLocSymbol()) { 2788554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Summ.getReceiverEffect() == StopTrackingHard) { 2789554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2790554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2791554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2792554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2793554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2794554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Consult the summary for the return value. 2795554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks RetEffect RE = Summ.getRetEffect(); 2796554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (RE.getKind() == RetEffect::NoRetHard) { 2797554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 2798554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks C.getLocationContext()).getAsSymbol(); 2799554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Sym) 2800554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2801554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2802554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2803554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks C.addTransition(state); 2804554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks} 2805554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2806910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 28074531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &CallOrMsg, 2808910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 28098bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2810294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2811294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2812294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2813294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2814294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2815294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2816294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2817537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2818294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2819294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 28208d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(state, Sym)) { 282117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2822294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2823294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2824294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2825294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2826294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2827294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2828294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2829294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2830294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2831294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2832294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 28334531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!hasErr) { 2834cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCMethodCall *MsgInvocation = dyn_cast<ObjCMethodCall>(&CallOrMsg); 28354531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (MsgInvocation) { 28364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (SymbolRef Sym = MsgInvocation->getReceiverSVal().getAsLocSymbol()) { 28378d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(state, Sym)) { 28384531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverIsTracked = true; 28394531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 2840554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks hasErr, C); 28414531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (hasErr) { 28428919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ErrorRange = MsgInvocation->getOriginExpr()->getReceiverRange(); 28434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ErrorSym = Sym; 28444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 2845294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2846294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2847294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2848294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2849294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2850294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2851294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2852294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2853294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2854294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2855294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2856294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2857294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2858294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2859294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2860b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 286117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2862b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2863294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2864294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2865294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2866294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2867294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 28687530c034c0c71a64c5a9173206d9742ae847af8bDavid Blaikie llvm_unreachable("Unhandled RetEffect."); 2869294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2870294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2871554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case RetEffect::NoRetHard: 2872294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2873294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2874294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2875294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2876294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 28775eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CallOrMsg.getOriginExpr(), 28785eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsSymbol(); 2879294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2880294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2881294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 28824531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // Use the result type from the CallEvent as it automatically adjusts 2883294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 28844531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose QualType ResultTy = CallOrMsg.getResultType(); 28858d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, RefVal::makeOwned(RE.getObjKind(), 28868d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks ResultTy)); 2887294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2888294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2889c6ba23f207410efcaf93132790218b9f9bcebe43Anna Zaks // *not* fail. 2890294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2891294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2892294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2893294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2894294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2895294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2896294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 28975eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(Ex, C.getLocationContext()).getAsSymbol(); 2898294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2899294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2900294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2901294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2902294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 29038d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, RefVal::makeNotOwned(RE.getObjKind(), 29048d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks ResultTy)); 2905294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2906294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2907294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2908294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2909294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2910294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2911294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2912294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2913294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2914294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2915294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 29160bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks NewNode = C.addTransition(state); 2917294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2918294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 29199c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 29209c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 29219c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 29229c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 29239c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 29249c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 29259c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2926ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 29279c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2928294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2929294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2930e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 29318bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 29328bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::updateSymbol(ProgramStateRef state, SymbolRef sym, 2933910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2934910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2935e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2936910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 293717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 293817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 29394e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie IgnoreRetainMsg = (bool)C.getASTContext().getLangOpts().ObjCAutoRefCount; 294017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2941e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 29424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose default: 29434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRefMsg: 29454531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? DoNothing : IncRef; 29464531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29474531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsg: 29484531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? DoNothing : DecRef; 29494531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 2950554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefMsgAndStopTrackingHard: 2951554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks E = IgnoreRetainMsg ? StopTracking : DecRefAndStopTrackingHard; 29524531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29534531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MakeCollectable: 29544531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = C.isObjCGCEnabled() ? DecRef : DoNothing; 29554531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29564531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case NewAutoreleasePool: 29574531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = C.isObjCGCEnabled() ? DoNothing : NewAutoreleasePool; 29584531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 2959e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2960e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2961e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 296217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2963e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2964e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 29658d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 2966e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2967e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2968e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2969e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2970e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2971e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 2972554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefMsgAndStopTrackingHard: 2973e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2974e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2975e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2976e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 297717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2978e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2979e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2980e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2981e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2982e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2983e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2984e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2985e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2986e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2987e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2988e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2989e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 29908d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 2991e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2992e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2993e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2994e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2995e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2996e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2997e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2998e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case NewAutoreleasePool: 299917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(!C.isObjCGCEnabled()); 3000c95bb76e85ff9a37de23821f713d947dcbc98f35Anna Zaks return state; 3001e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3002e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 3003e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 3004e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 3005e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3006e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3007e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3008e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 3009e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3010e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 3011e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 3012e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3013e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 301417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 3015e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 3016e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 3017e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 3018e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3019e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3020e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 3021554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case StopTrackingHard: 30228d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 3023e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3024e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 3025e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3026e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3027e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 3028e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3029e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 3030e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 3031e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3032e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3033e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 303417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3035e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 3036e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3037e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3038e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3039e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3040e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 3041e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 3042554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefAndStopTrackingHard: 3043e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3044e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3045e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 3046e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 3047e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3048e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3049e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 3050e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 3051e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 3052e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 3053554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks else if (E == DecRefAndStopTrackingHard) 30548d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 30554531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 3056e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3057e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3058e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3059e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 30604531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (V.getCount() > 0) { 3061554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (E == DecRefAndStopTrackingHard) 30628d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 3063e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 30644531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } else { 3065e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 3066e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3067e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3068e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3069e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3070e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3071e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 307217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3073e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 3074e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3075e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3076e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3077e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3078e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 30798d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 3080e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 3081e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 30828bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::processNonLeakError(ProgramStateRef St, 3083910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 3084910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 3085910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 3086910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3087294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 3088294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 3089294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 3090294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3091294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 3092294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 3093294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 3094294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 3095294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 3096d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 3097d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 3098d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 3099294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3100294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 3101d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 3102d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 3103d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 3104294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3105294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 3106d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 3107d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 3108d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 3109294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3110294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 3111d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 3112d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 3113d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 3114294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3115294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3116294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3117d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 31184e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOpts(), 311917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 312017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 3121294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 3122294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose C.EmitReport(report); 3123294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 3124294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3125910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3126910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 3127910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3128910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3129910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 313076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 31318bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3132b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *FD = C.getCalleeDecl(CE); 313376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 313476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 313576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 313676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 313776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 313876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 313976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 314076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 314176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 314276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 314376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 314476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 314576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 314676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 314776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 314876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 314976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 315076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 315176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 315276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 315376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3154b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks QualType ResultTy = CE->getCallReturnType(); 315576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 315676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 315776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 315876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 315976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 316076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 316176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 316276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 316376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 316476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 316576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 316676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 316776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 316876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 316976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 317076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 317176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 31725eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = C.getLocationContext(); 31735eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal RetVal = state->getSVal(CE->getArg(0), LCtx); 317476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 317576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 317676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 317766c486f275531df6362b3511fc3af6563561801bTed Kremenek RetVal = SVB.conjureSymbolVal(0, CE, LCtx, ResultTy, C.blockCount()); 317876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 31795eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal, false); 318076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3181294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3182294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3183294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3184294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3185294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 31868d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *Binding = 0; 3187294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 31888d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks Binding = getRefBinding(state, Sym); 318976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3190294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 319166c486f275531df6362b3511fc3af6563561801bTed Kremenek state = state->invalidateRegions(ArgRegion, CE, C.blockCount(), LCtx); 319276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3193294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3194294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 31958d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, *Binding); 3196294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3197294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 31980bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 319976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 320076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 320176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3202910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3203910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3204910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3205f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3206e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek// Return true if the current LocationContext has no caller context. 3207e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenekstatic bool inTopFrame(CheckerContext &C) { 3208e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek const LocationContext *LC = C.getLocationContext(); 3209e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return LC->getParent() == 0; 3210e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek} 3211e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3212910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3213910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3214e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3215e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // Only adjust the reference count if this is the top-level call frame, 3216e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // and not the result of inlining. In the future, we should do 3217e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // better checking even for inlined calls, and see if they match 3218e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // with their expected semantics (e.g., the method should return a retained 3219e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // object, etc.). 3220e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek if (!inTopFrame(C)) 3221e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return; 3222e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3223f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3224f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3225f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3226f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32278bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 32285eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = 32295eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state->getSValAsScalarOrLoc(RetE, C.getLocationContext()).getAsLocSymbol(); 3230f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3231f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3232f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3233f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 32348d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *T = getRefBinding(state, Sym); 3235f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3236f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3237f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3238f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3239f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3240f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3241f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3242f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3243f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3244f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3245f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3246f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3247f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3248f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3249f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3250f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3251f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3252f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3253f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3254f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3255f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3256f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3257f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3258f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3259f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3260f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3261f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3262f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3263f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3264f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3265f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3266f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 32678d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X); 32680bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *Pred = C.addTransition(state); 3269f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3270f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3271f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3272f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3273f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3274f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3275f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3276f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3277f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3278f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3279f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3280910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 32812bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Pred, &AutoreleaseTag, 32822bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose C, Sym, X); 3283f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3284f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 32858d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!Pred) 3286f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3287f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3288f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 32898d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks T = getRefBinding(state, Sym); 3290f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3291f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3292f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3293f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 329417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3295f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 32964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetEffect RE = RetEffect::MakeNoRet(); 3297f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: What is the convention for blocks? Is there one? 3299f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3300b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 33014531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = Summ->getRetEffect(); 33024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 33034531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!isa<CXXMethodDecl>(FD)) { 33044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ = Summaries.getFunctionSummary(FD); 33054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = Summ->getRetEffect(); 33064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 3307f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3308f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33094531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3310f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3311f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3312910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3313910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3314910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3315910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3316910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 33178bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state) const { 3318f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3319f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3320f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3321f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 332217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3323f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3324f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3325f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3326f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3327f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3328f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3329f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3330f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3331f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3332f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3333f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3334f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3335f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3336f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3337f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3338f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3339f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 33408d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X); 3341f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3342f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3343910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 33440bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnOwnLeakTag); 3345f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 33464e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = C.getASTContext().getLangOpts(); 334717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3348f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 334917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 335017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 33516a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks N, Sym, C); 3352f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3353f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3354f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3355f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3356f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3357f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3358f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3359f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 33608d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X ^ RefVal::ErrorReturnedNotOwned); 3361f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3362f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3363910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 33640bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnNotOwnedTag); 3365f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3366d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3367d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3368d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3369f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3370d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 33714e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie C.getASTContext().getLangOpts(), 337217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3373f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose C.EmitReport(report); 3374f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3375f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3376f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3377f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3378f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33798d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3380910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3381910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3382910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3383390909c89c98ab1807e15e033a72e975f866fb23Anna Zaksvoid RetainCountChecker::checkBind(SVal loc, SVal val, const Stmt *S, 3384910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3385910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3386910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3387910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3388910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3389910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3390910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3391910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3392910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3393910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 33948bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3395910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3396910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (loc::MemRegionVal *regionLoc = dyn_cast<loc::MemRegionVal>(&loc)) { 3397910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3398910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3399910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3400910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3401910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3402910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3403e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // Do this only if we know that the store is not supposed to generate the 3404e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // same state. 3405e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks SVal StoredVal = state->getSVal(regionLoc->getRegion()); 3406e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks if (StoredVal != val) 3407e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks escapes = (state == (state->bindLoc(*regionLoc, val))); 3408910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3409de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek if (!escapes) { 3410de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // Case 4: We do not currently model what happens when a symbol is 3411de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // assigned to a struct field, so be conservative here and let the symbol 3412de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // go. TODO: This could definitely be improved upon. 3413de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek escapes = !isa<VarRegion>(regionLoc->getRegion()); 3414de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek } 3415910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3416910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3417910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3418910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3419910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3420910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3421910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3422910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3423910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3424910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3425910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 34260bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 3427910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3428910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34298bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef RetainCountChecker::evalAssume(ProgramStateRef state, 3430910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3431910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3432910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3433910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3434910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3435910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3436910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3437910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3438910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3439910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings B = state->get<RefBindings>(); 3440910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3441910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3442910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3443910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3444910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3445910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefBindings::Factory &RefBFactory = state->get_context<RefBindings>(); 3446910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3447910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 344847cbd0f3892c7965cf16a58393f9f17a22d4d4d9Ted Kremenek // Check if the symbol is null stop tracking the symbol. 344947cbd0f3892c7965cf16a58393f9f17a22d4d4d9Ted Kremenek if (state->getConstraintManager().isNull(state, I.getKey()).isTrue()) { 3450910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3451910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3452910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3453910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3454910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3455910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3456910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3457910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3458910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3459910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3460910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34618bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 34628bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::checkRegionChanges(ProgramStateRef state, 3463910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const StoreManager::InvalidatedSymbols *invalidated, 3464910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 346566c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 3466740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const { 3467910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3468910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3469910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3470910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3471910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3472910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3473910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3474910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3475910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3476910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3477910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (StoreManager::InvalidatedSymbols::const_iterator I=invalidated->begin(), 3478910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3479910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3480910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3481910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3482910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 34838d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = removeRefBinding(state, sym); 3484910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3485910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3486910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3487910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3488910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 34898d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 34908d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 34918d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekstd::pair<ExplodedNode *, ProgramStateRef > 34938bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleAutoreleaseCounts(ProgramStateRef state, 34946a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred, 34952bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag, 34966a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 3497910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 34988d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 34998d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35008d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 35018d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 35028d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(Pred, state); 35038d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35046a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks assert(!Ctx.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 35058d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 35068d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35078d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 35088d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35098d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 35108d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 35118d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35128d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 35138d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 35148d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 35158d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 35168d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 35178d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 35188d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 35198d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 35208d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setCount(Cnt - ACnt); 35218d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 35228d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35238d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, V); 35242bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose ExplodedNode *N = Ctx.addTransition(state, Pred, Tag); 35258d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (N == 0) 35268d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = 0; 35278d22863184419faa2348bd5148c663197bc4bb00Jordy Rose return std::make_pair(N, state); 35288d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35298d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35308d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 35318d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 35328d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 35338d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, V); 35348d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3535fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose ExplodedNode *N = Ctx.generateSink(state, Pred, Tag); 35362bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose if (N) { 3537f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<128> sbuf; 35388d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 35398d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 35408d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 35418d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 35428d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 35438d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3544d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3545d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3546d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 35474e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35488d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3549d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3550d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 35516a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 35528d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35538d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35548bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek return std::make_pair((ExplodedNode *)0, (ProgramStateRef )0); 35558d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 355638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35578bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 35588bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleSymbolDeath(ProgramStateRef state, 3559910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 356038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 35615337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 356238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 356338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 356438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 356538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 356638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 35688d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sid); 356938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 35718d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sid, V ^ RefVal::ErrorLeak); 357238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 357338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 357438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 35758bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::processLeaks(ProgramStateRef state, 3576910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 35776a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 35786a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred) const { 357938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (Leaked.empty()) 358038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return Pred; 358138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 358238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 35832bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose ExplodedNode *N = Ctx.addTransition(state, Pred); 358438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 358538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 358638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 358738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 358838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35894e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35906a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks bool GCEnabled = Ctx.isObjCGCEnabled(); 359117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 359217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 359338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 35942058956954802229bf98604e8063fa57677abff4Jordy Rose 359517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 35966a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks SummaryLog, N, *I, Ctx); 35976a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks Ctx.EmitReport(report); 359838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 359938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 360038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 360138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 360238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 360338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3604af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaksvoid RetainCountChecker::checkEndPath(CheckerContext &Ctx) const { 36058bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Ctx.getState(); 360638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 3607af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred = Ctx.getPredecessor(); 360838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 360938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 36102bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Pred, /*Tag=*/0, 36112bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose Ctx, I->first, I->second); 36128d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 361338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 361438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 361538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36160cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // If the current LocationContext has a parent, don't check for leaks. 36170cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // We will do that later. 36188d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks // FIXME: we should instead check for imbalances of the retain/releases, 36190cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // and suggest annotations. 36200cf3d471546251b12bdceff360f66c079c40526cTed Kremenek if (Ctx.getLocationContext()->getParent()) 36210cf3d471546251b12bdceff360f66c079c40526cTed Kremenek return; 36220cf3d471546251b12bdceff360f66c079c40526cTed Kremenek 362338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 362438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 362538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 362638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) 36278d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 362838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36292bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose processLeaks(state, Leaked, Ctx, Pred); 363038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 363138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 363238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3633910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 363438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 363538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 3636f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<64> buf; 363738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3638f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks out << "RetainCountChecker : Dead Symbol : "; 3639f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks sym->dumpToStream(out); 364038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 364138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 364238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 364338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 364438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3645910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3646910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 364738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 364838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36498bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 365038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings B = state->get<RefBindings>(); 365138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 365238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 365338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 365438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 365538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 365638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 365738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 365838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 36592bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag = getDeadSymbolTag(Sym); 36602bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose llvm::tie(Pred, state) = handleAutoreleaseCounts(state, Pred, Tag, C, 36618d22863184419faa2348bd5148c663197bc4bb00Jordy Rose Sym, *T); 36628d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 366338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 366438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 366538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 366638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 366738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 366838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 366938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 367138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 367238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(*I)) 367338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = handleSymbolDeath(state, *I, *T, Leaked); 367438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 367538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36762bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose Pred = processLeaks(state, Leaked, C, Pred); 367738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 367838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 367938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 368038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 368138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 368238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 368338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose RefBindings::Factory &F = state->get_context<RefBindings>(); 368438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 368538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 368638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) 368738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 368838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 368938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 36900bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state, Pred); 369138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 369238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36938bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::printState(raw_ostream &Out, ProgramStateRef State, 3694910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3695dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3696dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose RefBindings B = State->get<RefBindings>(); 3697dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3698dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3699dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3700dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3701dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3702dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3703dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3704dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3705dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3706dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3707dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3708dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3709910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 37106b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 37116b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 371217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3713910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 371417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 371517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3716