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" 162fa67efeaf66a9332c30a026dc1c21bef6c33a6cBenjamin Kramer#include "clang/AST/Attr.h" 17b277159055933e610bbc80262b600d3ad7e0595cTed Kremenek#include "clang/AST/DeclCXX.h" 182fa67efeaf66a9332c30a026dc1c21bef6c33a6cBenjamin Kramer#include "clang/AST/DeclObjC.h" 192fa67efeaf66a9332c30a026dc1c21bef6c33a6cBenjamin Kramer#include "clang/AST/ParentMap.h" 202fa67efeaf66a9332c30a026dc1c21bef6c33a6cBenjamin Kramer#include "clang/Analysis/DomainSpecific/CocoaConventions.h" 21072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek#include "clang/Basic/LangOptions.h" 22c9fa2f7bcc3061aa8bcdbe0df26d2c7cf7281539Ted Kremenek#include "clang/Basic/SourceManager.h" 239b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" 249b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 2555fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/Checker.h" 2655fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/CheckerManager.h" 27f540c54701e3eeb34cb619a3a4eb18f1ac70ef2dJordan Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 28910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h" 2918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h" 309b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.h" 316b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek#include "llvm/ADT/DenseMap.h" 326b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek#include "llvm/ADT/FoldingSet.h" 336d34893fc886f4153f104de8880876764981cb7fTed Kremenek#include "llvm/ADT/ImmutableList.h" 340b526b454814fa693bf0b2a6748db58a65b9cb7cTed Kremenek#include "llvm/ADT/ImmutableMap.h" 356ed9afc804731284b9b6d275dce7053d13d0c044Ted Kremenek#include "llvm/ADT/STLExtras.h" 362fa67efeaf66a9332c30a026dc1c21bef6c33a6cBenjamin Kramer#include "llvm/ADT/SmallString.h" 370b526b454814fa693bf0b2a6748db58a65b9cb7cTed Kremenek#include "llvm/ADT/StringExtras.h" 385f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner#include <cstdarg> 392fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 402fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenekusing namespace clang; 419ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremenekusing namespace ento; 42a64e89bbfa756816d1e4a48e5d6c03edf1d7f23bTed Kremenekusing llvm::StrInStrNoCase; 434c79e55951517e9b3c06d0b7ac4bd82320f43f4bTed Kremenek 4405cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek//===----------------------------------------------------------------------===// 45553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Primitives used for constructing summaries for function/method calls. 4605cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek//===----------------------------------------------------------------------===// 4705cbe1a44e6143d44aac0e769ba120e8c45f34ceTed Kremenek 48553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// ArgEffect is used to summarize a function/method call's effect on a 49553cf18cd44769a7624fc942493f076498527529Ted Kremenek/// particular argument. 50bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Roseenum ArgEffect { DoNothing, Autorelease, Dealloc, DecRef, DecRefMsg, 51f85e193739c953358c865005855253af4f68a497John McCall DecRefBridgedTransfered, 52bd85b1394017cdd75294c75e5bad351a70b2e21cJordy Rose IncRefMsg, IncRef, MakeCollectable, MayEscape, 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 345166d502d5367ceacd1313a33cac43b1048b8524dJordan RoseREGISTER_MAP_WITH_PROGRAMSTATE(RefBindings, SymbolRef, RefVal) 346b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 3478d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaksstatic inline const RefVal *getRefBinding(ProgramStateRef State, 3488d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SymbolRef Sym) { 3498d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return State->get<RefBindings>(Sym); 3508d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks} 3518d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks 3528d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaksstatic inline ProgramStateRef setRefBinding(ProgramStateRef State, 3538d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SymbolRef Sym, RefVal Val) { 3548d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return State->set<RefBindings>(Sym, Val); 3558d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks} 3568d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks 3578d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaksstatic ProgramStateRef removeRefBinding(ProgramStateRef State, SymbolRef Sym) { 3588d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return State->remove<RefBindings>(Sym); 3598d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks} 3608d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks 361b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 362910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Function/Method behavior summaries. 363b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek//===----------------------------------------------------------------------===// 364b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 365b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremeneknamespace { 366ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummary { 367ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// Args - a map of (index, ArgEffect) pairs, where index 3681bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// specifies the argument (starting from 0). This can be sparsely 3691bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// populated; arguments with no entry in Args use 'DefaultArgEffect'. 370b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects Args; 3711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3721bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// DefaultArgEffect - The default ArgEffect to apply to arguments that 3731bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek /// do not have an entry in Args. 3740507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect DefaultArgEffect; 3751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 376553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Receiver - If this summary applies to an Objective-C message expression, 377553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// this is the effect applied to the state of the receiver. 3780507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffect Receiver; 3791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 380553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ret - The effect on the return value. Used to indicate if the 38176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose /// function/method call returns a new tracked symbol. 3820507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek RetEffect Ret; 3831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3846b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 385b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetainSummary(ArgEffects A, RetEffect R, ArgEffect defaultEff, 386e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose ArgEffect ReceiverEff) 387e62e87bdb14ec0237819a3b66f6a30105a8f5a0cJordy Rose : Args(A), DefaultArgEffect(defaultEff), Receiver(ReceiverEff), Ret(R) {} 3881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 389553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArg - Return the argument effect on the argument specified by 390553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// idx (starting from 0). 3911ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek ArgEffect getArg(unsigned idx) const { 392b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek if (const ArgEffect *AE = Args.lookup(idx)) 393b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return *AE; 3941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3951bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek return DefaultArgEffect; 3961ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 39711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 39811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek void addArg(ArgEffects::Factory &af, unsigned idx, ArgEffect e) { 39911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek Args = af.add(Args, idx, e); 40011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 4011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 402885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setDefaultArgEffect - Set the default argument effect. 403885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setDefaultArgEffect(ArgEffect E) { 404885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek DefaultArgEffect = E; 405885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek } 4061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 407553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getRetEffect - Returns the effect on the return value of the call. 408b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek RetEffect getRetEffect() const { return Ret; } 4091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 410885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek /// setRetEffect - Set the effect of the return value of the call. 411885c27bfd33c92412a3fb071c3f0fffc6b671783Ted Kremenek void setRetEffect(RetEffect E) { Ret = E; } 4121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 41312b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 41412b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek /// Sets the effect on the receiver of the message. 41512b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek void setReceiverEffect(ArgEffect e) { Receiver = e; } 41612b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 417553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getReceiverEffect - Returns the effect on the receiver of the call. 418553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// This is only meaningful if the summary applies to an ObjCMessageExpr*. 419b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffect getReceiverEffect() const { return Receiver; } 4204df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 4214df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// Test if two retain summaries are identical. Note that merely equivalent 4224df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// summaries are not necessarily identical (for example, if an explicit 4234df54feb02d72b76249e846053d5d53d820bf832Jordy Rose /// argument effect matches the default effect). 4244df54feb02d72b76249e846053d5d53d820bf832Jordy Rose bool operator==(const RetainSummary &Other) const { 4254df54feb02d72b76249e846053d5d53d820bf832Jordy Rose return Args == Other.Args && DefaultArgEffect == Other.DefaultArgEffect && 4264df54feb02d72b76249e846053d5d53d820bf832Jordy Rose Receiver == Other.Receiver && Ret == Other.Ret; 4274df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 428ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 429ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// Profile this summary for inclusion in a FoldingSet. 430ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void Profile(llvm::FoldingSetNodeID& ID) const { 431ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Args); 432ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(DefaultArgEffect); 433ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Receiver); 434ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose ID.Add(Ret); 435ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 436ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 437ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// A retain summary is simple if it has no ArgEffects other than the default. 438ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose bool isSimple() const { 439ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return Args.isEmpty(); 440ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 4414531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 4424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Roseprivate: 4434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffects getArgEffects() const { return Args; } 4444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffect getDefaultArgEffect() const { return DefaultArgEffect; } 4454531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 4464531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose friend class RetainSummaryManager; 4476b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 4484f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} // end anonymous namespace 4496b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 450553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 451553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for constructing summaries. 452553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 453553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4544f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 455ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryKey { 456553cf18cd44769a7624fc942493f076498527529Ted Kremenek IdentifierInfo* II; 457553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector S; 4581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 459553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(IdentifierInfo* ii, Selector s) 460553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(ii), S(s) {} 461553cf18cd44769a7624fc942493f076498527529Ted Kremenek 4629c378f705405d37f49795d5e915989de774fe11fTed Kremenek ObjCSummaryKey(const ObjCInterfaceDecl *d, Selector s) 463553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(d ? d->getIdentifier() : 0), S(s) {} 46470b6a83b833c40f320d0ed2310cbcdf2be4cece0Ted Kremenek 465553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey(Selector s) 466553cf18cd44769a7624fc942493f076498527529Ted Kremenek : II(0), S(s) {} 4671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4680507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek IdentifierInfo *getIdentifier() const { return II; } 469553cf18cd44769a7624fc942493f076498527529Ted Kremenek Selector getSelector() const { return S; } 470553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 4714f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek} 4724f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek 4734f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace llvm { 474553cf18cd44769a7624fc942493f076498527529Ted Kremenektemplate <> struct DenseMapInfo<ObjCSummaryKey> { 475553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getEmptyKey() { 476553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getEmptyKey(), 477553cf18cd44769a7624fc942493f076498527529Ted Kremenek DenseMapInfo<Selector>::getEmptyKey()); 478553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 480553cf18cd44769a7624fc942493f076498527529Ted Kremenek static inline ObjCSummaryKey getTombstoneKey() { 481553cf18cd44769a7624fc942493f076498527529Ted Kremenek return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getTombstoneKey(), 4821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump DenseMapInfo<Selector>::getTombstoneKey()); 483553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 485553cf18cd44769a7624fc942493f076498527529Ted Kremenek static unsigned getHashValue(const ObjCSummaryKey &V) { 48628b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer typedef std::pair<IdentifierInfo*, Selector> PairTy; 48728b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer return DenseMapInfo<PairTy>::getHashValue(PairTy(V.getIdentifier(), 48828b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer V.getSelector())); 489553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 491553cf18cd44769a7624fc942493f076498527529Ted Kremenek static bool isEqual(const ObjCSummaryKey& LHS, const ObjCSummaryKey& RHS) { 49228b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer return LHS.getIdentifier() == RHS.getIdentifier() && 49328b230723d5daf3c48c2e134f4b5626bd69392c8Benjamin Kramer LHS.getSelector() == RHS.getSelector(); 494553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 4951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 496553cf18cd44769a7624fc942493f076498527529Ted Kremenek}; 49706159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <> 49806159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<ObjCSummaryKey> { static const bool value = true; }; 499553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end llvm namespace 5001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 501553cf18cd44769a7624fc942493f076498527529Ted Kremeneknamespace { 502ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ObjCSummaryCache { 50393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<ObjCSummaryKey, const RetainSummary *> MapTy; 504553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy M; 505553cf18cd44769a7624fc942493f076498527529Ted Kremenekpublic: 506553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryCache() {} 5071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 50893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * find(const ObjCInterfaceDecl *D, Selector S) { 509553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Do a lookup with the (D,S) pair. If we find a match return 510553cf18cd44769a7624fc942493f076498527529Ted Kremenek // the iterator. 511553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCSummaryKey K(D, S); 512553cf18cd44769a7624fc942493f076498527529Ted Kremenek MapTy::iterator I = M.find(K); 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (I != M.end()) 515614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I->second; 5164531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!D) 5174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return NULL; 5181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 519553cf18cd44769a7624fc942493f076498527529Ted Kremenek // Walk the super chain. If we find a hit with a parent, we'll end 520553cf18cd44769a7624fc942493f076498527529Ted Kremenek // up returning that summary. We actually allow that key (null,S), as 521553cf18cd44769a7624fc942493f076498527529Ted Kremenek // we cache summaries for the null ObjCInterfaceDecl* to allow us to 522553cf18cd44769a7624fc942493f076498527529Ted Kremenek // generate initial summaries without having to worry about NSObject 523553cf18cd44769a7624fc942493f076498527529Ted Kremenek // being declared. 524553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: We may change this at some point. 5259c378f705405d37f49795d5e915989de774fe11fTed Kremenek for (ObjCInterfaceDecl *C=D->getSuperClass() ;; C=C->getSuperClass()) { 526553cf18cd44769a7624fc942493f076498527529Ted Kremenek if ((I = M.find(ObjCSummaryKey(C, S))) != M.end()) 527553cf18cd44769a7624fc942493f076498527529Ted Kremenek break; 5281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 529553cf18cd44769a7624fc942493f076498527529Ted Kremenek if (!C) 530614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return NULL; 5314f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek } 5321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Cache the summary with original key to make the next lookup faster 534553cf18cd44769a7624fc942493f076498527529Ted Kremenek // and return the iterator. 53593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = I->second; 536614cc540a617978814e37d75bf5066926b921a0aTed Kremenek M[K] = Summ; 537614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return Summ; 538553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5400507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *find(IdentifierInfo* II, Selector S) { 541553cf18cd44769a7624fc942493f076498527529Ted Kremenek // FIXME: Class method lookup. Right now we dont' have a good way 542553cf18cd44769a7624fc942493f076498527529Ted Kremenek // of going between IdentifierInfo* and the class hierarchy. 543614cc540a617978814e37d75bf5066926b921a0aTed Kremenek MapTy::iterator I = M.find(ObjCSummaryKey(II, S)); 5441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 545614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (I == M.end()) 546614cc540a617978814e37d75bf5066926b921a0aTed Kremenek I = M.find(ObjCSummaryKey(S)); 5471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 548614cc540a617978814e37d75bf5066926b921a0aTed Kremenek return I == M.end() ? NULL : I->second; 549553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 55193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](ObjCSummaryKey K) { 552553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[K]; 553553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 55593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *& operator[](Selector S) { 556553cf18cd44769a7624fc942493f076498527529Ted Kremenek return M[ ObjCSummaryKey(S) ]; 557553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 5581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 559553cf18cd44769a7624fc942493f076498527529Ted Kremenek} // end anonymous namespace 560553cf18cd44769a7624fc942493f076498527529Ted Kremenek 561553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 562553cf18cd44769a7624fc942493f076498527529Ted Kremenek// Data structures for managing collections of summaries. 563553cf18cd44769a7624fc942493f076498527529Ted Kremenek//===----------------------------------------------------------------------===// 564553cf18cd44769a7624fc942493f076498527529Ted Kremenek 5654f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremeneknamespace { 566ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass RetainSummaryManager { 567d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 568d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 569d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Typedefs. 570d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 57293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek typedef llvm::DenseMap<const FunctionDecl*, const RetainSummary *> 573d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy; 5741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5754f22a781a56b759ae52511bfc71b5cb8e7d85d33Ted Kremenek typedef ObjCSummaryCache ObjCMethodSummariesTy; 5761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 577ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose typedef llvm::FoldingSetNodeWrapper<RetainSummary> CachedSummaryNode; 578ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 579d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 580d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Data. 581d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 5821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 583553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// Ctx - The ASTContext object for the analyzed ASTs. 5849c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &Ctx; 585179064eb831125630c296556dd6d67e67f716143Ted Kremenek 586553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// GCEnabled - Records whether or not the analyzed code runs in GC mode. 587377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek const bool GCEnabled; 5881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 589f85e193739c953358c865005855253af4f68a497John McCall /// Records whether or not the analyzed code runs in ARC mode. 590f85e193739c953358c865005855253af4f68a497John McCall const bool ARCEnabled; 591f85e193739c953358c865005855253af4f68a497John McCall 592553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// FuncSummaries - A map from FunctionDecls to summaries. 5931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump FuncSummariesTy FuncSummaries; 5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 595553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCClassMethodSummaries - A map from selectors (for instance methods) 596553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// to summaries. 5971f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCClassMethodSummaries; 598d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 599553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ObjCMethodSummaries - A map from selectors to summaries. 6001f180c3128866c031a2a266b5131590155237337Ted Kremenek ObjCMethodSummariesTy ObjCMethodSummaries; 601d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 602553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// BPAlloc - A BumpPtrAllocator used for allocating summaries, ArgEffects, 603553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// and all other data used by the checker. 604d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek llvm::BumpPtrAllocator BPAlloc; 6051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 606b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek /// AF - A factory for ArgEffects objects. 6071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ArgEffects::Factory AF; 6081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 609553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// ScratchArgs - A holding buffer for construct ArgEffects. 6100507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek ArgEffects ScratchArgs; 6111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 612ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// ObjCAllocRetE - Default return effect for methods returning Objective-C 613ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek /// objects. 614ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek RetEffect ObjCAllocRetE; 615547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek 6161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// ObjCInitRetE - Default return effect for init methods returning 617ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek /// Objective-C objects. 618547d495a7d11d67639c68774a7011dfa8c36e347Ted Kremenek RetEffect ObjCInitRetE; 6191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 620ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// SimpleSummaries - Used for uniquing summaries that don't have special 621ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose /// effects. 622ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSet<CachedSummaryNode> SimpleSummaries; 6231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 624d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 625d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek // Methods. 626d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek //==-----------------------------------------------------------------==// 6271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 628553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// getArgEffects - Returns a persistent ArgEffects object based on the 629553cf18cd44769a7624fc942493f076498527529Ted Kremenek /// data in ScratchArgs. 630b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects getArgEffects(); 63100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 6321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump enum UnaryFuncKind { cfretain, cfrelease, cfmakecollectable }; 63393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek 6340507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getUnarySummary(const FunctionType* FT, 63593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek UnaryFuncKind func); 6361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6370507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryCreateRule(const FunctionDecl *FD); 6380507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFSummaryGetRule(const FunctionDecl *FD); 6390507f7ee76ed838ce3012ca9e10ff7811723acf2Ted Kremenek const RetainSummary *getCFCreateGetRuleSummary(const FunctionDecl *FD); 6401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 641ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(const RetainSummary &OldSumm); 642706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 643ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentSummary(RetEffect RetEff, 64493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect ReceiverEff = DoNothing, 64593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek ArgEffect DefaultEff = MayEscape) { 646ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RetainSummary Summ(getArgEffects(), RetEff, DefaultEff, ReceiverEff); 647ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(Summ); 6489c32d08925045b32d7c39516e35d860159252e1dTed Kremenek } 6491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 650c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek const RetainSummary *getDoNothingSummary() { 651c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 652c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } 653c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek 654ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getDefaultSummary() { 655ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 656ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose DoNothing, MayEscape); 657ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 658706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek 659ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose const RetainSummary *getPersistentStopSummary() { 660ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), 661ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose StopTracking, StopTracking); 6621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 663b309525445c8ec3d36e49568382029efc2740554Ted Kremenek 6641f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeClassMethodSummaries(); 6651f180c3128866c031a2a266b5131590155237337Ted Kremenek void InitializeMethodSummaries(); 666896cd9d1502b8d2ef9a2b886c4f525faced2a57aTed Kremenekprivate: 66793edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectClsMethSummary(Selector S, const RetainSummary *Summ) { 668553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCClassMethodSummaries[S] = Summ; 669553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 67193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addNSObjectMethSummary(Selector S, const RetainSummary *Summ) { 672553cf18cd44769a7624fc942493f076498527529Ted Kremenek ObjCMethodSummaries[S] = Summ; 673553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 6743aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek 675a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek void addClassMethSummary(const char* Cls, const char* name, 676a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek const RetainSummary *Summ, bool isNullary = true) { 6773aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 678a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek Selector S = isNullary ? GetNullarySelector(name, Ctx) 679a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek : GetUnarySelector(name, Ctx); 6803aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek ObjCClassMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6813aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek } 6821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6836c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek void addInstMethSummary(const char* Cls, const char* nullaryName, 68493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ) { 6856c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek IdentifierInfo* ClsII = &Ctx.Idents.get(Cls); 6866c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek Selector S = GetNullarySelector(nullaryName, Ctx); 6876c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek ObjCMethodSummaries[ObjCSummaryKey(ClsII, S)] = Summ; 6886c4becbab5953c84438d1fe829316b45f7df3453Ted Kremenek } 6891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 690de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector generateSelector(va_list argp) { 6915f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<IdentifierInfo*, 10> II; 692de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6939e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek while (const char* s = va_arg(argp, const char*)) 6949e476ded1d10802932fc3e2e9d22d30730f22a01Ted Kremenek II.push_back(&Ctx.Idents.get(s)); 695de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 6961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return Ctx.Selectors.getSelector(II.size(), &II[0]); 697de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 6981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 699de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek void addMethodSummary(IdentifierInfo *ClsII, ObjCMethodSummariesTy& Summaries, 70093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary * Summ, va_list argp) { 701de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Selector S = generateSelector(argp); 702de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek Summaries[ObjCSummaryKey(ClsII, S)] = Summ; 70370a733e64e2379a654631a14fa29e46761d5f80dTed Kremenek } 7041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addInstMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 706af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_list argp; 707af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek va_start(argp, Summ); 708de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls), ObjCMethodSummaries, Summ, argp); 7091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump va_end(argp); 710af9dc27b1c51d13d444a2ab3a59d8d0798a0f7c6Ted Kremenek } 7111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71293edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(const char* Cls, const RetainSummary * Summ, ...) { 713de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 714de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 715de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(&Ctx.Idents.get(Cls),ObjCClassMethodSummaries, Summ, argp); 716de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 717de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 7181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void addClsMethSummary(IdentifierInfo *II, const RetainSummary * Summ, ...) { 720de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_list argp; 721de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_start(argp, Summ); 722de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek addMethodSummary(II, ObjCClassMethodSummaries, Summ, argp); 723de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek va_end(argp); 724de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek } 725de4d5339e0811c8c8226aee8e00dc9a25bd5ebcfTed Kremenek 7266b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenekpublic: 7271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7289c378f705405d37f49795d5e915989de774fe11fTed Kremenek RetainSummaryManager(ASTContext &ctx, bool gcenabled, bool usesARC) 729179064eb831125630c296556dd6d67e67f716143Ted Kremenek : Ctx(ctx), 730f85e193739c953358c865005855253af4f68a497John McCall GCEnabled(gcenabled), 731f85e193739c953358c865005855253af4f68a497John McCall ARCEnabled(usesARC), 732f85e193739c953358c865005855253af4f68a497John McCall AF(BPAlloc), ScratchArgs(AF.getEmptyMap()), 733f85e193739c953358c865005855253af4f68a497John McCall ObjCAllocRetE(gcenabled 734f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 735f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 736f85e193739c953358c865005855253af4f68a497John McCall : RetEffect::MakeOwned(RetEffect::ObjC, true))), 737f85e193739c953358c865005855253af4f68a497John McCall ObjCInitRetE(gcenabled 738f85e193739c953358c865005855253af4f68a497John McCall ? RetEffect::MakeGCNotOwned() 739f85e193739c953358c865005855253af4f68a497John McCall : (usesARC ? RetEffect::MakeARCNotOwned() 740ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose : RetEffect::MakeOwnedWhenTrackedReceiver())) { 741553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeClassMethodSummaries(); 742553cf18cd44769a7624fc942493f076498527529Ted Kremenek InitializeMethodSummaries(); 743553cf18cd44769a7624fc942493f076498527529Ted Kremenek } 7441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7454531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getSummary(const CallEvent &Call, 7464531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State = 0); 7471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7484531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getFunctionSummary(const FunctionDecl *FD); 7494531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 7504531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *getMethodSummary(Selector S, const ObjCInterfaceDecl *ID, 751f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, 752f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose QualType RetTy, 753f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries); 754f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 755cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const RetainSummary *getInstanceMethodSummary(const ObjCMethodCall &M, 7564531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State); 757dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 758cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const RetainSummary *getClassMethodSummary(const ObjCMethodCall &M) { 7594531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(!M.isInstanceMessage()); 7604531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCInterfaceDecl *Class = M.getReceiverInterface(); 7611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7624531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(M.getSelector(), Class, M.getDecl(), 7634531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose M.getResultType(), ObjCClassMethodSummaries); 764fcd7c6fc67570b906f06cd5ef606ca571ef5779aTed Kremenek } 765552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek 766552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// getMethodSummary - This version of getMethodSummary is used to query 767552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek /// the summary for the current method being analyzed. 76893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *getMethodSummary(const ObjCMethodDecl *MD) { 769a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek const ObjCInterfaceDecl *ID = MD->getClassInterface(); 77070a6576c9c8d21ff2361574f4937a2e73bd57779Ted Kremenek Selector S = MD->getSelector(); 771552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek QualType ResultTy = MD->getResultType(); 7721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 773f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy *CachedSummaries; 774552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek if (MD->isInstanceMethod()) 775f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCMethodSummaries; 776552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek else 777f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose CachedSummaries = &ObjCClassMethodSummaries; 778f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose 7794531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(S, ID, MD, ResultTy, *CachedSummaries); 780552333cfa9c91d3be656699dacf7c5e98e875ee8Ted Kremenek } 7811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 782f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const RetainSummary *getStandardMethodSummary(const ObjCMethodDecl *MD, 7834531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Selector S, QualType RetTy); 784a883355a6fe8d72b8899efb65a7d7645a51afc3bTed Kremenek 78593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7864dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const ObjCMethodDecl *MD); 7874dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 78893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek void updateSummaryFromAnnotations(const RetainSummary *&Summ, 7894dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD); 7904dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 7914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose void updateSummaryForCall(const RetainSummary *&Summ, 7924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &Call); 7934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 794d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek bool isGCEnabled() const { return GCEnabled; } 7951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 796f85e193739c953358c865005855253af4f68a497John McCall bool isARCEnabled() const { return ARCEnabled; } 797f85e193739c953358c865005855253af4f68a497John McCall 798f85e193739c953358c865005855253af4f68a497John McCall bool isARCorGCEnabled() const { return GCEnabled || ARCEnabled; } 7994531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 8004531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetEffect getObjAllocRetEffect() const { return ObjCAllocRetE; } 8014531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 8024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose friend class RetainSummaryTemplate; 8036b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek}; 8041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8050fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// Used to avoid allocating long-term (BPAlloc'd) memory for default retain 8060fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// summaries. If a function or method looks like it has a default summary, but 8070fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// it has annotations, the annotations are added to the stack-based template 8080fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose// and then copied into managed memory. 8090fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Roseclass RetainSummaryTemplate { 8100fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummaryManager &Manager; 81193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *&RealSummary; 8120fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary ScratchSummary; 8130fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose bool Accessed; 8140fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rosepublic: 8154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate(const RetainSummary *&real, RetainSummaryManager &mgr) 8164531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose : Manager(mgr), RealSummary(real), ScratchSummary(*real), Accessed(false) {} 8170fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8180fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose ~RetainSummaryTemplate() { 81993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek if (Accessed) 820ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose RealSummary = Manager.getPersistentSummary(ScratchSummary); 8210fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8220fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8230fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary &operator*() { 8240fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 82593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return ScratchSummary; 8260fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8270fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8280fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose RetainSummary *operator->() { 8290fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Accessed = true; 83093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return &ScratchSummary; 8310fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 8320fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose}; 8330fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose 8346b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} // end anonymous namespace 8356b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 8366b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8376b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek// Implementation of checker data structures. 8386b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 8396b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 840b77449cead63264650958c92cb30609c942cc5e9Ted KremenekArgEffects RetainSummaryManager::getArgEffects() { 841b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek ArgEffects AE = ScratchArgs; 8423baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.getEmptyMap(); 843b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek return AE; 84400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 84500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 84693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 847ef94588752babc1b7c46b955e57945fc4c183db2Jordy RoseRetainSummaryManager::getPersistentSummary(const RetainSummary &OldSumm) { 848ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose // Unique "simple" summaries -- those without ArgEffects. 849ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (OldSumm.isSimple()) { 850ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose llvm::FoldingSetNodeID ID; 851ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose OldSumm.Profile(ID); 852ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 853ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose void *Pos; 854ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose CachedSummaryNode *N = SimpleSummaries.FindNodeOrInsertPos(ID, Pos); 855ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 856ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose if (!N) { 857ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose N = (CachedSummaryNode *) BPAlloc.Allocate<CachedSummaryNode>(); 858ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (N) CachedSummaryNode(OldSumm); 859ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose SimpleSummaries.InsertNode(N, Pos); 860ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 861ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 862ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose return &N->getValue(); 863ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose } 864ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose 86593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek RetainSummary *Summ = (RetainSummary *) BPAlloc.Allocate<RetainSummary>(); 866ef94588752babc1b7c46b955e57945fc4c183db2Jordy Rose new (Summ) RetainSummary(OldSumm); 86700a3a5f024ac54088ab887712b292171188064f0Ted Kremenek return Summ; 86800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 86900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 870d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 871d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for functions (largely uses of Core Foundation). 872d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 87300a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 8749c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRetain(const FunctionDecl *FD, StringRef FName) { 875b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Retain"); 8761261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8771261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 8789c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic bool isRelease(const FunctionDecl *FD, StringRef FName) { 879b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer return FName.endswith("Release"); 8801261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek} 8811261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 88276c506fba2359296d1f19e64998bd11d7b864563Jordy Rosestatic bool isMakeCollectable(const FunctionDecl *FD, StringRef FName) { 88376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Remove FunctionDecl parameter. 88476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // FIXME: Is it really okay if MakeCollectable isn't a suffix? 88576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return FName.find("MakeCollectable") != StringRef::npos; 88676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 88776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 888554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaksstatic ArgEffect getStopTrackingHardEquivalent(ArgEffect E) { 8894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose switch (E) { 8904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DoNothing: 8914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case Autorelease: 8924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefBridgedTransfered: 8934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRef: 8944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRefMsg: 8954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MakeCollectable: 8964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MayEscape: 8974531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case StopTracking: 898554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case StopTrackingHard: 899554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return StopTrackingHard; 9004531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRef: 901554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefAndStopTrackingHard: 902554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return DecRefAndStopTrackingHard; 9034531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsg: 904554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefMsgAndStopTrackingHard: 905554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return DecRefMsgAndStopTrackingHard; 9064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case Dealloc: 9074531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return Dealloc; 9084531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9094531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose llvm_unreachable("Unknown ArgEffect kind"); 9114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 9124531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9134531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rosevoid RetainSummaryManager::updateSummaryForCall(const RetainSummary *&S, 9144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &Call) { 9154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Call.hasNonZeroCallbackArg()) { 916554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ArgEffect RecEffect = 917554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks getStopTrackingHardEquivalent(S->getReceiverEffect()); 918554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ArgEffect DefEffect = 919554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks getStopTrackingHardEquivalent(S->getDefaultArgEffect()); 9204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9214531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ArgEffects CustomArgEffects = S->getArgEffects(); 9224531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose for (ArgEffects::iterator I = CustomArgEffects.begin(), 9234531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = CustomArgEffects.end(); 9244531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose I != E; ++I) { 925554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ArgEffect Translated = getStopTrackingHardEquivalent(I->second); 9264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Translated != DefEffect) 9274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ScratchArgs = AF.add(ScratchArgs, I->first, Translated); 9284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 930554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks RetEffect RE = RetEffect::MakeNoRetHard(); 9314531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9324531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // Special cases where the callback argument CANNOT free the return value. 9334531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // This can generally only happen if we know that the callback will only be 9344531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // called when the return value is already being deallocated. 9354531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const FunctionCall *FC = dyn_cast<FunctionCall>(&Call)) { 9364a25f3056416aaffa7852985c2045634e5275876Jordan Rose if (IdentifierInfo *Name = FC->getDecl()->getIdentifier()) { 9374a25f3056416aaffa7852985c2045634e5275876Jordan Rose // When the CGBitmapContext is deallocated, the callback here will free 9384a25f3056416aaffa7852985c2045634e5275876Jordan Rose // the associated data buffer. 939a89f719ad3a7134e3eec7c9e03aa0e22031c0de9Jordan Rose if (Name->isStr("CGBitmapContextCreateWithData")) 940a89f719ad3a7134e3eec7c9e03aa0e22031c0de9Jordan Rose RE = S->getRetEffect(); 9414a25f3056416aaffa7852985c2045634e5275876Jordan Rose } 9424531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9434531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9444531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose S = getPersistentSummary(RE, RecEffect, DefEffect); 9454531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 9465a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9475a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Special case '[super init];' and '[self init];' 9485a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // 9495a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Even though calling '[super init]' without assigning the result to self 9505a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // and checking if the parent returns 'nil' is a bad pattern, it is common. 9515a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Additionally, our Self Init checker already warns about it. To avoid 9525a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // overwhelming the user with messages from both checkers, we model the case 9535a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // of '[super init]' in cases when it is not consumed by another expression 9545a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // as if the call preserves the value of 'self'; essentially, assuming it can 9555a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // never fail and return 'nil'. 9565a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Note, we don't want to just stop tracking the value since we want the 9575a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // RetainCount checker to report leaks and use-after-free if SelfInit checker 9585a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // is turned off. 9595a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (const ObjCMethodCall *MC = dyn_cast<ObjCMethodCall>(&Call)) { 9605a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (MC->getMethodFamily() == OMF_init && MC->isReceiverSelfOrSuper()) { 9615a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9625a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // Check if the message is not consumed, we know it will not be used in 9635a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks // an assignment, ex: "self = [super init]". 9645a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks const Expr *ME = MC->getOriginExpr(); 9655a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks const LocationContext *LCtx = MC->getLocationContext(); 9665a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ParentMap &PM = LCtx->getAnalysisDeclContext()->getParentMap(); 9675a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks if (!PM.isConsumedExpr(ME)) { 9685a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks RetainSummaryTemplate ModifiableSummaryTemplate(S, *this); 9695a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ModifiableSummaryTemplate->setReceiverEffect(DoNothing); 9705a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks ModifiableSummaryTemplate->setRetEffect(RetEffect::MakeNoRet()); 9715a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9725a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9735a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks 9745a90193ad825656d4a03099cd5e9c928d1782b5eAnna Zaks } 9754531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 9764531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 9774531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Roseconst RetainSummary * 9784531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getSummary(const CallEvent &Call, 9794531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State) { 9804531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ; 9814531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose switch (Call.getKind()) { 9824531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_Function: 9834531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getFunctionSummary(cast<FunctionCall>(Call).getDecl()); 9844531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 9854531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_CXXMember: 986fdaa33818cf9bad8d092136e73bd2e489cb821baJordan Rose case CE_CXXMemberOperator: 9874531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_Block: 9884531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case CE_CXXConstructor: 9898d276d38c258dfc572586daf6c0e8f8fce249c0eJordan Rose case CE_CXXDestructor: 99070cbf3cc09eb21db1108396d30a414ea66d842ccJordan Rose case CE_CXXAllocator: 9914531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: These calls are currently unsupported. 9924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getPersistentStopSummary(); 9938919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case CE_ObjCMessage: { 994cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCMethodCall &Msg = cast<ObjCMethodCall>(Call); 9954531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (Msg.isInstanceMessage()) 9964531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getInstanceMethodSummary(Msg, State); 9974531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose else 9984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Summ = getClassMethodSummary(Msg); 9994531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 10004531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 10014531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 10024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 10034531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose updateSummaryForCall(Summ, Call); 10044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 10054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Unknown call type?"); 10064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return Summ; 10074531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose} 10084531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 100958822c403cc8855adeecba92248612ee08dc1f3aAnna Zaksconst RetainSummary * 10104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getFunctionSummary(const FunctionDecl *FD) { 10114531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we don't know what function we're calling, use our default summary. 10124531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!FD) 10134531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getDefaultSummary(); 10144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 1015891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek // Look up a summary in our cache of FunctionDecls -> Summaries. 1016d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummariesTy::iterator I = FuncSummaries.find(FD); 1017d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek if (I != FuncSummaries.end()) 1018891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek return I->second; 1019891d5ccc465600e003c505c22069e0e1e0798eccTed Kremenek 1020e401a0ce4ac2b77c69ee08c09eb04a3a41652fd6Ted Kremenek // No summary? Generate one. 102193edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *S = 0; 102215d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose bool AllowAnnotations = true; 10231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 102437d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek do { 10251261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // We generate "stop" summaries for implicitly defined functions. 10261261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FD->isImplicit()) { 10271261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getPersistentStopSummary(); 10281261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 10291261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 10301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1031183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall // [PR 3337] Use 'getAs<FunctionType>' to strip away any typedefs on the 103299890659385f052412d479e8569b10069ac2b12bTed Kremenek // function's type. 1033183700f494ec9b6701b6efe82bcb25f4c79ba561John McCall const FunctionType* FT = FD->getType()->getAs<FunctionType>(); 103448c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek const IdentifierInfo *II = FD->getIdentifier(); 103548c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek if (!II) 103648c6d181dfcba412ae4b9e1dab59205913018806Ted Kremenek break; 1037b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer 1038b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer StringRef FName = II->getName(); 10391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1040bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // Strip away preceding '_'. Doing this here will effect all the checks 1041bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek // down below. 1042b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.find_first_not_of('_')); 10431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10441261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Inspect the result type. 10451261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek QualType RetTy = FT->getResultType(); 10461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10471261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // FIXME: This should all be refactored into a chain of "summary lookup" 10481261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // filters. 1049008636ab8acbcc58954c7173f9563aefa510b252Ted Kremenek assert(ScratchArgs.isEmpty()); 1050e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1051befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek if (FName == "pthread_create" || FName == "pthread_setspecific") { 1052befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // Part of: <rdar://problem/7299394> and <rdar://problem/11282706>. 1053befc6d2eae269efa2da9c81d0be8dba144a74d47Ted Kremenek // This will be addressed better with IPA. 1054b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentStopSummary(); 1055b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "NSMakeCollectable") { 1056b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Handle: id NSMakeCollectable(CFTypeRef) 1057b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = (RetTy->isObjCIdType()) 1058b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer ? getUnarySummary(FT, cfmakecollectable) 1059b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer : getPersistentStopSummary(); 106015d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose // The headers on OS X 10.8 use cf_consumed/ns_returns_retained, 106115d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose // but we can fully model NSMakeCollectable ourselves. 106215d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose AllowAnnotations = false; 1063061707a86f20bf608758e7013df24bd1be12ffc6Ted Kremenek } else if (FName == "CFPlugInInstanceCreate") { 1064061707a86f20bf608758e7013df24bd1be12ffc6Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet()); 1065b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOBSDNameMatching" || 1066b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceMatching" || 1067b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceNameMatching" || 1068537dd3a8c87765245aad792a3356852a87380a30Ted Kremenek FName == "IORegistryEntrySearchCFProperty" || 1069b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IORegistryEntryIDMatching" || 1070b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOOpenFirmwarePathMatching") { 1071b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 1072b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 1073b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 1074b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 1075b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceGetMatchingService" || 1076b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceGetMatchingServices") { 1077b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/6326900> 1078b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. This strcmp is also 1079b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a little gross, but there is no need to super optimize here. 10803baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, DecRef); 1081b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1082b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "IOServiceAddNotification" || 1083b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName == "IOServiceAddMatchingNotification") { 1084b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Part of <rdar://problem/6961230>. (IOKit) 1085b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // This should be addressed using a API table. 10863baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 2, DecRef); 1087b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1088b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithBytes") { 1089b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 1090b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 1091b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithBytes is released via 1092b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 1093b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXME: This function has an out parameter that returns an 1094b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // allocated object. 10953baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 7, StopTracking); 1096b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1097b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CGBitmapContextCreateWithData") { 1098b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7358899> 1099b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that 'releaseInfo' 1100b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // passed to CGBitmapContextCreateWithData is released via 1101b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // a callback and doing full IPA to make sure this is done correctly. 11023baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 8, StopTracking); 1103b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true), 1104b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer DoNothing, DoNothing); 1105b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer } else if (FName == "CVPixelBufferCreateWithPlanarBytes") { 1106b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // FIXES: <rdar://problem/7283567> 1107b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // Eventually this can be improved by recognizing that the pixel 1108b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // buffer passed to CVPixelBufferCreateWithPlanarBytes is released 1109b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // via a callback and doing full IPA to make sure this is done 1110b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer // correctly. 11113baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 12, StopTracking); 1112b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 111306911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek } else if (FName == "dispatch_set_context") { 111406911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // <rdar://problem/11059275> - The analyzer currently doesn't have 111506911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // a good way to reason about the finalizer function for libdispatch. 111606911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // If we pass a context object that is memory managed, stop tracking it. 111706911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // FIXME: this hack should possibly go away once we can handle 111806911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek // libdispatch finalizers. 111906911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 112006911d4e88b1a6ca7ec3b2d8e234e679a4c09ff9Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1121c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek } else if (FName.startswith("NSLog")) { 1122c91fdf662d4f453ce9bb975b25cec348d0ced9c6Ted Kremenek S = getDoNothingSummary(); 112362a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks } else if (FName.startswith("NS") && 112462a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks (FName.find("Insert") != StringRef::npos)) { 112562a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // Whitelist NSXXInsertXX, for example NSMapInsertIfAbsent, since they can 112662a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks // be deallocated by NSMapRemove. (radar://11152419) 112762a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 1, StopTracking); 112862a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks ScratchArgs = AF.add(ScratchArgs, 2, StopTracking); 112962a5c34ddc54696725683f6c5af1c8e1592c5c38Anna Zaks S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 1130b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 11311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1132b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek // Did we get a summary? 1133b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek if (S) 1134b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek break; 113561991903335144605031c3597a5c99e1565b0bd4Ted Kremenek 11365aff3f1e9a66fa72576a6b04c8c319c17e0360c6Jordan Rose if (RetTy->isPointerType()) { 11371261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreFoundation ('CF') types. 113878acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CF", FName)) { 11391261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 11401261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 114176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose else if (isMakeCollectable(FD, FName)) 11421261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfmakecollectable); 11431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 11447df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 11451261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 114637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 114737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11481261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11491261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For CoreGraphics ('CG') types. 115078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "CG", FName)) { 11511261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (isRetain(FD, FName)) 11521261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfretain); 11531261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else 11547df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 11551261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 115637d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek break; 115737d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11581261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11591261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // For the Disk Arbitration API (DiskArbitration/DADisk.h) 116078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isRefType(RetTy, "DADisk") || 116178acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DADissenter") || 116278acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek cocoa::isRefType(RetTy, "DASessionRef")) { 11637df2ff45f101c87398329d0ea23c1377328dca40John McCall S = getCFCreateGetRuleSummary(FD); 1164706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek break; 1165706522f1d5c1545a074ed336fb3fd72f005c367eTed Kremenek } 11661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11675aff3f1e9a66fa72576a6b04c8c319c17e0360c6Jordan Rose if (FD->getAttr<CFAuditedTransferAttr>()) { 11685aff3f1e9a66fa72576a6b04c8c319c17e0360c6Jordan Rose S = getCFCreateGetRuleSummary(FD); 11695aff3f1e9a66fa72576a6b04c8c319c17e0360c6Jordan Rose break; 11705aff3f1e9a66fa72576a6b04c8c319c17e0360c6Jordan Rose } 11715aff3f1e9a66fa72576a6b04c8c319c17e0360c6Jordan Rose 11721261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek break; 117337d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 11741261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek 11751261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Check for release functions, the only kind of functions that we care 11761261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // about that don't return a pointer type. 11771261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (FName[0] == 'C' && (FName[1] == 'F' || FName[1] == 'G')) { 1178e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek // Test for 'CGCF'. 1179b6f3c70fb8a0def24bcaa937dc28358f20859c73Benjamin Kramer FName = FName.substr(FName.startswith("CGCF") ? 4 : 2); 1180e7d03121afaba80ccfdde83d3584149e301ec5afTed Kremenek 1181bf0a4dd2252408281cf9179c566af928699aab43Ted Kremenek if (isRelease(FD, FName)) 11821261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek S = getUnarySummary(FT, cfrelease); 11831261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek else { 1184b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 11856818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // Remaining CoreFoundation and CoreGraphics functions. 11866818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We use to assume that they all strictly followed the ownership idiom 11876818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // and that ownership cannot be transferred. While this is technically 11886818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // correct, many methods allow a tracked object to escape. For example: 11896818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 11901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFMutableDictionaryRef x = CFDictionaryCreateMutable(...); 11916818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // CFDictionaryAddValue(y, key, x); 11921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // CFRelease(x); 11936818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // ... it is okay to use 'x' since 'y' has a reference to it 11946818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // 11956818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek // We handle this and similar cases with the follow heuristic. If the 1196c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // function name contains "InsertValue", "SetValue", "AddValue", 1197c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "AppendValue", or "SetAttribute", then we assume that arguments may 1198c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // "escape." This means that something else holds on to the object, 1199c484381467789938b06872bb1b270db1b6ec164cTed Kremenek // allowing it be used even after its local retain count drops to 0. 1200e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer ArgEffect E = (StrInStrNoCase(FName, "InsertValue") != StringRef::npos|| 1201e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AddValue") != StringRef::npos || 1202e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "SetValue") != StringRef::npos || 1203e45c149996ccd0f2ac1da95493b8563c108abc1fBenjamin Kramer StrInStrNoCase(FName, "AppendValue") != StringRef::npos|| 1204c027e54d669b8217a4c466f83aebee1a7c2c2e63Benjamin Kramer StrInStrNoCase(FName, "SetAttribute") != StringRef::npos) 12056818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek ? MayEscape : DoNothing; 12061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12076818928f39603e8c97f04ec0c3f467084e22ac85Ted Kremenek S = getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, E); 12081261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek } 120964e859a36634dfc848634d22aa428a48f82487d3Ted Kremenek } 121037d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek } 121137d785bf2b318cc1206e2653c914acc5295bb38cTed Kremenek while (0); 12121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12134531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we got all the way here without any luck, use a default summary. 12144531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!S) 12154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose S = getDefaultSummary(); 12164531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 12174dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Annotations override defaults. 121815d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose if (AllowAnnotations) 121915d18e15384c9e992bd294fc56f4fdf770763d71Jordan Rose updateSummaryFromAnnotations(S, FD); 12201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1221d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek FuncSummaries[FD] = S; 12221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 12232fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek} 12242fff37ecce1efd21ecb9bb4937dca83bdea715ffTed Kremenek 122593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12267df2ff45f101c87398329d0ea23c1377328dca40John McCallRetainSummaryManager::getCFCreateGetRuleSummary(const FunctionDecl *FD) { 12277df2ff45f101c87398329d0ea23c1377328dca40John McCall if (coreFoundation::followsCreateRule(FD)) 122886ad3bcfc9ec027d293ec67319e5a9926b38e665Ted Kremenek return getCFSummaryCreateRule(FD); 12291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1230d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek return getCFSummaryGetRule(FD); 123100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 123200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 123393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12346ad315a4bee79827a79575c7b3aa47014bcb3849Ted KremenekRetainSummaryManager::getUnarySummary(const FunctionType* FT, 12356ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek UnaryFuncKind func) { 12366ad315a4bee79827a79575c7b3aa47014bcb3849Ted Kremenek 12371261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // Sanity check that this is *really* a unary function. This can 12381261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek // happen if people do weird things. 123972564e73277e29f6db3305d1f27ba408abb7ed88Douglas Gregor const FunctionProtoType* FTP = dyn_cast<FunctionProtoType>(FT); 12401261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek if (!FTP || FTP->getNumArgs() != 1) 12411261938ec42b0a1b82bec5fe901b7fc02a23d9a1Ted Kremenek return getPersistentStopSummary(); 12421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1243b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 12441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 124576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ArgEffect Effect; 1246377e2306a67f3668bc63fb057a09699cdc7288e6Ted Kremenek switch (func) { 124776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfretain: Effect = IncRef; break; 124876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfrelease: Effect = DecRef; break; 124976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose case cfmakecollectable: Effect = MakeCollectable; break; 1250940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek } 125176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 125276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose ScratchArgs = AF.add(ScratchArgs, 0, Effect); 125376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); 125400a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 125500a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 125693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12579c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryCreateRule(const FunctionDecl *FD) { 1258b77449cead63264650958c92cb30609c942cc5e9Ted Kremenek assert (ScratchArgs.isEmpty()); 12591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12602d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 126100a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 126200a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 126393edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 12649c378f705405d37f49795d5e915989de774fe11fTed KremenekRetainSummaryManager::getCFSummaryGetRule(const FunctionDecl *FD) { 12651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 12662d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek return getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::CF), 12672d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek DoNothing, DoNothing); 126800a3a5f024ac54088ab887712b292171188064f0Ted Kremenek} 126900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek 12706b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 1271d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek// Summary creation for Selectors. 1272d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1273d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek 12744dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 127593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 12764dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek const FunctionDecl *FD) { 12774dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!FD) 12784dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 12794dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 12804531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Must have a summary to add annotations to."); 12814531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate Template(Summ, *this); 12824df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 128311fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 128411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 128511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek for (FunctionDecl::param_const_iterator pi = FD->param_begin(), 128698b8f16a0b056919f24206a8a3ca86f9ea75fa34John McCall pe = FD->param_end(); pi != pe; ++pi, ++parm_idx) { 128711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 128811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 12894df54feb02d72b76249e846053d5d53d820bf832Jordy Rose if (!GCEnabled) { 12900fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 12914df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } 12924df54feb02d72b76249e846053d5d53d820bf832Jordy Rose } else if (pd->getAttr<CFConsumedAttr>()) { 12930fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 129411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 129511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 129611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 1297b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek QualType RetTy = FD->getResultType(); 12981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12994dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 130078acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(RetTy)) { 130140b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<NSReturnsRetainedAttr>()) { 13020fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 13034dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 130440b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis else if (FD->getAttr<CFReturnsRetainedAttr>()) { 13050fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 1306b04cb59463ae3e7d72890f044378f67540fadc43Ted Kremenek } 1307bbf4d53343c2bbd082b7c1488f34650a7d07ae3bTed Kremenek else if (FD->getAttr<NSReturnsNotRetainedAttr>() || 1308bbf4d53343c2bbd082b7c1488f34650a7d07ae3bTed Kremenek FD->getAttr<NSReturnsAutoreleasedAttr>()) { 13090fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 13106041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 1311bbf4d53343c2bbd082b7c1488f34650a7d07ae3bTed Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) 13120fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 13136041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 1314bbf4d53343c2bbd082b7c1488f34650a7d07ae3bTed Kremenek else if (RetTy->getAs<PointerType>()) { 131540b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (FD->getAttr<CFReturnsRetainedAttr>()) { 13160fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 13174dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1318d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek else if (FD->getAttr<CFReturnsNotRetainedAttr>()) { 13190fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 1320d1e015eb441910937c74d489970322a3a3491a67Ted Kremenek } 13214dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 13224dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 13234dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 13244dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenekvoid 132593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed KremenekRetainSummaryManager::updateSummaryFromAnnotations(const RetainSummary *&Summ, 132693edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const ObjCMethodDecl *MD) { 13274dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek if (!MD) 13284dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek return; 13294dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 13304531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose assert(Summ && "Must have a valid summary to add annotations to"); 13314531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetainSummaryTemplate Template(Summ, *this); 13326d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek bool isTrackedLoc = false; 13331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 133412b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek // Effects on the receiver. 133512b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek if (MD->getAttr<NSConsumesSelfAttr>()) { 133611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 13370fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setReceiverEffect(DecRefMsg); 133811fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 133911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek 134011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek // Effects on the parameters. 134111fe175346242744bd9cb4040f3c84e243934134Ted Kremenek unsigned parm_idx = 0; 1342491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis for (ObjCMethodDecl::param_const_iterator 1343491306a83c4f0f49f95a3bcbca8580cb98a91c7aArgyrios Kyrtzidis pi=MD->param_begin(), pe=MD->param_end(); 134411fe175346242744bd9cb4040f3c84e243934134Ted Kremenek pi != pe; ++pi, ++parm_idx) { 134511fe175346242744bd9cb4040f3c84e243934134Ted Kremenek const ParmVarDecl *pd = *pi; 134611fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (pd->getAttr<NSConsumedAttr>()) { 134711fe175346242744bd9cb4040f3c84e243934134Ted Kremenek if (!GCEnabled) 13480fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 134911fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 135011fe175346242744bd9cb4040f3c84e243934134Ted Kremenek else if(pd->getAttr<CFConsumedAttr>()) { 13510fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->addArg(AF, parm_idx, DecRef); 135211fe175346242744bd9cb4040f3c84e243934134Ted Kremenek } 135312b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek } 135412b9434d5bf801e24242b1f6fd04899f8a7fa92cTed Kremenek 13554dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek // Determine if there is a special return effect for this method. 135678acdbfb522f62b6e8899e078e48fea44fda287dTed Kremenek if (cocoa::isCocoaObjectRef(MD->getResultType())) { 135740b598eea1310ec9ed554d56ce3e25b34c585458Argyrios Kyrtzidis if (MD->getAttr<NSReturnsRetainedAttr>()) { 13580fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(ObjCAllocRetE); 13596d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek return; 13604dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek } 1361bbf4d53343c2bbd082b7c1488f34650a7d07ae3bTed Kremenek if (MD->getAttr<NSReturnsNotRetainedAttr>() || 1362bbf4d53343c2bbd082b7c1488f34650a7d07ae3bTed Kremenek MD->getAttr<NSReturnsAutoreleasedAttr>()) { 13630fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::ObjC)); 13646041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek return; 13656041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13676d4b76d93cbc5ad05af4cd2815c86febbfd5e798Ted Kremenek isTrackedLoc = true; 13680fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } else { 13696217b80b7a1379b74cced1c076338262c3c980b3Ted Kremenek isTrackedLoc = MD->getResultType()->getAs<PointerType>() != NULL; 13700fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose } 13711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13726041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (isTrackedLoc) { 13736041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek if (MD->getAttr<CFReturnsRetainedAttr>()) 13740fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeOwned(RetEffect::CF, true)); 13756041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek else if (MD->getAttr<CFReturnsNotRetainedAttr>()) 13760fe62f8a8c6d9f75842cd8f8349ca7b80952f785Jordy Rose Template->setRetEffect(RetEffect::MakeNotOwned(RetEffect::CF)); 13776041111f3749e76a1712ec58dd17449bd3177dddTed Kremenek } 13784dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek} 13794dd8fb4f3dab42426641a0aab3d6d6a72bb1eec9Ted Kremenek 138093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1381f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy RoseRetainSummaryManager::getStandardMethodSummary(const ObjCMethodDecl *MD, 1382f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Selector S, QualType RetTy) { 1383e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Any special effects? 13848ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek ArgEffect ReceiverEff = DoNothing; 1385e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose RetEffect ResultEff = RetEffect::MakeNoRet(); 1386e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose 1387e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Check the method family, and apply any default annotations. 1388e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (MD ? MD->getMethodFamily() : S.getMethodFamily()) { 1389e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_None: 1390e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_performSelector: 1391e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // Assume all Objective-C methods follow Cocoa Memory Management rules. 1392e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // FIXME: Does the non-threaded performSelector family really belong here? 1393e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // The selector could be, say, @selector(copy). 1394e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1395e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::ObjC); 1396e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) { 1397e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // ObjCMethodDecl currently doesn't consider CF objects as valid return 1398e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // values for alloc, new, copy, or mutableCopy, so we have to 1399e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // double-check with the selector. This is ugly, but there aren't that 1400e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // many Objective-C methods that return CF objects, right? 1401e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (MD) { 1402e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose switch (S.getMethodFamily()) { 1403e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1404e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1405e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1406e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1407e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1408e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1409e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose default: 1410e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1411e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1412e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1413e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } else { 1414e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeNotOwned(RetEffect::CF); 1415e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1416e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 1417e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1418e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_init: 1419e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCInitRetE; 1420e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1421e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1422e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_alloc: 1423e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_new: 1424e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_copy: 1425e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_mutableCopy: 1426e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (cocoa::isCocoaObjectRef(RetTy)) 1427e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = ObjCAllocRetE; 1428e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose else if (coreFoundation::isCFObjectRef(RetTy)) 1429e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff = RetEffect::MakeOwned(RetEffect::CF, true); 1430e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1431e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_autorelease: 1432e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Autorelease; 1433e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1434e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retain: 1435e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = IncRefMsg; 1436e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1437e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_release: 1438e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = DecRefMsg; 1439e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1440e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_dealloc: 1441e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ReceiverEff = Dealloc; 1442e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1443e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_self: 1444e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // -self is handled specially by the ExprEngine to propagate the receiver. 1445e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1446e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_retainCount: 1447e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose case OMF_finalize: 1448e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose // These methods don't return objects. 1449e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose break; 1450e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose } 14511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14528ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // If one of the arguments in the selector has the keyword 'delegate' we 14538ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // should stop tracking the reference count for the receiver. This is 14548ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // because the reference count is quite possibly handled by a delegate 14558ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek // method. 14568ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek if (S.isKeywordSelector()) { 145750571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose for (unsigned i = 0, e = S.getNumArgs(); i != e; ++i) { 145850571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose StringRef Slot = S.getNameForSlot(i); 145950571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (Slot.substr(Slot.size() - 8).equals_lower("delegate")) { 146050571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose if (ResultEff == ObjCInitRetE) 1461554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ResultEff = RetEffect::MakeNoRetHard(); 146250571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose else 1463554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ReceiverEff = StopTrackingHard; 146450571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 146550571a9fd8871c722e8655c7c2c3b2871a0d14c1Jordan Rose } 14668ee885bae5e8b187a73f3d4671b1619969e5e080Ted Kremenek } 14671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1468e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose if (ScratchArgs.isEmpty() && ReceiverEff == DoNothing && 1469e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose ResultEff.getKind() == RetEffect::NoRet) 147093edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek return getDefaultSummary(); 14711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1472e921b1a8b6b6f47abbc9b3de47cc74a34db2852bJordy Rose return getPersistentSummary(ResultEff, ReceiverEff, MayEscape); 1473250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek} 1474250b1fa29002d9c4b81ddc65efe6d15f074ee290Ted Kremenek 147593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 1476cde8cdbd6a662c636164465ad309b5f17ff01064Jordan RoseRetainSummaryManager::getInstanceMethodSummary(const ObjCMethodCall &Msg, 14774531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ProgramStateRef State) { 14784531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCInterfaceDecl *ReceiverClass = 0; 14794531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 14804531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // We do better tracking of the type of the object than the core ExprEngine. 14814531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // See if we have its type in our private state. 14824531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: Eventually replace the use of state->get<RefBindings> with 14834531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // a generic API for reasoning about the Objective-C types of symbolic 14844531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // objects. 14854531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose SVal ReceiverV = Msg.getReceiverSVal(); 14864531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (SymbolRef Sym = ReceiverV.getAsLocSymbol()) 14878d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(State, Sym)) 14884531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (const ObjCObjectPointerType *PT = 1489b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek T->getType()->getAs<ObjCObjectPointerType>()) 14904531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverClass = PT->getInterfaceDecl(); 1491dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 14924531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // If we don't know what kind of object this is, fall back to its static type. 14934531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!ReceiverClass) 14944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverClass = Msg.getReceiverInterface(); 149504badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor 1496b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // FIXME: The receiver could be a reference to a class, meaning that 1497b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek // we should use the class method. 14984531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // id x = [NSObject class]; 14994531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // [x performSelector:... withObject:... afterDelay:...]; 15004531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Selector S = Msg.getSelector(); 15014531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const ObjCMethodDecl *Method = Msg.getDecl(); 15024531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!Method && ReceiverClass) 15034531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose Method = ReceiverClass->getInstanceMethod(S); 15044531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 15054531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose return getMethodSummary(S, ReceiverClass, Method, Msg.getResultType(), 15064531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ObjCMethodSummaries); 1507b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek} 1508b7ddd9ba802a5bba8dedea39e53a1a93db47b631Ted Kremenek 150993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenekconst RetainSummary * 15104531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan RoseRetainSummaryManager::getMethodSummary(Selector S, const ObjCInterfaceDecl *ID, 1511f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose const ObjCMethodDecl *MD, QualType RetTy, 1512f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose ObjCMethodSummariesTy &CachedSummaries) { 15131bffd7471bf3d392a3bc0e241c8d169cbde96156Ted Kremenek 15148711c03dda12863a7537f14025513f7717b14ce1Ted Kremenek // Look up a summary in our summary cache. 15154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ = CachedSummaries.find(ID, S); 15161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1517614cc540a617978814e37d75bf5066926b921a0aTed Kremenek if (!Summ) { 1518f3aae58296fd5f930f7c4c0709886924e6822ae7Jordy Rose Summ = getStandardMethodSummary(MD, S, RetTy); 15194df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1520614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Annotations override defaults. 15214df54feb02d72b76249e846053d5d53d820bf832Jordy Rose updateSummaryFromAnnotations(Summ, MD); 15224df54feb02d72b76249e846053d5d53d820bf832Jordy Rose 1523614cc540a617978814e37d75bf5066926b921a0aTed Kremenek // Memoize the summary. 15244531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose CachedSummaries[ObjCSummaryKey(ID, S)] = Summ; 1525614cc540a617978814e37d75bf5066926b921a0aTed Kremenek } 15261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1527e87450e5a398543b85205b3255d4c36204c00182Ted Kremenek return Summ; 1528c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek} 1529c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek 15301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid RetainSummaryManager::InitializeClassMethodSummaries() { 1531ec3153360625b9c24e12d1b10668815271703a6eTed Kremenek assert(ScratchArgs.isEmpty()); 15321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Create the [NSAssertionHandler currentHander] summary. 15336fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAssertionHandler", "currentHandler", 15342d1652e0f5a94c62ac2390a2e829d0094b12cf7aTed Kremenek getPersistentSummary(RetEffect::MakeNotOwned(RetEffect::ObjC))); 15351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15366d34893fc886f4153f104de8880876764981cb7fTed Kremenek // Create the [NSAutoreleasePool addObject:] summary. 15373baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek ScratchArgs = AF.add(ScratchArgs, 0, Autorelease); 15386fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek addClassMethSummary("NSAutoreleasePool", "addObject", 15396fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek getPersistentSummary(RetEffect::MakeNoRet(), 15406fe2b7a3da783395379b12c75e4e7608809f9062Ted Kremenek DoNothing, Autorelease)); 15419c32d08925045b32d7c39516e35d860159252e1dTed Kremenek} 15429c32d08925045b32d7c39516e35d860159252e1dTed Kremenek 15431f180c3128866c031a2a266b5131590155237337Ted Kremenekvoid RetainSummaryManager::InitializeMethodSummaries() { 15441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert (ScratchArgs.isEmpty()); 15461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1547c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // Create the "init" selector. It just acts as a pass-through for the 1548c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // receiver. 154993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *InitSumm = getPersistentSummary(ObjCInitRetE, DecRefMsg); 1550ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetNullarySelector("init", Ctx), InitSumm); 1551ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek 1552ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // awakeAfterUsingCoder: behaves basically like an 'init' method. It 1553ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek // claims the receiver and returns a retained object. 1554ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek addNSObjectMethSummary(GetUnarySelector("awakeAfterUsingCoder", Ctx), 1555ac02f20424d35121f66c7271b1a8538df8149188Ted Kremenek InitSumm); 15561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1557c839560d1b3eda7e4674dd7f139217ce0b600dc4Ted Kremenek // The next methods are allocators. 155893edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *AllocSumm = getPersistentSummary(ObjCAllocRetE); 155993edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *CFAllocSumm = 1560a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek getPersistentSummary(RetEffect::MakeOwned(RetEffect::CF, true)); 15611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15623c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "retain" selector. 1563500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose RetEffect NoRet = RetEffect::MakeNoRet(); 156493edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *Summ = getPersistentSummary(NoRet, IncRefMsg); 1565553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); 15661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15673c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "release" selector. 1568500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, DecRefMsg); 1569553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); 15701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1571f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek // Create the -dealloc summary. 1572500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Dealloc); 1573f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek addNSObjectMethSummary(GetNullarySelector("dealloc", Ctx), Summ); 15743c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek 15753c0cea3957df9ea4374d3cafc58af7bfc49a9765Ted Kremenek // Create the "autorelease" selector. 1576500abad7edfcc2409b18dd616cdbc28a094926f5Jordy Rose Summ = getPersistentSummary(NoRet, Autorelease); 1577553cf18cd44769a7624fc942493f076498527529Ted Kremenek addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); 15781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // For NSWindow, allocated objects are (initially) self-owned. 158089e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // FIXME: For now we opt for false negatives with NSWindow, as these objects 158189e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // self-own themselves. However, they only do this once they are displayed. 158289e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // Thus, we need to track an NSWindow's display status. 158389e202d6a42eb42f3d6025c4d6e4b885bee84e0aTed Kremenek // This is tracked in <rdar://problem/6062711>. 15843aa7ecd53f8e4965188fbbf33a82380c798f309cTed Kremenek // See also http://llvm.org/bugs/show_bug.cgi?id=3714. 158593edbc5269c166e3ab50ccb323b934c7bdf07c3cTed Kremenek const RetainSummary *NoTrackYet = getPersistentSummary(RetEffect::MakeNoRet(), 158678a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking, 158778a35a3900b39702ffb9835702a1329f8d3e04b3Ted Kremenek StopTracking); 15881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 158999d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSWindow", "alloc", NoTrackYet); 159099d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek 1591179064eb831125630c296556dd6d67e67f716143Ted Kremenek // For NSPanel (which subclasses NSWindow), allocated objects are not 1592179064eb831125630c296556dd6d67e67f716143Ted Kremenek // self-owned. 159399d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // FIXME: For now we don't track NSPanels. object for the same reason 159499d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek // as for NSWindow objects. 159599d026939024471a9e43267593d2ddff9f61ce46Ted Kremenek addClassMethSummary("NSPanel", "alloc", NoTrackYet); 15961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1597e36d81b1eeab13fb1bbd15291d009a1699de6ec1Jordan Rose // Don't track allocated autorelease pools, as it is okay to prematurely 1598ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek // exit a method. 1599ba67f6aa95733aaa9d79c82a8802e67b84e5d8e5Ted Kremenek addClassMethSummary("NSAutoreleasePool", "alloc", NoTrackYet); 1600a979712238d6285e79e8f1d6e8b813a1f640e88cTed Kremenek addClassMethSummary("NSAutoreleasePool", "allocWithZone", NoTrackYet, false); 1601e36d81b1eeab13fb1bbd15291d009a1699de6ec1Jordan Rose addClassMethSummary("NSAutoreleasePool", "new", NoTrackYet); 1602553cf18cd44769a7624fc942493f076498527529Ted Kremenek 1603767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek // Create summaries QCRenderer/QCView -createSnapShotImageOfType: 1604767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCRenderer", AllocSumm, 1605767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1606767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek addInstMethSummary("QCView", AllocSumm, 1607767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createSnapshotImageOfType", NULL); 1608767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek 1609211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek // Create summaries for CIContext, 'createCGImage' and 1610a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // 'createCGLayerWithSize'. These objects are CF objects, and are not 1611a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek // automatically garbage collected. 1612a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 1613767d649c5353ca19c5a1e181783240a0994bb20aTed Kremenek "createCGImage", "fromRect", NULL); 1614a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, 16151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump "createCGImage", "fromRect", "format", "colorSpace", NULL); 1616a834fb43fddcf611ad248722fff1aa5b19807bedTed Kremenek addInstMethSummary("CIContext", CFAllocSumm, "createCGLayerWithSize", 1617211a9c66693cb75f32507fce8be1170cca54a36aTed Kremenek "info", NULL); 1618b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek} 1619b3c3c28c6574ada3e458d7606b8826f15412af6fTed Kremenek 1620d3dbcf4be7025fae5ce71125ec6d217d1ea3db8fTed Kremenek//===----------------------------------------------------------------------===// 1621c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Error reporting. 1622c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 1623c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremeneknamespace { 1624ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose typedef llvm::DenseMap<const ExplodedNode *, const RetainSummary *> 1625ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLogTy; 1626ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose 1627c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===-------------===// 1628c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Descriptions. // 16291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump //===-------------===// 16301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1631ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefBug : public BugType { 1632c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek protected: 163335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefBug(StringRef name) 16346fd4505ad67a186da8cc26fdb493c93fe4937555Ted Kremenek : BugType(name, categories::MemoryCoreFoundationObjectiveC) {} 1635c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 16361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1637c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Eventually remove. 163835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose virtual const char *getDescription() const = 0; 16391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1640c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek virtual bool isLeak() const { return false; } 1641c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1643ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class UseAfterRelease : public CFRefBug { 1644c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 164535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose UseAfterRelease() : CFRefBug("Use-after-release") {} 16461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 164735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1648c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "Reference-counted object is used after it is released"; 16491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1650c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1652ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class BadRelease : public CFRefBug { 1653c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 165435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose BadRelease() : CFRefBug("Bad release") {} 16551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 165635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { 1657bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek return "Incorrect decrement of the reference count of an object that is " 1658bb206fdd9d4465fee4336e6a12d7e936add17389Ted Kremenek "not owned at this point by the caller"; 1659b8873558cf16893989778095cff342ae2adbc56aTed Kremenek } 1660c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1662ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocGC : public CFRefBug { 1663c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 166435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocGC() 166535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc called while using garbage collection") {} 16661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1667c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1668369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek return "-dealloc called while using garbage collection"; 16691499389d005d2d2eafd3cf8f52f56c0d54e400d6Ted Kremenek } 1670c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 16711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1672ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class DeallocNotOwned : public CFRefBug { 1673c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 167435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose DeallocNotOwned() 167535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("-dealloc sent to non-exclusively owned object") {} 16761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1677c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const char *getDescription() const { 1678c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return "-dealloc sent to object that may be referenced elsewhere"; 167900a3a5f024ac54088ab887712b292171188064f0Ted Kremenek } 16801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 16811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1682ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class OverAutorelease : public CFRefBug { 1683369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek public: 168435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose OverAutorelease() 168535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Object sent -autorelease too many times") {} 16861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1687369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek const char *getDescription() const { 1688eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek return "Object sent -autorelease too many times"; 1689369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek } 1690369de565a7d710ba9c672a488d48f6c6ea3f39adTed Kremenek }; 16911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1692ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class ReturnedNotOwnedForOwned : public CFRefBug { 1693e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek public: 169435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose ReturnedNotOwnedForOwned() 169535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefBug("Method should return an owned object") {} 16961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1697e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek const char *getDescription() const { 16985b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose return "Object with a +0 retain count returned to caller where a +1 " 1699e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek "(owning) retain count is expected"; 1700e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 1701e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek }; 17021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1703ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class Leak : public CFRefBug { 1704facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer public: 1705facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer Leak(StringRef name) 1706facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer : CFRefBug(name) { 1707db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose // Leaks should not be reported if they are post-dominated by a sink. 1708db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose setSuppressOnSink(true); 1709db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 17101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 171135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose const char *getDescription() const { return ""; } 17121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1713c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek bool isLeak() const { return true; } 1714c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 17151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1716c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 1717c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Bug Reports. // 1718c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek //===---------===// 17191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1720011534973e83db51f49098871186238fc64d5f54Jordy Rose class CFRefReportVisitor : public BugReporterVisitorImpl<CFRefReportVisitor> { 172123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks protected: 1722dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks SymbolRef Sym; 1723ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &SummaryLog; 172435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose bool GCEnabled; 172523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1726dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks public: 172735c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefReportVisitor(SymbolRef sym, bool gcEnabled, const SummaryLogTy &log) 172835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : Sym(sym), SummaryLog(log), GCEnabled(gcEnabled) {} 1729dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 173023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID &ID) const { 1731dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks static int x = 0; 1732dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(&x); 1733dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ID.AddPointer(Sym); 1734dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1735dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 173623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 173723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *PrevN, 173823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReporterContext &BRC, 173923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 174023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 174123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 174223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 174323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 174423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks }; 174523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 174623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks class CFRefLeakReportVisitor : public CFRefReportVisitor { 174723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks public: 174835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose CFRefLeakReportVisitor(SymbolRef sym, bool GCEnabled, 1749ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const SummaryLogTy &log) 175035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose : CFRefReportVisitor(sym, GCEnabled, log) {} 175123f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 175223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 175323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *N, 175423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR); 1755011534973e83db51f49098871186238fc64d5f54Jordy Rose 1756011534973e83db51f49098871186238fc64d5f54Jordy Rose virtual BugReporterVisitor *clone() const { 1757011534973e83db51f49098871186238fc64d5f54Jordy Rose // The curiously-recurring template pattern only works for one level of 1758011534973e83db51f49098871186238fc64d5f54Jordy Rose // subclassing. Rather than make a new template base for 1759011534973e83db51f49098871186238fc64d5f54Jordy Rose // CFRefReportVisitor, we simply override clone() to do the right thing. 1760011534973e83db51f49098871186238fc64d5f54Jordy Rose // This could be trouble someday if BugReporterVisitorImpl is ever 1761011534973e83db51f49098871186238fc64d5f54Jordy Rose // used for something else besides a convenient implementation of clone(). 1762011534973e83db51f49098871186238fc64d5f54Jordy Rose return new CFRefLeakReportVisitor(*this); 1763011534973e83db51f49098871186238fc64d5f54Jordy Rose } 1764dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks }; 1765dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 1766e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class CFRefReport : public BugReport { 17672058956954802229bf98604e8063fa57677abff4Jordy Rose void addGCModeDescription(const LangOptions &LOpts, bool GCEnabled); 176835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1769c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 17702058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17712058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17722058956954802229bf98604e8063fa57677abff4Jordy Rose bool registerVisitor = true) 1773edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), n) { 177423f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks if (registerVisitor) 17752058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17762058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1777dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 1778eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 17792058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 17802058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 17812058956954802229bf98604e8063fa57677abff4Jordy Rose StringRef endText) 1782edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks : BugReport(D, D.getDescription(), endText, n) { 17832058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefReportVisitor(sym, GCEnabled, Log)); 17842058956954802229bf98604e8063fa57677abff4Jordy Rose addGCModeDescription(LOpts, GCEnabled); 1785dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks } 17861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1787e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges() { 1788edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks const CFRefBug& BugTy = static_cast<CFRefBug&>(getBugType()); 1789edf4daead543ab594012ef1704c7c5dd0a93f45fAnna Zaks if (!BugTy.isLeak()) 1790e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return BugReport::getRanges(); 1791c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 1792640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis return std::make_pair(ranges_iterator(), ranges_iterator()); 1793c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1794c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek }; 1795eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek 1796ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnam class CFRefLeakReport : public CFRefReport { 1797c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* AllocBinding; 179823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 1799c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek public: 18002058956954802229bf98604e8063fa57677abff4Jordy Rose CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, bool GCEnabled, 18012058956954802229bf98604e8063fa57677abff4Jordy Rose const SummaryLogTy &Log, ExplodedNode *n, SymbolRef sym, 18026a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx); 18031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1804590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation getLocation(const SourceManager &SM) const { 1805590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(Location.isValid()); 1806590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return Location; 1807590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 18081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 18095216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek} // end anonymous namespace 18105216ad7e095873f19e535ad1efba91973f05d8e8Ted Kremenek 18112058956954802229bf98604e8063fa57677abff4Jordy Rosevoid CFRefReport::addGCModeDescription(const LangOptions &LOpts, 18122058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled) { 1813f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose const char *GCModeDescription = 0; 18141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1815e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor switch (LOpts.getGC()) { 18167f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::GCOnly: 18172058956954802229bf98604e8063fa57677abff4Jordy Rose assert(GCEnabled); 181835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to only use garbage collection"; 181935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18217f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::NonGC: 18222058956954802229bf98604e8063fa57677abff4Jordy Rose assert(!GCEnabled); 182335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use reference counts"; 182435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18267f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks case LangOptions::HybridGC: 18272058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) { 182835c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 182935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 183035c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "with GC enabled"; 183135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 183235c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose } else { 183335c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose GCModeDescription = "Code is compiled to use either garbage collection " 183435c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "(GC) or reference counts (non-GC). The bug occurs " 183535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose "in non-GC mode"; 183635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose break; 18377f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1838c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 183935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose 1840f95b19de813017e6a4aa99d71dd40112197c3019Jordy Rose assert(GCModeDescription && "invalid/unknown GC mode"); 184135c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose addExtraText(GCModeDescription); 1842c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1843e7bd9c20a9310c625bef899dec977aba688db06aTed Kremenek 1844910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: This should be a method on SmallVector. 18455f9e272e632e951b1efe824cd16acb4d96077930Chris Lattnerstatic inline bool contains(const SmallVectorImpl<ArgEffect>& V, 1846c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ArgEffect X) { 18475f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::const_iterator I=V.begin(), E=V.end(); 1848c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek I!=E; ++I) 1849c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (*I == X) return true; 18501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1851c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return false; 1852c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 1853c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 185470fdbc366da85880aae5baebd3351e993ca05603Jordy Rosestatic bool isNumericLiteralExpression(const Expr *E) { 185570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // FIXME: This set of cases was copied from SemaExprObjC. 185670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose return isa<IntegerLiteral>(E) || 185770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CharacterLiteral>(E) || 185870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<FloatingLiteral>(E) || 185970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<ObjCBoolLiteralExpr>(E) || 186070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose isa<CXXBoolLiteralExpr>(E); 186170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 186270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 1863dc757b049796949e4b11646445a6598f0bdabd7aAnna ZaksPathDiagnosticPiece *CFRefReportVisitor::VisitNode(const ExplodedNode *N, 1864dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks const ExplodedNode *PrevN, 1865dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReporterContext &BRC, 1866dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks BugReport &BR) { 186728038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // FIXME: We will eventually need to handle non-statement-based events 186828038f33aa2db4833881fea757a1f0daf85ac02bJordan Rose // (__attribute__((cleanup))). 18697a95de68c093991047ed8d339479ccad51b88663David Blaikie if (!N->getLocation().getAs<StmtPoint>()) 18702033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek return NULL; 18711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18728966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Check if the type state has changed. 18738bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef PrevSt = PrevN->getState(); 18748bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef CurrSt = N->getState(); 18755eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = N->getLocationContext(); 18761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18778d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* CurrT = getRefBinding(CurrSt, Sym); 1878c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!CurrT) return NULL; 18791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1880b65be70779bdaf75e91731bfd89362bf4118ae31Ted Kremenek const RefVal &CurrV = *CurrT; 18818d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *PrevT = getRefBinding(PrevSt, Sym); 18821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1883c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Create a string buffer to constain all the useful things we want 1884c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to tell the user. 1885c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 1886c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 18871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1888c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This is the allocation site since the previous node had no bindings 1889c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // for this symbol. 1890c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!PrevT) { 18917a95de68c093991047ed8d339479ccad51b88663David Blaikie const Stmt *S = N->getLocation().castAs<StmtPoint>().getStmt(); 18921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (isa<ObjCArrayLiteral>(S)) { 18941a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSArray literal is an object with a +0 retain count"; 18951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 18961a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else if (isa<ObjCDictionaryLiteral>(S)) { 18971a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "NSDictionary literal is an object with a +0 retain count"; 1898c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 189970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else if (const ObjCBoxedExpr *BL = dyn_cast<ObjCBoxedExpr>(S)) { 190070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (isNumericLiteralExpression(BL->getSubExpr())) 190170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "NSNumber literal is an object with a +0 retain count"; 190270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else { 190370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ObjCInterfaceDecl *BoxClass = 0; 190470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (const ObjCMethodDecl *Method = BL->getBoxingMethod()) 190570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose BoxClass = Method->getClassInterface(); 190670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 190770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // We should always be able to find the boxing class interface, 190870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose // but consider this future-proofing. 190970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (BoxClass) 191070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << *BoxClass << " b"; 191170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose else 191270fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "B"; 191370fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 191470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose os << "oxed expression produces an object with a +0 retain count"; 191570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 191670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 19171a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19181a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 19191a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Get the name of the callee (if it is available). 19201a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal X = CurrSt->getSValAsScalarOrLoc(CE->getCallee(), LCtx); 19211a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (const FunctionDecl *FD = X.getAsFunctionDecl()) 19221a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "Call to function '" << *FD << '\''; 19231a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else 19241a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "function call"; 19251a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19261a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19278919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose assert(isa<ObjCMessageExpr>(S)); 1928d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventManager &Mgr = CurrSt->getStateManager().getCallEventManager(); 1929d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose CallEventRef<ObjCMethodCall> Call 1930d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose = Mgr.getObjCMethodCall(cast<ObjCMessageExpr>(S), CurrSt, LCtx); 1931d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose 1932d563d3fb73879df7147b8a5302c3bf0e1402ba18Jordan Rose switch (Call->getMessageKind()) { 19338919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Message: 19348919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Method"; 19358919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19368919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_PropertyAccess: 19378919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Property"; 19388919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19398919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose case OCM_Subscript: 19408919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose os << "Subscript"; 19418919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose break; 19428919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose } 19431a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19451a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.getObjKind() == RetEffect::CF) { 19461a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns a Core Foundation object with a "; 19471a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19481a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19491a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.getObjKind() == RetEffect::ObjC); 19501a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << " returns an Objective-C object with a "; 19511a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19531a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (CurrV.isOwned()) { 19541a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+1 retain count"; 19551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19561a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (GCEnabled) { 19571a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert(CurrV.getObjKind() == RetEffect::CF); 19581a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << ". " 19591a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek "Core Foundation objects are not automatically garbage collected."; 19601a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19611a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 19621a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek else { 19631a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek assert (CurrV.isNotOwned()); 19641a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek os << "+0 retain count"; 1965c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1966cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1968220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 1969220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 1970c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(Pos, os.str()); 1971cb61292aeafc1dc1bc4064fb3d2733717d1d50e5Ted Kremenek } 19721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1973c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Gather up the effects that were performed on the object at this 1974c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // program point 19755f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<ArgEffect, 2> AEffects; 19761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1977ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose const ExplodedNode *OrigNode = BRC.getNodeResolver().getOriginalNode(N); 1978ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose if (const RetainSummary *Summ = SummaryLog.lookup(OrigNode)) { 1979c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We only have summaries attached to nodes after evaluating CallExpr and 1980c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // ObjCMessageExprs. 19817a95de68c093991047ed8d339479ccad51b88663David Blaikie const Stmt *S = N->getLocation().castAs<StmtPoint>().getStmt(); 19821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19835f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (const CallExpr *CE = dyn_cast<CallExpr>(S)) { 1984c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Iterate through the parameter expressions and see if the symbol 1985c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // was ever passed as an argument. 1986c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek unsigned i = 0; 19871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19885f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek for (CallExpr::const_arg_iterator AI=CE->arg_begin(), AE=CE->arg_end(); 1989c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AI!=AE; ++AI, ++i) { 19901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1991c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Retrieve the value of the argument. Is it the symbol 1992c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // we are interested in? 19935eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(*AI, LCtx).getAsLocSymbol() != Sym) 1994c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 19951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1996c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We have an argument. Get the effect! 1997c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getArg(i)); 1998c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 1999c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(S)) { 200104badcf84c8d504d8491c7c7e29b58f52cb16640Douglas Gregor if (const Expr *receiver = ME->getInstanceReceiver()) 20025eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(receiver, LCtx) 20035eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek .getAsLocSymbol() == Sym) { 2004c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // The symbol we are tracking is the receiver. 2005c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek AEffects.push_back(Summ->getReceiverEffect()); 2006c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2007c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20081c512f5fcb47526a09f15c26ba673a22fce91e33Ted Kremenek } 20091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2010c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek do { 2011c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the previous type state. 2012c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek RefVal PrevV = *PrevT; 20131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2014c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle -dealloc. 201535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (!GCEnabled && contains(AEffects, Dealloc)) { 2016c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2017c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 2018c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We may not have transitioned to 'release' if we hit an error. 2019c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // This case is handled elsewhere. 2020c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2021f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek assert(CurrV.getCombinedCounts() == 0); 2022c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released by directly sending the '-dealloc' message"; 2023f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek break; 2024f95e9fcffb8cffaf11c3ebd24f860b148694505aTed Kremenek } 2025c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2027c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Specially handle CFMakeCollectable and friends. 2028c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (contains(AEffects, MakeCollectable)) { 2029c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the name of the function. 20307a95de68c093991047ed8d339479ccad51b88663David Blaikie const Stmt *S = N->getLocation().castAs<StmtPoint>().getStmt(); 20315eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal X = 20325eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek CurrSt->getSValAsScalarOrLoc(cast<CallExpr>(S)->getCallee(), LCtx); 20339c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FunctionDecl *FD = X.getAsFunctionDecl(); 20341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 203535c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) { 2036c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Determine if the object's reference count was pushed to zero. 2037c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(!(PrevV == CurrV) && "The typestate *must* have changed."); 20381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2039b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "In GC mode a call to '" << *FD 2040c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' decrements an object's retain count and registers the " 2041c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "object with the garbage collector. "; 20421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2043c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (CurrV.getKind() == RefVal::Released) { 2044c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek assert(CurrV.getCount() == 0); 2045c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Since it now has a 0 retain count the object can be " 2046c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "automatically collected by the garbage collector."; 2047c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2048c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2049c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "An object must have a 0 retain count to be garbage collected. " 2050c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek "After this call its retain count is +" << CurrV.getCount() 2051c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << '.'; 20523eabf1c0e695fd772ffee4ba469bc46292404ea1Ted Kremenek } 20531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 2054b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "When GC is not enabled a call to '" << *FD 2055c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek << "' has no effect on its argument."; 20561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2057c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Nothing more to say. 2058c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2059c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Determine if the typestate has changed. 2062c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (!(PrevV == CurrV)) 2063c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (CurrV.getKind()) { 20641ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Owned: 20651ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::NotOwned: 20661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2067f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getCount() == CurrV.getCount()) { 2068f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek // Did an autorelease message get sent? 2069f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek if (PrevV.getAutoreleaseCount() == CurrV.getAutoreleaseCount()) 2070f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek return 0; 20711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2072264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu assert(PrevV.getAutoreleaseCount() < CurrV.getAutoreleaseCount()); 2073eaedfeab9eab0d003859aab138784f2c59531408Ted Kremenek os << "Object sent -autorelease message"; 2074f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek break; 2075f21332e786564e83dc77451c05833f74e8f080c2Ted Kremenek } 20761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2077c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getCount() > CurrV.getCount()) 2078c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count decremented."; 2079c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2080c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Reference count incremented."; 20811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2082c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (unsigned Count = CurrV.getCount()) 2083c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << " The object now has a +" << Count << " retain count."; 20841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2085c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (PrevV.getKind() == RefVal::Released) { 208635c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose assert(GCEnabled && CurrV.getCount() > 0); 208774b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << " The object is not eligible for garbage collection until " 208874b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "the retain count reaches 0 again."; 2089c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 20901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2091c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 20921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20931ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek case RefVal::Released: 2094c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "Object released."; 20951ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek break; 20961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2097c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedOwned: 209874b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose // Autoreleases can be applied after marking a node ReturnedOwned. 209974b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose if (CurrV.getAutoreleaseCount()) 210074b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose return NULL; 210174b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose 210274b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose os << "Object returned to caller as an owning reference (single " 210374b7b2b42dd710ccea78d86a47c979d4b2af7093Jordy Rose "retain count transferred to caller)"; 2104c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2106c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case RefVal::ReturnedNotOwned: 2107f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object returned to caller with a +0 retain count"; 2108c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 21091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2110c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: 2111c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return NULL; 2112c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2114c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Emit any remaining diagnostics for the argument effects (if any). 21155f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVectorImpl<ArgEffect>::iterator I=AEffects.begin(), 2116c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek E=AEffects.end(); I != E; ++I) { 21171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2118c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // A bunch of things have alternate behavior under GC. 211935c869593677e89fb531c069f7b66eb53e0e5084Jordy Rose if (GCEnabled) 2120c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek switch (*I) { 2121c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek default: break; 2122c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case Autorelease: 2123c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode an 'autorelease' has no effect."; 2124c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2125c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case IncRefMsg: 2126c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'retain' message has no effect."; 2127c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2128c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek case DecRefMsg: 2129c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek os << "In GC mode the 'release' message has no effect."; 2130c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek continue; 2131c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2132c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } while (0); 21341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2135c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (os.str().empty()) 2136c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return 0; // We have nothing to say! 21372033a95c9b2692441ce0de790f0d8bbe01722c7fTed Kremenek 21387a95de68c093991047ed8d339479ccad51b88663David Blaikie const Stmt *S = N->getLocation().castAs<StmtPoint>().getStmt(); 2139220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Pos(S, BRC.getSourceManager(), 2140220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks N->getLocationContext()); 21419c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticPiece *P = new PathDiagnosticEventPiece(Pos, os.str()); 21421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2143c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Add the range by scanning the children of the statement for any bindings 2144c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to Sym. 21451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump for (Stmt::const_child_iterator I = S->child_begin(), E = S->child_end(); 21465f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek I!=E; ++I) 21479c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Expr *Exp = dyn_cast_or_null<Expr>(*I)) 21485eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek if (CurrSt->getSValAsScalarOrLoc(Exp, LCtx).getAsLocSymbol() == Sym) { 2149c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek P->addRange(Exp->getSourceRange()); 2150c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek break; 2151c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 21521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2153c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return P; 2154c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2155c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2156e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// Find the first node in the current function context that referred to the 2157e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// tracked symbol and the memory location that value was stored to. Note, the 2158e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// value is only reported if the allocation occurred in the same function as 2159e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks// the leak. 2160c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xustatic std::pair<const ExplodedNode*,const MemRegion*> 216118c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekGetAllocationSite(ProgramStateManager& StateMgr, const ExplodedNode *N, 2162c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek SymbolRef Sym) { 21639c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *Last = N; 21641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* FirstBinding = 0; 2165e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks const LocationContext *LeakContext = N->getLocationContext(); 21661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2167c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek while (N) { 21688bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St = N->getState(); 21691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21708d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (!getRefBinding(St, Sym)) 2171940b1d85d3f786c90e845429a60ffd0be736984eTed Kremenek break; 21721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 217327b867ea1c9cb4b40f9b817c303d6df3ee753da9Anna Zaks StoreManager::FindUniqueBinding FB(Sym); 21741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump StateMgr.iterBindings(St, FB); 21751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (FB) FirstBinding = FB.getRegion(); 21761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2177e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // Allocation node, is the last node in the current context in which the 2178e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // symbol was tracked. 2179e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() == LeakContext) 2180e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks Last = N; 2181e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 21821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = N->pred_empty() ? NULL : *(N->pred_begin()); 21831ac08d6d92b45ec3af3205e50cd989ce4c946fcaTed Kremenek } 21841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2185e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // If allocation happened in a function different from the leak node context, 2186e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks // do not report the binding. 21875a8fc88b18793f25d4423805d7e4ac5d0325b9a6Ted Kremenek assert(N && "Could not find allocation node"); 2188e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks if (N->getLocationContext() != LeakContext) { 2189e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks FirstBinding = 0; 2190e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks } 2191e7e0168f625368032a5d2b4471d3406cd9d9f8aeAnna Zaks 2192c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return std::make_pair(Last, FirstBinding); 21936b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek} 21946b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 2195c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 219623f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefReportVisitor::getEndPath(BugReporterContext &BRC, 219723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 219823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 219976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 220023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks return BugReporterVisitor::getDefaultEndPath(BRC, EndN, BR); 2201c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2202fa34b33e43ca9d8364286d6d6b77265c8b7c5e7cTed Kremenek 2203c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted KremenekPathDiagnosticPiece* 220423f395ee1bf4e4aa76b310d896a951799eaca94aAnna ZaksCFRefLeakReportVisitor::getEndPath(BugReporterContext &BRC, 220523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const ExplodedNode *EndN, 220623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks BugReport &BR) { 22071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22088966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // Tell the BugReporterContext to report cases when the tracked symbol is 2209c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // assigned to different variables, etc. 221076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek BR.markInteresting(Sym); 22111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2212c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // We are reporting a leak. Walk up the graph to get to the first node where 2213c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the symbol appeared, and also get the first VarDecl that tracked object 2214c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // is stored to. 22159c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 2216c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek const MemRegion* FirstBinding = 0; 22171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2218c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, FirstBinding) = 2219f04dced71a266c177e636c7f1837ea31bfeba1e0Ted Kremenek GetAllocationSite(BRC.getStateManager(), EndN, Sym); 22201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22214fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks SourceManager& SM = BRC.getSourceManager(); 22221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2223c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Compute an actual location for the leak. Sometimes a leak doesn't 2224c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // occur at an actual statement (e.g., transition between blocks; end 2225c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // of function) so we need to walk the graph and compute a real location. 22269c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *LeakN = EndN; 22274fdf97bf51d2a156cec3232efd6dae110aa02aa0Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createEndOfPath(LeakN, SM); 22281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2229c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek std::string sbuf; 2230c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(sbuf); 22311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2232f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "Object leaked: "; 22331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2234f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek if (FirstBinding) { 2235f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "object allocated and stored into '" 2236f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek << FirstBinding->getString() << '\''; 2237f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek } 2238f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek else 2239f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek os << "allocated object"; 22401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2241c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the retain count. 22428d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* RV = getRefBinding(EndN->getState(), Sym); 22435a8fc88b18793f25d4423805d7e4ac5d0325b9a6Ted Kremenek assert(RV); 22441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2245c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (RV->getKind() == RefVal::ErrorLeakReturned) { 2246c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: Per comments in rdar://6320065, "create" only applies to CF 22475b5402bbdadcf7d8e4aa83a803b6f33b03458c24Jordy Rose // objects. Only "copy", "alloc", "retain" and "new" transfer ownership 2248c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // to the caller for NS objects. 2249d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek const Decl *D = &EndN->getCodeDecl(); 2250ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek 2251ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << (isa<ObjCMethodDecl>(D) ? " is returned from a method " 2252ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek : " is returned from a function "); 2253ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek 2254ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek if (D->getAttr<CFReturnsNotRetainedAttr>()) 2255ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << "that is annotated as CF_RETURNS_NOT_RETAINED"; 2256ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek else if (D->getAttr<NSReturnsNotRetainedAttr>()) 2257ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << "that is annotated as NS_RETURNS_NOT_RETAINED"; 2258d368d71169cd87ef8ff95388be80a044fa35112fTed Kremenek else { 2259ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) { 2260ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << "whose name ('" << MD->getSelector().getAsString() 2261ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek << "') does not start with 'copy', 'mutableCopy', 'alloc' or 'new'." 2262ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek " This violates the naming convention rules" 2263ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek " given in the Memory Management Guide for Cocoa"; 2264ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek } 2265ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek else { 2266ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek const FunctionDecl *FD = cast<FunctionDecl>(D); 2267ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek os << "whose name ('" << *FD 2268ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek << "') does not contain 'Copy' or 'Create'. This violates the naming" 2269ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek " convention rules given in the Memory Management Guide for Core" 2270ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek " Foundation"; 2271ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek } 2272ec9f36ea83e0f57683dceaa53163f6246d1442d5Ted Kremenek } 2273c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek } 2274e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek else if (RV->getKind() == RefVal::ErrorGCLeakReturned) { 2275e13001441f95fd907228459a4d9310c113ac0a5bDavid Blaikie const ObjCMethodDecl &MD = cast<ObjCMethodDecl>(EndN->getCodeDecl()); 2276e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek os << " and returned from method '" << MD.getSelector().getAsString() 227782f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek << "' is potentially leaked when using garbage collection. Callers " 227882f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "of this method do not expect a returned object with a +1 retain " 227982f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "count since they expect the object to be managed by the garbage " 228082f2be584e43b2e38583fa0bee7cba85612b98a1Ted Kremenek "collector"; 2281e8720ce787d83ffd0de19d82e35dba61e61d9648Ted Kremenek } 2282c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek else 2283abf517c523985f20bb6458e0aa1afad434de3244Ted Kremenek os << " is not referenced later in this execution path and has a retain " 2284f13654600b6c567b2f05902cfa2e86b23ddcbd4bTed Kremenek "count of +" << RV->getCount(); 22851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2286c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek return new PathDiagnosticEventPiece(L, os.str()); 2287c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2288cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 22892058956954802229bf98604e8063fa57677abff4Jordy RoseCFRefLeakReport::CFRefLeakReport(CFRefBug &D, const LangOptions &LOpts, 22902058956954802229bf98604e8063fa57677abff4Jordy Rose bool GCEnabled, const SummaryLogTy &Log, 22912058956954802229bf98604e8063fa57677abff4Jordy Rose ExplodedNode *n, SymbolRef sym, 22926a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx) 22932058956954802229bf98604e8063fa57677abff4Jordy Rose: CFRefReport(D, LOpts, GCEnabled, Log, n, sym, false) { 22941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2295fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner // Most bug reports are cached at the location where they occurred. 2296c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // With leaks, we want to unique them by the location where they were 2297c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // allocated, and only report a single path. To do this, we need to find 2298c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // the allocation site of a piece of tracked memory, which we do via a 2299c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // call to GetAllocationSite. This will walk the ExplodedGraph backwards. 2300c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Note that this is *not* the trimmed graph; we are guaranteed, however, 2301c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // that all ancestor nodes that represent the allocation site have the 2302c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // same SourceLocation. 23039c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *AllocNode = 0; 23041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23056a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks const SourceManager& SMgr = Ctx.getSourceManager(); 2306590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks 2307c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::tie(AllocNode, AllocBinding) = // Set AllocBinding. 23086a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks GetAllocationSite(Ctx.getStateManager(), getErrorNode(), sym); 23091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2310c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Get the SourceLocation for the allocation site. 2311852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: This will crash the analyzer if an allocation comes from an 2312852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // implicit call. (Currently there are no such allocations in Cocoa, though.) 2313852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose const Stmt *AllocStmt; 2314c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek ProgramPoint P = AllocNode->getLocation(); 23157a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> Exit = P.getAs<CallExitEnd>()) 2316852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose AllocStmt = Exit->getCalleeContext()->getCallSite(); 2317852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose else 23187a95de68c093991047ed8d339479ccad51b88663David Blaikie AllocStmt = P.castAs<PostStmt>().getStmt(); 2319852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose assert(AllocStmt && "All allocations must come from explicit calls"); 2320590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location = PathDiagnosticLocation::createBegin(AllocStmt, SMgr, 2321590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks n->getLocationContext()); 2322c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // Fill in the description of the bug. 2323c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek Description.clear(); 2324c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek llvm::raw_string_ostream os(Description); 2325dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "Potential leak "; 23262058956954802229bf98604e8063fa57677abff4Jordy Rose if (GCEnabled) 2327dd924e256e85a8486d571b8e95a30a9fa38092faTed Kremenek os << "(when using garbage collection) "; 2328212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << "of an object"; 23291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2330c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek // FIXME: AllocBinding doesn't get populated for RegionStore yet. 2331c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek if (AllocBinding) 2332212000e24cf11da0badea90c23d4f300da34e607Anna Zaks os << " stored into '" << AllocBinding->getString() << '\''; 2333dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks 23342058956954802229bf98604e8063fa57677abff4Jordy Rose addVisitor(new CFRefLeakReportVisitor(sym, GCEnabled, Log)); 2335c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek} 2336c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2337c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2338c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek// Main checker logic. 2339c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek//===----------------------------------------------------------------------===// 2340c887d13b07d72c8e67d1a73a82d3167e866f50e5Ted Kremenek 2341d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremeneknamespace { 2342910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Roseclass RetainCountChecker 23439c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose : public Checker< check::Bind, 234438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose check::DeadSymbols, 23459c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose check::EndAnalysis, 2346344c77aac25e5d960aced3f45fbaa09853383f6dAnna Zaks check::EndFunction, 23476704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::PostStmt<BlockExpr>, 2348f85e193739c953358c865005855253af4f68a497John McCall check::PostStmt<CastExpr>, 23491a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCArrayLiteral>, 23501a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek check::PostStmt<ObjCDictionaryLiteral>, 235170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose check::PostStmt<ObjCBoxedExpr>, 2352fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose check::PostCall, 2353f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose check::PreStmt<ReturnStmt>, 23546704429557544a890cf6c0859b13b1dc63572f70Jordy Rose check::RegionChanges, 235576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Assume, 235676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose eval::Call > { 23576f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> useAfterRelease, releaseNotOwned; 23586f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> deallocGC, deallocNotOwned; 23596f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> overAutorelease, returnNotOwnedForOwned; 23606f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunction, leakAtReturn; 23616f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<CFRefBug> leakWithinFunctionGC, leakAtReturnGC; 236238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 236338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose typedef llvm::DenseMap<SymbolRef, const SimpleProgramPointTag *> SymbolTagMap; 236438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 236538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // This map is only used to ensure proper deletion of any allocated tags. 236638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose mutable SymbolTagMap DeadSymbolTags; 236738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23686f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> Summaries; 23696f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith mutable OwningPtr<RetainSummaryManager> SummariesGC; 23709c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable SummaryLogTy SummaryLog; 23719c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose mutable bool ShouldResetSummaryLog; 23729c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 23732f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rosepublic: 2374910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetainCountChecker() : ShouldResetSummaryLog(false) {} 237538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 2376910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose virtual ~RetainCountChecker() { 237738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose DeleteContainerSeconds(DeadSymbolTags); 237838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 237938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 23809c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose void checkEndAnalysis(ExplodedGraph &G, BugReporter &BR, 23819c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ExprEngine &Eng) const { 23829c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is a hack to make sure the summary log gets cleared between 23839c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // analyses of different code bodies. 23849c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // 23859c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Why is this necessary? Because a checker's lifetime is tied to a 23869c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // translation unit, but an ExplodedGraph's lifetime is just a code body. 23879c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Once in a blue moon, a new ExplodedNode will have the same address as an 23889c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // old one with an associated summary, and the bug report visitor gets very 23899c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // confused. (To make things worse, the summary lifetime is currently also 23909c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // tied to a code body, so we get a crash instead of incorrect results.) 23911ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23921ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // Why is this a bad solution? Because if the lifetime of the ExplodedGraph 23931ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // changes, things will start going wrong again. Really the lifetime of this 23941ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // log needs to be tied to either the specific nodes in it or the entire 23951ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // ExplodedGraph, not to a specific part of the code being analyzed. 23961ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 23979c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // (Also, having stateful local data means that the same checker can't be 23989c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // used from multiple threads, but a lot of checkers have incorrect 23999c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // assumptions about that anyway. So that wasn't a priority at the time of 24009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this fix.) 24011ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose // 24029c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // This happens at the end of analysis, but bug reports are emitted /after/ 24039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // this point. So we can't just clear the summary log now. Instead, we mark 24049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // that the next time we access the summary log, it should be cleared. 24059c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24069c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // If we never reset the summary log during /this/ code body analysis, 24079c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // there were no new summaries. There might still have been summaries from 24089c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // the /last/ analysis, so clear them out to make sure the bug report 24099c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // visitors don't get confused. 24109c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) 24119c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 24129c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose 24139c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = !SummaryLog.empty(); 24141ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose } 24151ab51c79a9eb5381c8cf06f3506f5224b19a509dJordy Rose 241617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakWithinFunctionBug(const LangOptions &LOpts, 241717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 241817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2419db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunctionGC) 2420facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunctionGC.reset(new Leak("Leak of object when using " 2421facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 242217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunctionGC.get(); 2423db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2424db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakWithinFunction) { 2425e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2426facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak of object when not using " 2427facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in " 2428facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "dual GC/non-GC code")); 2429db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2430facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakWithinFunction.reset(new Leak("Leak")); 2431db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2432db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 243317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakWithinFunction.get(); 2434db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2435db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2436db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 243717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *getLeakAtReturnBug(const LangOptions &LOpts, bool GCEnabled) const { 243817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 2439db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturnGC) 2440facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturnGC.reset(new Leak("Leak of returned object when using " 2441facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection")); 244217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturnGC.get(); 2443db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2444db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose if (!leakAtReturn) { 2445e289d81369914678db386f6aa86faf8f178e245dDouglas Gregor if (LOpts.getGC() == LangOptions::HybridGC) { 2446facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object when not using " 2447facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "garbage collection (GC) in dual " 2448facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer "GC/non-GC code")); 2449db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } else { 2450facde171ae4b8926622a1bffa833732a06f1875bBenjamin Kramer leakAtReturn.reset(new Leak("Leak of returned object")); 2451db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2452db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 245317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return leakAtReturn.get(); 2454db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2455db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose } 2456db92bb60daa9f5e3d68f5a5468f5af2717b59663Jordy Rose 245717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(ASTContext &Ctx, 245817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled) const { 245917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // FIXME: We don't support ARC being turned on and off during one analysis. 246017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose // (nor, for that matter, do we support changing ASTContexts) 24614e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie bool ARCEnabled = (bool)Ctx.getLangOpts().ObjCAutoRefCount; 246217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (GCEnabled) { 246317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!SummariesGC) 2464b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose SummariesGC.reset(new RetainSummaryManager(Ctx, true, ARCEnabled)); 246517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 246617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(SummariesGC->isARCEnabled() == ARCEnabled); 2467b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *SummariesGC; 2468b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } else { 246917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!Summaries) 2470b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose Summaries.reset(new RetainSummaryManager(Ctx, false, ARCEnabled)); 247117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose else 247217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(Summaries->isARCEnabled() == ARCEnabled); 2473b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose return *Summaries; 2474b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2475b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose } 2476b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose 247717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &getSummaryManager(CheckerContext &C) const { 247817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return getSummaryManager(C.getASTContext(), C.isObjCGCEnabled()); 247917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 248017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 24818bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void printState(raw_ostream &Out, ProgramStateRef State, 2482dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose const char *NL, const char *Sep) const; 2483dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 2484390909c89c98ab1807e15e033a72e975f866fb23Anna Zaks void checkBind(SVal loc, SVal val, const Stmt *S, CheckerContext &C) const; 2485ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const; 2486ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose void checkPostStmt(const CastExpr *CE, CheckerContext &C) const; 2487f85e193739c953358c865005855253af4f68a497John McCall 24881a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCArrayLiteral *AL, CheckerContext &C) const; 24891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void checkPostStmt(const ObjCDictionaryLiteral *DL, CheckerContext &C) const; 249070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose void checkPostStmt(const ObjCBoxedExpr *BE, CheckerContext &C) const; 249170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2492fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose void checkPostCall(const CallEvent &Call, CheckerContext &C) const; 24931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 24944531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose void checkSummary(const RetainSummary &Summ, const CallEvent &Call, 2495e38dd95dddb8f1b38469c8d0e28aa1c660489324Jordy Rose CheckerContext &C) const; 2496294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2497554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks void processSummaryOfInlined(const RetainSummary &Summ, 2498554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const CallEvent &Call, 2499554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const; 2500554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 250176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool evalCall(const CallExpr *CE, CheckerContext &C) const; 250276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 25038bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond, 2504ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose bool Assumption) const; 25056704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25068bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 25078bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek checkRegionChanges(ProgramStateRef state, 2508bf53dfac8195835028bd6347433f7dbebcc29fc1Anna Zaks const InvalidatedSymbols *invalidated, 2509537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 251066c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 2511740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const; 2512ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose 25138bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool wantsRegionChangeUpdate(ProgramStateRef state) const { 25142f9a66debc058359653cf4d13a8c58cc34cd36bdJordy Rose return true; 2515ab027fd894baf7bee3fc396650e9aec3acea16d2Jordy Rose } 2516294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2517f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const; 2518f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose void checkReturnWithRetEffect(const ReturnStmt *S, CheckerContext &C, 2519f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose ExplodedNode *Pred, RetEffect RE, RefVal X, 25208bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek SymbolRef Sym, ProgramStateRef state) const; 2521f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 252238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const; 2523344c77aac25e5d960aced3f45fbaa09853383f6dAnna Zaks void checkEndFunction(CheckerContext &C) const; 252438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25258bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef updateSymbol(ProgramStateRef state, SymbolRef sym, 2526554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2527554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const; 2528e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 25298bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void processNonLeakError(ProgramStateRef St, SourceRange ErrorRange, 2530294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind ErrorKind, SymbolRef Sym, 2531294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CheckerContext &C) const; 25321a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 25331a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek void processObjCLiterals(CheckerContext &C, const Expr *Ex) const; 2534294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 253538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const ProgramPointTag *getDeadSymbolTag(SymbolRef sym) const; 253638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25378bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef handleSymbolDeath(ProgramStateRef state, 25388d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SymbolRef sid, RefVal V, 25398d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks SmallVectorImpl<SymbolRef> &Leaked) const; 254038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 25414ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose ProgramStateRef 25422bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose handleAutoreleaseCounts(ProgramStateRef state, ExplodedNode *Pred, 25432bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag, CheckerContext &Ctx, 25442bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose SymbolRef Sym, RefVal V) const; 25458d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 25468bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *processLeaks(ProgramStateRef state, 254738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 25486a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 254938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = 0) const; 2550d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek}; 2551d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek} // end anonymous namespace 2552d593eb93329ebea1b50dd32221116240eb1e1eacTed Kremenek 25536704429557544a890cf6c0859b13b1dc63572f70Jordy Rosenamespace { 25546704429557544a890cf6c0859b13b1dc63572f70Jordy Roseclass StopTrackingCallback : public SymbolVisitor { 25558bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 25566704429557544a890cf6c0859b13b1dc63572f70Jordy Rosepublic: 25578bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek StopTrackingCallback(ProgramStateRef st) : state(st) {} 25588bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return state; } 25596704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 25606704429557544a890cf6c0859b13b1dc63572f70Jordy Rose bool VisitSymbol(SymbolRef sym) { 25616704429557544a890cf6c0859b13b1dc63572f70Jordy Rose state = state->remove<RefBindings>(sym); 25626704429557544a890cf6c0859b13b1dc63572f70Jordy Rose return true; 25636704429557544a890cf6c0859b13b1dc63572f70Jordy Rose } 25646704429557544a890cf6c0859b13b1dc63572f70Jordy Rose}; 25656704429557544a890cf6c0859b13b1dc63572f70Jordy Rose} // end anonymous namespace 25666704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2567910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 2568910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle statements that may have an effect on refcounts. 2569910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 25706704429557544a890cf6c0859b13b1dc63572f70Jordy Rose 2571910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const BlockExpr *BE, 2572910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2573dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2574910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Scan the BlockDecRefExprs for any object the retain count checker 2575dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek // may be tracking. 2576469a1eb996e1cb0be54f9b210f836afbddcbb2ccJohn McCall if (!BE->getBlockDecl()->hasCaptures()) 257738cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2578dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 25798bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 258038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek const BlockDataRegion *R = 25815eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek cast<BlockDataRegion>(state->getSVal(BE, 25825eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek C.getLocationContext()).getAsRegion()); 2583dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258438cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(), 258538cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek E = R->referenced_vars_end(); 2586dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 258738cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek if (I == E) 258838cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek return; 2589dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 259067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // FIXME: For now we invalidate the tracking of all symbols passed to blocks 259167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // via captured variables, even though captured variables result in a copy 259267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // and in implicit increment/decrement of a retain count. 25935f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const MemRegion*, 10> Regions; 259439ac1876f6f9a1a8e0070f0df61036c7ba05202bAnna Zaks const LocationContext *LC = C.getLocationContext(); 2595c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager(); 2596dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 259767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek for ( ; I != E; ++I) { 2598e3ce2c10c3f6ae7b26700d758de909deab190d42Ted Kremenek const VarRegion *VR = I.getCapturedRegion(); 259967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek if (VR->getSuperRegion() == R) { 260067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VR = MemMgr.getVarRegion(VR->getDecl(), LC); 260167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 260267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.push_back(VR); 260367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 2604dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 260567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state = 260667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek state->scanReachableSymbols<StopTrackingCallback>(Regions.data(), 260767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Regions.data() + Regions.size()).getState(); 26080bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 260938cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek} 261038cc6bca5c172e2888c86fb0bef6883db0692cf6Ted Kremenek 2611910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPostStmt(const CastExpr *CE, 2612910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2613f85e193739c953358c865005855253af4f68a497John McCall const ObjCBridgedCastExpr *BE = dyn_cast<ObjCBridgedCastExpr>(CE); 2614f85e193739c953358c865005855253af4f68a497John McCall if (!BE) 2615f85e193739c953358c865005855253af4f68a497John McCall return; 2616f85e193739c953358c865005855253af4f68a497John McCall 261771c482c76c67ad4240757c4e319ffdb72272b8eeJohn McCall ArgEffect AE = IncRef; 2618f85e193739c953358c865005855253af4f68a497John McCall 2619f85e193739c953358c865005855253af4f68a497John McCall switch (BE->getBridgeKind()) { 2620f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_Bridge: 2621f85e193739c953358c865005855253af4f68a497John McCall // Do nothing. 2622f85e193739c953358c865005855253af4f68a497John McCall return; 2623f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeRetained: 2624f85e193739c953358c865005855253af4f68a497John McCall AE = IncRef; 2625f85e193739c953358c865005855253af4f68a497John McCall break; 2626f85e193739c953358c865005855253af4f68a497John McCall case clang::OBC_BridgeTransfer: 2627f85e193739c953358c865005855253af4f68a497John McCall AE = DecRefBridgedTransfered; 2628f85e193739c953358c865005855253af4f68a497John McCall break; 2629f85e193739c953358c865005855253af4f68a497John McCall } 2630f85e193739c953358c865005855253af4f68a497John McCall 26318bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 26325eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = state->getSVal(CE, C.getLocationContext()).getAsLocSymbol(); 2633f85e193739c953358c865005855253af4f68a497John McCall if (!Sym) 2634f85e193739c953358c865005855253af4f68a497John McCall return; 26358d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal* T = getRefBinding(state, Sym); 2636f85e193739c953358c865005855253af4f68a497John McCall if (!T) 2637f85e193739c953358c865005855253af4f68a497John McCall return; 2638f85e193739c953358c865005855253af4f68a497John McCall 2639f85e193739c953358c865005855253af4f68a497John McCall RefVal::Kind hasErr = (RefVal::Kind) 0; 264017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, AE, hasErr, C); 2641f85e193739c953358c865005855253af4f68a497John McCall 2642f85e193739c953358c865005855253af4f68a497John McCall if (hasErr) { 2643e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // FIXME: If we get an error during a bridge cast, should we report it? 2644e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Should we assert that there is no error? 2645f85e193739c953358c865005855253af4f68a497John McCall return; 2646f85e193739c953358c865005855253af4f68a497John McCall } 2647f85e193739c953358c865005855253af4f68a497John McCall 26480bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 2649f85e193739c953358c865005855253af4f68a497John McCall} 2650f85e193739c953358c865005855253af4f68a497John McCall 26511a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::processObjCLiterals(CheckerContext &C, 26521a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Expr *Ex) const { 26531a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek ProgramStateRef state = C.getState(); 26541a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const ExplodedNode *pred = C.getPredecessor(); 26551a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek for (Stmt::const_child_iterator it = Ex->child_begin(), et = Ex->child_end() ; 26561a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek it != et ; ++it) { 26571a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek const Stmt *child = *it; 26581a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek SVal V = state->getSVal(child, pred->getLocationContext()); 26591a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = V.getAsSymbol()) 26608d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal* T = getRefBinding(state, sym)) { 26611a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek RefVal::Kind hasErr = (RefVal::Kind) 0; 26621a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state = updateSymbol(state, sym, *T, MayEscape, hasErr, C); 26631a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (hasErr) { 26641a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processNonLeakError(state, child->getSourceRange(), hasErr, sym, C); 26651a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek return; 26661a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26671a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26681a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26691a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26701a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Return the object as autoreleased. 26711a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // RetEffect RE = RetEffect::MakeNotOwned(RetEffect::ObjC); 26721a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek if (SymbolRef sym = 26731a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek state->getSVal(Ex, pred->getLocationContext()).getAsSymbol()) { 26741a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek QualType ResultTy = Ex->getType(); 26758d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, sym, 26768d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks RefVal::makeNotOwned(RetEffect::ObjC, ResultTy)); 26771a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek } 26781a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26791a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek C.addTransition(state); 26801a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 26811a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26821a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCArrayLiteral *AL, 26831a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 26841a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all values. 26851a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, AL); 26861a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 26871a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 26881a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenekvoid RetainCountChecker::checkPostStmt(const ObjCDictionaryLiteral *DL, 26891a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek CheckerContext &C) const { 26901a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek // Apply the 'MayEscape' to all keys and values. 26911a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek processObjCLiterals(C, DL); 26921a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek} 26931a45a5ff5d495cb6cd9a3d4d06317af79c0f634dTed Kremenek 269470fdbc366da85880aae5baebd3351e993ca05603Jordy Rosevoid RetainCountChecker::checkPostStmt(const ObjCBoxedExpr *Ex, 269570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose CheckerContext &C) const { 269670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const ExplodedNode *Pred = C.getPredecessor(); 269770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose const LocationContext *LCtx = Pred->getLocationContext(); 269870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose ProgramStateRef State = Pred->getState(); 269970fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 270070fdbc366da85880aae5baebd3351e993ca05603Jordy Rose if (SymbolRef Sym = State->getSVal(Ex, LCtx).getAsSymbol()) { 270170fdbc366da85880aae5baebd3351e993ca05603Jordy Rose QualType ResultTy = Ex->getType(); 27028d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks State = setRefBinding(State, Sym, 27038d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks RefVal::makeNotOwned(RetEffect::ObjC, ResultTy)); 270470fdbc366da85880aae5baebd3351e993ca05603Jordy Rose } 270570fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 270670fdbc366da85880aae5baebd3351e993ca05603Jordy Rose C.addTransition(State); 270770fdbc366da85880aae5baebd3351e993ca05603Jordy Rose} 270870fdbc366da85880aae5baebd3351e993ca05603Jordy Rose 2709fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rosevoid RetainCountChecker::checkPostCall(const CallEvent &Call, 2710fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose CheckerContext &C) const { 2711fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose RetainSummaryManager &Summaries = getSummaryManager(C); 2712fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose const RetainSummary *Summ = Summaries.getSummary(Call, C.getState()); 2713554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2714554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (C.wasInlined) { 2715554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks processSummaryOfInlined(*Summ, Call, C); 2716554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks return; 2717554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2718fe6a011a113b3ddcb32f42af152d7476054e7f79Jordan Rose checkSummary(*Summ, Call, C); 2719294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2720294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2721910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// GetReturnType - Used to get the return type of a message expression or 2722910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// function call with the intention of affixing that type to a tracked symbol. 2723bed28ac1d1463adca3ecf24fca5c30646fa9dbb2Sylvestre Ledru/// While the return type can be queried directly from RetEx, when 2724910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// invoking class methods we augment to the return type to be that of 2725910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose/// a pointer to the class (as opposed it just being id). 2726910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// FIXME: We may be able to do this with related result types instead. 2727910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// This function is probably overestimating. 2728910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosestatic QualType GetReturnType(const Expr *RetE, ASTContext &Ctx) { 2729910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose QualType RetTy = RetE->getType(); 2730910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is not a message expression just return its type. 2731910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If RetE is a message expression, return its types if it is something 2732910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose /// more specific than id. 2733910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(RetE)) 2734910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const ObjCObjectPointerType *PT = RetTy->getAs<ObjCObjectPointerType>()) 2735910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (PT->isObjCQualifiedIdType() || PT->isObjCIdType() || 2736910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose PT->isObjCClassType()) { 2737910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // At this point we know the return type of the message expression is 2738910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // id, id<...>, or Class. If we have an ObjCInterfaceDecl, we know this 2739910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // is a call to a class method whose type we can resolve. In such 2740910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // cases, promote the return type to XXX* (where XXX is the class). 2741910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const ObjCInterfaceDecl *D = ME->getReceiverInterface(); 2742910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return !D ? RetTy : 2743910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Ctx.getObjCObjectPointerType(Ctx.getObjCInterfaceType(D)); 2744910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 2745910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2746910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return RetTy; 2747910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 2748910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 2749554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// We don't always get the exact modeling of the function with regards to the 2750554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// retain count checker even when the function is inlined. For example, we need 2751554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks// to stop tracking the symbols which were marked with StopTrackingHard. 2752554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaksvoid RetainCountChecker::processSummaryOfInlined(const RetainSummary &Summ, 2753554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const CallEvent &CallOrMsg, 2754554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks CheckerContext &C) const { 2755554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks ProgramStateRef state = C.getState(); 2756554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2757554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Evaluate the effect of the arguments. 2758554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2759554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Summ.getArg(idx) == StopTrackingHard) { 2760554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks SVal V = CallOrMsg.getArgSVal(idx); 2761554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (SymbolRef Sym = V.getAsLocSymbol()) { 2762554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2763554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2764554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2765554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2766554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2767554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Evaluate the effect on the message receiver. 2768554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks const ObjCMethodCall *MsgInvocation = dyn_cast<ObjCMethodCall>(&CallOrMsg); 2769554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (MsgInvocation) { 2770554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (SymbolRef Sym = MsgInvocation->getReceiverSVal().getAsLocSymbol()) { 2771554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Summ.getReceiverEffect() == StopTrackingHard) { 2772554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2773554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2774554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2775554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2776554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2777554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks // Consult the summary for the return value. 2778554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks RetEffect RE = Summ.getRetEffect(); 2779554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (RE.getKind() == RetEffect::NoRetHard) { 27802f3017f9cbd3774f690c979410bfec38423d03afJordan Rose SymbolRef Sym = CallOrMsg.getReturnValue().getAsSymbol(); 2781554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (Sym) 2782554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks state = removeRefBinding(state, Sym); 2783554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks } 2784554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2785554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks C.addTransition(state); 2786554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks} 2787554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks 2788910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkSummary(const RetainSummary &Summ, 27894531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const CallEvent &CallOrMsg, 2790910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 27918bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 2792294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2793294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect of the arguments. 2794294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RefVal::Kind hasErr = (RefVal::Kind) 0; 2795294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SourceRange ErrorRange; 2796294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef ErrorSym = 0; 2797294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2798294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose for (unsigned idx = 0, e = CallOrMsg.getNumArgs(); idx != e; ++idx) { 2799537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose SVal V = CallOrMsg.getArgSVal(idx); 2800294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2801294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (SymbolRef Sym = V.getAsLocSymbol()) { 28028d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(state, Sym)) { 280317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose state = updateSymbol(state, Sym, *T, Summ.getArg(idx), hasErr, C); 2804294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2805294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorRange = CallOrMsg.getArgSourceRange(idx); 2806294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ErrorSym = Sym; 2807294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2808294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2809294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2810294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2811294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2812294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2813294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Evaluate the effect on the message receiver. 2814294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose bool ReceiverIsTracked = false; 28154531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!hasErr) { 2816cde8cdbd6a662c636164465ad309b5f17ff01064Jordan Rose const ObjCMethodCall *MsgInvocation = dyn_cast<ObjCMethodCall>(&CallOrMsg); 28174531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (MsgInvocation) { 28184531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (SymbolRef Sym = MsgInvocation->getReceiverSVal().getAsLocSymbol()) { 28198d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks if (const RefVal *T = getRefBinding(state, Sym)) { 28204531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ReceiverIsTracked = true; 28214531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose state = updateSymbol(state, Sym, *T, Summ.getReceiverEffect(), 2822554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks hasErr, C); 28234531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (hasErr) { 28248919e688dc610d1f632a4d43f7f1489f67255476Jordan Rose ErrorRange = MsgInvocation->getOriginExpr()->getReceiverRange(); 28254531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose ErrorSym = Sym; 28264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 2827294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2828294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2829294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2830294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2831294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2832294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Process any errors. 2833294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (hasErr) { 2834294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose processNonLeakError(state, ErrorRange, hasErr, ErrorSym, C); 2835294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 2836294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2837294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2838294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Consult the summary for the return value. 2839294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RetEffect RE = Summ.getRetEffect(); 2840294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2841294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (RE.getKind() == RetEffect::OwnedWhenTrackedReceiver) { 2842b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose if (ReceiverIsTracked) 284317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RE = getSummaryManager(C).getObjAllocRetEffect(); 2844b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose else 2845294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose RE = RetEffect::MakeNoRet(); 2846294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2847294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2848294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (RE.getKind()) { 2849294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 28507530c034c0c71a64c5a9173206d9742ae847af8bDavid Blaikie llvm_unreachable("Unhandled RetEffect."); 2851294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2852294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NoRet: 2853554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case RetEffect::NoRetHard: 2854294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // No work necessary. 2855294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2856294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2857294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedAllocatedSymbol: 2858294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::OwnedSymbol: { 28592f3017f9cbd3774f690c979410bfec38423d03afJordan Rose SymbolRef Sym = CallOrMsg.getReturnValue().getAsSymbol(); 2860294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2861294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2862294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 28634531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // Use the result type from the CallEvent as it automatically adjusts 2864294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // for methods/functions that return references. 28654531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose QualType ResultTy = CallOrMsg.getResultType(); 28668d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, RefVal::makeOwned(RE.getObjKind(), 28678d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks ResultTy)); 2868294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2869294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: Add a flag to the checker where allocations are assumed to 2870c6ba23f207410efcaf93132790218b9f9bcebe43Anna Zaks // *not* fail. 2871294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2872294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2873294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2874294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::GCNotOwnedSymbol: 2875294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::ARCNotOwnedSymbol: 2876294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RetEffect::NotOwnedSymbol: { 2877294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose const Expr *Ex = CallOrMsg.getOriginExpr(); 28782f3017f9cbd3774f690c979410bfec38423d03afJordan Rose SymbolRef Sym = CallOrMsg.getReturnValue().getAsSymbol(); 2879294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!Sym) 2880294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 288174616824108151e139d84338db609cc32f065c05Ted Kremenek assert(Ex); 2882294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Use GetReturnType in order to give [NSFoo alloc] the type NSFoo *. 2883294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose QualType ResultTy = GetReturnType(Ex, C.getASTContext()); 28848d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, RefVal::makeNotOwned(RE.getObjKind(), 28858d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks ResultTy)); 2886294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 2887294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2888294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2889294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2890294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // This check is actually necessary; otherwise the statement builder thinks 2891294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // we've hit a previously-found path. 2892294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Normally addTransition takes care of this, but we want the node pointer. 2893294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *NewNode; 2894294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (state == C.getState()) { 2895294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose NewNode = C.getPredecessor(); 2896294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } else { 28970bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks NewNode = C.addTransition(state); 2898294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 2899294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 29009c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // Annotate the node with summary we used. 29019c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (NewNode) { 29029c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose // FIXME: This is ugly. See checkEndAnalysis for why it's necessary. 29039c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose if (ShouldResetSummaryLog) { 29049c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose SummaryLog.clear(); 29059c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose ShouldResetSummaryLog = false; 29069c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2907ec9ef856fb43630949f64f8dbc5059ad47a750d3Jordy Rose SummaryLog[NewNode] = &Summ; 29089c083b766b5a1d26e22eda6d2f94e8370820485aJordy Rose } 2909294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 2910294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 2911e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 29128bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 29138bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::updateSymbol(ProgramStateRef state, SymbolRef sym, 2914910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal V, ArgEffect E, RefVal::Kind &hasErr, 2915910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 2916e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // In GC mode [... release] and [... retain] do nothing. 2917910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // In ARC mode they shouldn't exist at all, but we just ignore them. 291817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool IgnoreRetainMsg = C.isObjCGCEnabled(); 291917a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!IgnoreRetainMsg) 29204e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie IgnoreRetainMsg = (bool)C.getASTContext().getLangOpts().ObjCAutoRefCount; 292117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 2922e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 29234531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose default: 29244531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29254531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case IncRefMsg: 29264531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? DoNothing : IncRef; 29274531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29284531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case DecRefMsg: 29294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = IgnoreRetainMsg ? DoNothing : DecRef; 29304531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 2931554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefMsgAndStopTrackingHard: 2932554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks E = IgnoreRetainMsg ? StopTracking : DecRefAndStopTrackingHard; 29334531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 29344531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose case MakeCollectable: 29354531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose E = C.isObjCGCEnabled() ? DecRef : DoNothing; 29364531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose break; 2937e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2938e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2939e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Handle all use-after-releases. 294017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (!C.isObjCGCEnabled() && V.getKind() == RefVal::Released) { 2941e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 2942e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 29438d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 2944e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2945e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2946e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (E) { 2947e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefMsg: 2948e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRefMsg: 2949e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MakeCollectable: 2950554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefMsgAndStopTrackingHard: 2951e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("DecRefMsg/IncRefMsg/MakeCollectable already converted"); 2952e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2953e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Dealloc: 2954e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Any use of -dealloc in GC is *bad*. 295517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) { 2956e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocGC; 2957e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2958e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2959e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2960e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2961e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 2962e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 2963e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for an explicit dealloc."); 2964e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 2965e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // The object immediately transitions to the released state. 2966e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::Released; 2967e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V.clearCounts(); 29688d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 2969e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 2970e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorDeallocNotOwned; 2971e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 2972e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2973e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2974e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2975e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2976e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case MayEscape: 2977e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getKind() == RefVal::Owned) { 2978e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::NotOwned; 2979e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2980e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 2981e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2982e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Fall-through. 2983e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2984e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DoNothing: 2985e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2986e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2987e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case Autorelease: 298817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled()) 2989e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose return state; 2990e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Update the autorelease counts. 2991e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V.autorelease(); 2992e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 2993e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2994e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case StopTracking: 2995554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case StopTrackingHard: 29968d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 2997e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 2998e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case IncRef: 2999e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3000e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3001e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a retain."); 3002e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3003e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 3004e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V + 1; 3005e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3006e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3007e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 300817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3009e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = (V ^ RefVal::Owned) + 1; 3010e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3011e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3012e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3013e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3014e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRef: 3015e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case DecRefBridgedTransfered: 3016554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks case DecRefAndStopTrackingHard: 3017e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose switch (V.getKind()) { 3018e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose default: 3019e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // case 'RefVal::Released' handled above. 3020e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose llvm_unreachable("Invalid RefVal state for a release."); 3021e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3022e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Owned: 3023e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose assert(V.getCount() > 0); 3024e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose if (V.getCount() == 1) 3025e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ (E == DecRefBridgedTransfered ? 3026e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose RefVal::NotOwned : RefVal::Released); 3027554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks else if (E == DecRefAndStopTrackingHard) 30288d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 30294531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose 3030e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 3031e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3032e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3033e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::NotOwned: 30344531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (V.getCount() > 0) { 3035554067f290282f366ccf65a27e0b914aa67a52c6Anna Zaks if (E == DecRefAndStopTrackingHard) 30368d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sym); 3037e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V - 1; 30384531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } else { 3039e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorReleaseNotOwned; 3040e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3041e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3042e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3043e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 3044e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose case RefVal::Released: 3045e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose // Non-GC cases are handled above. 304617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose assert(C.isObjCGCEnabled()); 3047e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose V = V ^ RefVal::ErrorUseAfterRelease; 3048e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose hasErr = V.getKind(); 3049e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3050e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 3051e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose break; 3052e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose } 30538d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sym, V); 3054e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose} 3055e0a5d326137c13946603c739babc722fd1e9a94fJordy Rose 30568bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::processNonLeakError(ProgramStateRef St, 3057910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SourceRange ErrorRange, 3058910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RefVal::Kind ErrorKind, 3059910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 3060910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3061294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose ExplodedNode *N = C.generateSink(St); 3062294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (!N) 3063294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose return; 3064294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3065294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose CFRefBug *BT; 3066294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose switch (ErrorKind) { 3067294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose default: 3068294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose llvm_unreachable("Unhandled error."); 3069294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorUseAfterRelease: 3070d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!useAfterRelease) 3071d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose useAfterRelease.reset(new UseAfterRelease()); 3072d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*useAfterRelease; 3073294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3074294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorReleaseNotOwned: 3075d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!releaseNotOwned) 3076d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose releaseNotOwned.reset(new BadRelease()); 3077d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*releaseNotOwned; 3078294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3079294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocGC: 3080d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocGC) 3081d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocGC.reset(new DeallocGC()); 3082d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocGC; 3083294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3084294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose case RefVal::ErrorDeallocNotOwned: 3085d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!deallocNotOwned) 3086d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose deallocNotOwned.reset(new DeallocNotOwned()); 3087d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose BT = &*deallocNotOwned; 3088294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose break; 3089294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3090294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3091d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose assert(BT); 30924e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie CFRefReport *report = new CFRefReport(*BT, C.getASTContext().getLangOpts(), 309317a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, 309417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose N, Sym); 3095294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose report->addRange(ErrorRange); 3096785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose C.emitReport(report); 3097294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose} 3098294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 3099910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3100910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle the return values of retain-count-related functions. 3101910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3102910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3103910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosebool RetainCountChecker::evalCall(const CallExpr *CE, CheckerContext &C) const { 310476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the callee. We're only interested in simple C functions. 31058bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3106b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks const FunctionDecl *FD = C.getCalleeDecl(CE); 310776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!FD) 310876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 310976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 311076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose IdentifierInfo *II = FD->getIdentifier(); 311176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!II) 311276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 311376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 311476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // For now, we're only handling the functions that return aliases of their 311576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // arguments: CFRetain and CFMakeCollectable (and their families). 311676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Eventually we should add other functions we can model entirely, 311776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // such as CFRelease, which don't invalidate their arguments or globals. 311876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (CE->getNumArgs() != 1) 311976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 312076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 312176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Get the name of the function. 312276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose StringRef FName = II->getName(); 312376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose FName = FName.substr(FName.find_first_not_of('_')); 312476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 312576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // See if it's one of the specific functions we know how to eval. 312676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose bool canEval = false; 312776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3128b805c8ff133ef0c62df032fa711d6b13c5afd7f4Anna Zaks QualType ResultTy = CE->getCallReturnType(); 312976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (ResultTy->isObjCIdType()) { 313076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: id NSMakeCollectable(CFTypeRef) 313176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = II->isStr("NSMakeCollectable"); 313276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } else if (ResultTy->isPointerType()) { 313376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Handle: (CF|CG)Retain 313476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // CFMakeCollectable 313576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // It's okay to be a little sloppy here (CGMakeCollectable doesn't exist). 313676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (cocoa::isRefType(ResultTy, "CF", FName) || 313776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose cocoa::isRefType(ResultTy, "CG", FName)) { 313876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose canEval = isRetain(FD, FName) || isMakeCollectable(FD, FName); 313976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 314076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 314176c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 314276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (!canEval) 314376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return false; 314476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 314576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // Bind the return value. 31465eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx = C.getLocationContext(); 31475eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal RetVal = state->getSVal(CE->getArg(0), LCtx); 314876c506fba2359296d1f19e64998bd11d7b864563Jordy Rose if (RetVal.isUnknown()) { 314976c506fba2359296d1f19e64998bd11d7b864563Jordy Rose // If the receiver is unknown, conjure a return value. 315076c506fba2359296d1f19e64998bd11d7b864563Jordy Rose SValBuilder &SVB = C.getSValBuilder(); 315166c486f275531df6362b3511fc3af6563561801bTed Kremenek RetVal = SVB.conjureSymbolVal(0, CE, LCtx, ResultTy, C.blockCount()); 315276c506fba2359296d1f19e64998bd11d7b864563Jordy Rose } 31535eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state = state->BindExpr(CE, LCtx, RetVal, false); 315476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3155294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // FIXME: This should not be necessary, but otherwise the argument seems to be 3156294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // considered alive during the next statement. 3157294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (const MemRegion *ArgRegion = RetVal.getAsRegion()) { 3158294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Save the refcount status of the argument. 3159294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose SymbolRef Sym = RetVal.getAsLocSymbol(); 31608d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *Binding = 0; 3161294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Sym) 31628d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks Binding = getRefBinding(state, Sym); 316376c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3164294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Invalidate the argument region. 3165bf53dfac8195835028bd6347433f7dbebcc29fc1Anna Zaks state = state->invalidateRegions(ArgRegion, CE, C.blockCount(), LCtx, 316664eb070234bc4cd4fd2debf3a91c6e2d8f0d32d8Anna Zaks /*CausesPointerEscape*/ false); 316776c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3168294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose // Restore the refcount status of the argument. 3169294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose if (Binding) 31708d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, *Binding); 3171294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose } 3172294396b9f2a2f4ffee6b7ed5e61211fde50b6554Jordy Rose 31730bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 317476c506fba2359296d1f19e64998bd11d7b864563Jordy Rose return true; 317576c506fba2359296d1f19e64998bd11d7b864563Jordy Rose} 317676c506fba2359296d1f19e64998bd11d7b864563Jordy Rose 3177910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3178910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Handle return statements. 3179910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3180f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3181910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkPreStmt(const ReturnStmt *S, 3182910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3183e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3184e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // Only adjust the reference count if this is the top-level call frame, 3185e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // and not the result of inlining. In the future, we should do 3186e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // better checking even for inlined calls, and see if they match 3187e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // with their expected semantics (e.g., the method should return a retained 3188e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek // object, etc.). 3189fadcd5d5bbe1bfc1c6b8d819cc2242f780a49fecAnna Zaks if (!C.inTopFrame()) 3190e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek return; 3191e571578002fc3d4ebb654d2f31d2446d7cc1831dTed Kremenek 3192f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Expr *RetE = S->getRetValue(); 3193f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!RetE) 3194f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3195f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 31968bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 31975eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SymbolRef Sym = 31985eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek state->getSValAsScalarOrLoc(RetE, C.getLocationContext()).getAsLocSymbol(); 3199f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Sym) 3200f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3201f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3202f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the reference count binding (if any). 32038d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks const RefVal *T = getRefBinding(state, Sym); 3204f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!T) 3205f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3206f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3207f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Change the reference count. 3208f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose RefVal X = *T; 3209f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3210f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose switch (X.getKind()) { 3211f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::Owned: { 3212f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3213f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(cnt > 0); 3214f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3215f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3216f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3217f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3218f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3219f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose case RefVal::NotOwned: { 3220f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose unsigned cnt = X.getCount(); 3221f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (cnt) { 3222f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X.setCount(cnt - 1); 3223f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedOwned; 3224f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3225f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else { 3226f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ReturnedNotOwned; 3227f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3228f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose break; 3229f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3230f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3231f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose default: 3232f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3233f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3234f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3235f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the binding. 32368d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X); 32370bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *Pred = C.addTransition(state); 3238f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3239f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // At this point we have updated the state properly. 3240f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Everything after this is merely checking to see if the return value has 3241f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // been over- or under-retained. 3242f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3243f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 3244f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (!Pred) 3245f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3246f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3247f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Update the autorelease counts. 3248f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3249910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose AutoreleaseTag("RetainCountChecker : Autorelease"); 32504ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose state = handleAutoreleaseCounts(state, Pred, &AutoreleaseTag, C, Sym, X); 3251f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3252f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Did we cache out? 32534ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose if (!state) 3254f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose return; 3255f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3256f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Get the updated binding. 32578d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks T = getRefBinding(state, Sym); 3258f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose assert(T); 3259f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = *T; 3260f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3261f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Consult the summary of the enclosing method. 326217a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose RetainSummaryManager &Summaries = getSummaryManager(C); 3263f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose const Decl *CD = &Pred->getCodeDecl(); 32644531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RetEffect RE = RetEffect::MakeNoRet(); 3265f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32664531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose // FIXME: What is the convention for blocks? Is there one? 3267f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(CD)) { 3268b6cfc09d40ed73163373bec3fe240270326ad478Jordy Rose const RetainSummary *Summ = Summaries.getMethodSummary(MD); 32694531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = Summ->getRetEffect(); 32704531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CD)) { 32714531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose if (!isa<CXXMethodDecl>(FD)) { 32724531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose const RetainSummary *Summ = Summaries.getFunctionSummary(FD); 32734531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose RE = Summ->getRetEffect(); 32744531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose } 3275f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3276f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 32774531b7d64e1ed03a925ffdcfb4aa065f2721afb8Jordan Rose checkReturnWithRetEffect(S, C, Pred, RE, X, Sym, state); 3278f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3279f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3280910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkReturnWithRetEffect(const ReturnStmt *S, 3281910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C, 3282910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ExplodedNode *Pred, 3283910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose RetEffect RE, RefVal X, 3284910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, 32858bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state) const { 3286f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Any leaks or other errors? 3287f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (X.isReturnedOwned() && X.getCount() == 0) { 3288f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.getKind() != RetEffect::NoRet) { 3289f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose bool hasError = false; 329017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose if (C.isObjCGCEnabled() && RE.getObjKind() == RetEffect::ObjC) { 3291f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Things are more complicated with garbage collection. If the 3292f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // returned object is suppose to be an Objective-C object, we have 3293f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // a leak (as the caller expects a GC'ed object) because no 3294f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // method should return ownership unless it returns a CF object. 3295f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3296f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorGCLeakReturned; 3297f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3298f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose else if (!RE.isOwned()) { 3299f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Either we are using GC and the returned object is a CF type 3300f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // or we aren't using GC. In either case, we expect that the 3301f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // enclosing method is expected to return ownership. 3302f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose hasError = true; 3303f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose X = X ^ RefVal::ErrorLeakReturned; 3304f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3305f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3306f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (hasError) { 3307f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Generate an error node. 33088d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X); 3309f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3310f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3311910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnOwnLeakTag("RetainCountChecker : ReturnsOwnLeak"); 33120bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnOwnLeakTag); 3313f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 33144e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = C.getASTContext().getLangOpts(); 331517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool GCEnabled = C.isObjCGCEnabled(); 3316f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 331717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose new CFRefLeakReport(*getLeakAtReturnBug(LOpts, GCEnabled), 331817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose LOpts, GCEnabled, SummaryLog, 33196a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks N, Sym, C); 3320785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose C.emitReport(report); 3321f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3322f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3323f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3324f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } else if (X.isReturnedNotOwned()) { 3325f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (RE.isOwned()) { 3326f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // Trying to return a not owned object to a caller expecting an 3327f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose // owned object. 33288d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, X ^ RefVal::ErrorReturnedNotOwned); 3329f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 3330f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose static SimpleProgramPointTag 3331910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ReturnNotOwnedTag("RetainCountChecker : ReturnNotOwnedForOwned"); 33320bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks ExplodedNode *N = C.addTransition(state, Pred, &ReturnNotOwnedTag); 3333f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose if (N) { 3334d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!returnNotOwnedForOwned) 3335d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose returnNotOwnedForOwned.reset(new ReturnedNotOwnedForOwned()); 3336d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 3337f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose CFRefReport *report = 3338d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*returnNotOwnedForOwned, 33394e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie C.getASTContext().getLangOpts(), 334017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose C.isObjCGCEnabled(), SummaryLog, N, Sym); 3341785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose C.emitReport(report); 3342f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3343f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3344f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose } 3345f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose} 3346f53e8c7c1c4c4db3d7037217acbaa1af2dd089cbJordy Rose 33478d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 3348910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Check various ways a symbol can be invalidated. 3349910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 3350910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3351390909c89c98ab1807e15e033a72e975f866fb23Anna Zaksvoid RetainCountChecker::checkBind(SVal loc, SVal val, const Stmt *S, 3352910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 3353910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Are we storing to something that causes the value to "escape"? 3354910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool escapes = true; 3355910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3356910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // A value escapes in three possible cases (this may change): 3357910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // 3358910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (1) we are binding to something that is not a memory region. 3359910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (2) we are binding to a memregion that does not have stack storage 3360910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // (3) we are binding to a memregion with stack storage that the store 3361910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // does not understand. 33628bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3363910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3364dc84cd5efdd3430efb22546b4ac656aa0540b210David Blaikie if (Optional<loc::MemRegionVal> regionLoc = loc.getAs<loc::MemRegionVal>()) { 3365910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose escapes = !regionLoc->getRegion()->hasStackStorage(); 3366910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3367910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) { 3368910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // To test (3), generate a new state with the binding added. If it is 3369910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the same state, then it escapes (since the store cannot represent 3370910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // the binding). 3371e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // Do this only if we know that the store is not supposed to generate the 3372e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks // same state. 3373e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks SVal StoredVal = state->getSVal(regionLoc->getRegion()); 3374e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks if (StoredVal != val) 3375e7958da55ec0ec66e56b6beed6c6ce24dbdc4075Anna Zaks escapes = (state == (state->bindLoc(*regionLoc, val))); 3376910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3377de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek if (!escapes) { 3378de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // Case 4: We do not currently model what happens when a symbol is 3379de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // assigned to a struct field, so be conservative here and let the symbol 3380de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek // go. TODO: This could definitely be improved upon. 3381de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek escapes = !isa<VarRegion>(regionLoc->getRegion()); 3382de5b4fbe31e50641806234b3334eb9aa829673f8Ted Kremenek } 3383910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3384910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3385910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // If our store can represent the binding and we aren't storing to something 3386910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // that doesn't have local storage then just return and have the simulation 3387910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // state continue as is. 3388910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!escapes) 3389910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return; 3390910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3391910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Otherwise, find all symbols referenced by 'val' that we are tracking 3392910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // and stop tracking them. 3393910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->scanReachableSymbols<StopTrackingCallback>(val).getState(); 33940bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state); 3395910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3396910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 33978bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef RetainCountChecker::evalAssume(ProgramStateRef state, 3398910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SVal Cond, 3399910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool Assumption) const { 3400910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3401910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // FIXME: We may add to the interface of evalAssume the list of symbols 3402910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // whose assumptions have changed. For now we just iterate through the 3403910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // bindings and check if any of the tracked symbols are NULL. This isn't 3404910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // too bad since the number of symbols we will track in practice are 3405910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // probably small and evalAssume is only called at branches and a few 3406910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // other places. 3407166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose RefBindingsTy B = state->get<RefBindings>(); 3408910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3409910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (B.isEmpty()) 3410910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3411910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3412910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose bool changed = false; 3413166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose RefBindingsTy::Factory &RefBFactory = state->get_context<RefBindings>(); 3414910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3415166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose for (RefBindingsTy::iterator I = B.begin(), E = B.end(); I != E; ++I) { 341647cbd0f3892c7965cf16a58393f9f17a22d4d4d9Ted Kremenek // Check if the symbol is null stop tracking the symbol. 3417ec8d420d4fa57fc6b5a5a2b1446742e976a7ba00Jordan Rose ConstraintManager &CMgr = state->getConstraintManager(); 3418ec8d420d4fa57fc6b5a5a2b1446742e976a7ba00Jordan Rose ConditionTruthVal AllocFailed = CMgr.isNull(state, I.getKey()); 3419ec8d420d4fa57fc6b5a5a2b1446742e976a7ba00Jordan Rose if (AllocFailed.isConstrainedTrue()) { 3420910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose changed = true; 3421910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose B = RefBFactory.remove(B, I.getKey()); 3422910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3423910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3424910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3425910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (changed) 3426910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose state = state->set<RefBindings>(B); 3427910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3428910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3429910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3430910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 34318bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 34328bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::checkRegionChanges(ProgramStateRef state, 3433bf53dfac8195835028bd6347433f7dbebcc29fc1Anna Zaks const InvalidatedSymbols *invalidated, 3434910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose ArrayRef<const MemRegion *> ExplicitRegions, 343566c40400e7d6272b0cd675ada18dd62c1f0362c7Anna Zaks ArrayRef<const MemRegion *> Regions, 3436740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const { 3437910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (!invalidated) 3438910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3439910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3440910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose llvm::SmallPtrSet<SymbolRef, 8> WhitelistedSymbols; 3441910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose for (ArrayRef<const MemRegion *>::iterator I = ExplicitRegions.begin(), 3442910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = ExplicitRegions.end(); I != E; ++I) { 3443910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (const SymbolicRegion *SR = (*I)->StripCasts()->getAs<SymbolicRegion>()) 3444910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose WhitelistedSymbols.insert(SR->getSymbol()); 3445910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3446910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3447bf53dfac8195835028bd6347433f7dbebcc29fc1Anna Zaks for (InvalidatedSymbols::const_iterator I=invalidated->begin(), 3448910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose E = invalidated->end(); I!=E; ++I) { 3449910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sym = *I; 3450910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose if (WhitelistedSymbols.count(sym)) 3451910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose continue; 3452910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose // Remove any existing reference-count binding. 34538d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = removeRefBinding(state, sym); 3454910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose } 3455910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose return state; 3456910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose} 3457910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose 3458910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose//===----------------------------------------------------------------------===// 34598d22863184419faa2348bd5148c663197bc4bb00Jordy Rose// Handle dead symbols and end-of-path. 34608d22863184419faa2348bd5148c663197bc4bb00Jordy Rose//===----------------------------------------------------------------------===// 34618d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34624ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan RoseProgramStateRef 34634ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan RoseRetainCountChecker::handleAutoreleaseCounts(ProgramStateRef state, 34646a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred, 34652bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag, 34666a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 3467910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef Sym, RefVal V) const { 34688d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned ACnt = V.getAutoreleaseCount(); 34698d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34708d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // No autorelease counts? Nothing to be done. 34718d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!ACnt) 34724ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose return state; 34738d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34746a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks assert(!Ctx.isObjCGCEnabled() && "Autorelease counts in GC mode?"); 34758d22863184419faa2348bd5148c663197bc4bb00Jordy Rose unsigned Cnt = V.getCount(); 34768d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34778d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // FIXME: Handle sending 'autorelease' to already released object. 34788d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34798d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 34808d22863184419faa2348bd5148c663197bc4bb00Jordy Rose ++Cnt; 34818d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34828d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt <= Cnt) { 34838d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (ACnt == Cnt) { 34848d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.clearCounts(); 34858d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getKind() == RefVal::ReturnedOwned) 34868d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ReturnedNotOwned; 34878d22863184419faa2348bd5148c663197bc4bb00Jordy Rose else 34888d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::NotOwned; 34898d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } else { 34900217b1d045ea99fe792e83ed1a785816289dd53cAnna Zaks V.setCount(V.getCount() - ACnt); 34918d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V.setAutoreleaseCount(0); 34928d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 34934ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose return setRefBinding(state, Sym, V); 34948d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 34958d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 34968d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Woah! More autorelease counts then retain counts left. 34978d22863184419faa2348bd5148c663197bc4bb00Jordy Rose // Emit hard error. 34988d22863184419faa2348bd5148c663197bc4bb00Jordy Rose V = V ^ RefVal::ErrorOverAutorelease; 34998d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks state = setRefBinding(state, Sym, V); 35008d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3501fa06f0464a04bb7fce1fcfb3780d151bb029e00cJordan Rose ExplodedNode *N = Ctx.generateSink(state, Pred, Tag); 35022bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose if (N) { 3503f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<128> sbuf; 35048d22863184419faa2348bd5148c663197bc4bb00Jordy Rose llvm::raw_svector_ostream os(sbuf); 35058d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "Object over-autoreleased: object was sent -autorelease "; 35068d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (V.getAutoreleaseCount() > 1) 35078d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << V.getAutoreleaseCount() << " times "; 35088d22863184419faa2348bd5148c663197bc4bb00Jordy Rose os << "but the object has a +" << V.getCount() << " retain count"; 35098d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 3510d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose if (!overAutorelease) 3511d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose overAutorelease.reset(new OverAutorelease()); 3512d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose 35134e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35148d22863184419faa2348bd5148c663197bc4bb00Jordy Rose CFRefReport *report = 3515d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose new CFRefReport(*overAutorelease, LOpts, /* GCEnabled = */ false, 3516d6334e1d96fa5636dd1476902dc08edbbc8f4409Jordy Rose SummaryLog, N, Sym, os.str()); 3517785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose Ctx.emitReport(report); 35188d22863184419faa2348bd5148c663197bc4bb00Jordy Rose } 35198d22863184419faa2348bd5148c663197bc4bb00Jordy Rose 35204ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose return 0; 35218d22863184419faa2348bd5148c663197bc4bb00Jordy Rose} 352238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35238bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef 35248bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::handleSymbolDeath(ProgramStateRef state, 3525910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SymbolRef sid, RefVal V, 352638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVectorImpl<SymbolRef> &Leaked) const { 35275337612ff47e90979b781b20608fb494ca81869bJordy Rose bool hasLeak = false; 352838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (V.isOwned()) 352938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = true; 353038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose else if (V.isNotOwned() || V.isReturnedOwned()) 353138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose hasLeak = (V.getCount() > 0); 353238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 353338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!hasLeak) 35348d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return removeRefBinding(state, sid); 353538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 353638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose Leaked.push_back(sid); 35378d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks return setRefBinding(state, sid, V ^ RefVal::ErrorLeak); 353838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 353938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 354038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy RoseExplodedNode * 35418bef8238181a30e52dea380789a7e2d760eac532Ted KremenekRetainCountChecker::processLeaks(ProgramStateRef state, 3542910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose SmallVectorImpl<SymbolRef> &Leaked, 35436a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks CheckerContext &Ctx, 35446a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks ExplodedNode *Pred) const { 354538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Generate an intermediate node representing the leak point. 35462bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose ExplodedNode *N = Ctx.addTransition(state, Pred); 354738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 354838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (N) { 354938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SmallVectorImpl<SymbolRef>::iterator 355038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose I = Leaked.begin(), E = Leaked.end(); I != E; ++I) { 355138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35524e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie const LangOptions &LOpts = Ctx.getASTContext().getLangOpts(); 35536a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks bool GCEnabled = Ctx.isObjCGCEnabled(); 355417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefBug *BT = Pred ? getLeakWithinFunctionBug(LOpts, GCEnabled) 355517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose : getLeakAtReturnBug(LOpts, GCEnabled); 355638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose assert(BT && "BugType not initialized."); 35572058956954802229bf98604e8063fa57677abff4Jordy Rose 355817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose CFRefLeakReport *report = new CFRefLeakReport(*BT, LOpts, GCEnabled, 35596a93bd526c5136ee5a26871e829cf5a8548a1c6aAnna Zaks SummaryLog, N, *I, Ctx); 3560785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose Ctx.emitReport(report); 356138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 356238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 356338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 356438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return N; 356538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 356638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3567344c77aac25e5d960aced3f45fbaa09853383f6dAnna Zaksvoid RetainCountChecker::checkEndFunction(CheckerContext &Ctx) const { 35688bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = Ctx.getState(); 3569166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose RefBindingsTy B = state->get<RefBindings>(); 3570af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred = Ctx.getPredecessor(); 357138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3572166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose for (RefBindingsTy::iterator I = B.begin(), E = B.end(); I != E; ++I) { 35734ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose state = handleAutoreleaseCounts(state, Pred, /*Tag=*/0, Ctx, 35744ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose I->first, I->second); 35758d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 357638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 357738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 357838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35790cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // If the current LocationContext has a parent, don't check for leaks. 35800cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // We will do that later. 35818d6b43c4acf666499ed456ef90e143fa6e84392eAnna Zaks // FIXME: we should instead check for imbalances of the retain/releases, 35820cf3d471546251b12bdceff360f66c079c40526cTed Kremenek // and suggest annotations. 35830cf3d471546251b12bdceff360f66c079c40526cTed Kremenek if (Ctx.getLocationContext()->getParent()) 35840cf3d471546251b12bdceff360f66c079c40526cTed Kremenek return; 35850cf3d471546251b12bdceff360f66c079c40526cTed Kremenek 358638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = state->get<RefBindings>(); 358738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SmallVector<SymbolRef, 10> Leaked; 358838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3589166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose for (RefBindingsTy::iterator I = B.begin(), E = B.end(); I != E; ++I) 35908d22863184419faa2348bd5148c663197bc4bb00Jordy Rose state = handleSymbolDeath(state, I->first, I->second, Leaked); 359138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 35922bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose processLeaks(state, Leaked, Ctx, Pred); 359338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 359438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 359538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Roseconst ProgramPointTag * 3596910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy RoseRetainCountChecker::getDeadSymbolTag(SymbolRef sym) const { 359738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose const SimpleProgramPointTag *&tag = DeadSymbolTags[sym]; 359838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!tag) { 3599f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<64> buf; 360038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose llvm::raw_svector_ostream out(buf); 3601f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks out << "RetainCountChecker : Dead Symbol : "; 3602f62ceec2173e6eefa3879ffa6a7bd68cba463023Anna Zaks sym->dumpToStream(out); 360338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose tag = new SimpleProgramPointTag(out.str()); 360438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 360538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return tag; 360638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 360738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 3608910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rosevoid RetainCountChecker::checkDeadSymbols(SymbolReaper &SymReaper, 3609910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose CheckerContext &C) const { 361038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose ExplodedNode *Pred = C.getPredecessor(); 361138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36128bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state = C.getState(); 3613166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose RefBindingsTy B = state->get<RefBindings>(); 36144ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose SmallVector<SymbolRef, 10> Leaked; 361538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 361638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Update counts from autorelease pools 361738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose for (SymbolReaper::dead_iterator I = SymReaper.dead_begin(), 361838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose E = SymReaper.dead_end(); I != E; ++I) { 361938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose SymbolRef Sym = *I; 362038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (const RefVal *T = B.lookup(Sym)){ 362138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Use the symbol as the tag. 362238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // FIXME: This might not be as unique as we would like. 36232bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose const ProgramPointTag *Tag = getDeadSymbolTag(Sym); 36244ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose state = handleAutoreleaseCounts(state, Pred, Tag, C, Sym, *T); 36258d22863184419faa2348bd5148c663197bc4bb00Jordy Rose if (!state) 362638f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 36274ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose 36284ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose // Fetch the new reference count from the state, and use it to handle 36294ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose // this symbol. 36304ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose state = handleSymbolDeath(state, *I, *getRefBinding(state, Sym), Leaked); 363138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 363238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 363338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36344ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose if (Leaked.empty()) { 36354ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose C.addTransition(state); 36364ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose return; 363738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose } 363838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36392bce86c836f6d6e00f7d2f92bc20e5250d5c4232Jordan Rose Pred = processLeaks(state, Leaked, C, Pred); 364038f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 364138f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Did we cache out? 364238f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose if (!Pred) 364338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose return; 364438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 364538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose // Now generate a new node that nukes the old bindings. 36464ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose // The only bindings left at this point are the leaked symbols. 3647166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose RefBindingsTy::Factory &F = state->get_context<RefBindings>(); 36484ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose B = state->get<RefBindings>(); 364938f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36504ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose for (SmallVectorImpl<SymbolRef>::iterator I = Leaked.begin(), 36514ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose E = Leaked.end(); 36524ee1c557c3ebddb8a9be8f6fb66605b971793820Jordan Rose I != E; ++I) 365338f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose B = F.remove(B, *I); 365438f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 365538f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose state = state->set<RefBindings>(B); 36560bd6b110e908892d4b5c8671a9f435a1d72ad16aAnna Zaks C.addTransition(state, Pred); 365738f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose} 365838f17d6c86417944403dfa2b0d50a0dc92efa9ceJordy Rose 36598bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekvoid RetainCountChecker::printState(raw_ostream &Out, ProgramStateRef State, 3660910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose const char *NL, const char *Sep) const { 3661dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3662166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose RefBindingsTy B = State->get<RefBindings>(); 3663dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3664dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose if (!B.isEmpty()) 3665dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << Sep << NL; 3666dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3667166d502d5367ceacd1313a33cac43b1048b8524dJordan Rose for (RefBindingsTy::iterator I = B.begin(), E = B.end(); I != E; ++I) { 3668dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << I->first << " : "; 3669dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose I->second.print(Out); 3670dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose Out << NL; 3671dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose } 3672dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose} 3673dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose 3674dbd658e139b3e0bf084f75feaea8d844af9e319fJordy Rose//===----------------------------------------------------------------------===// 3675910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose// Checker registration. 36766b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek//===----------------------------------------------------------------------===// 36776b3a0f72137570d5fd93a8919abe16cbc9359d31Ted Kremenek 367817a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rosevoid ento::registerRetainCountChecker(CheckerManager &Mgr) { 3679910c4050b7cf0a5742a12e123b99ed29dacd9fbfJordy Rose Mgr.registerChecker<RetainCountChecker>(); 368017a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose} 368117a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 3682