ObjCUnusedIVarsChecker.cpp revision 581deb3da481053c4993c7600f97acf7768caac5
1e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek//==- ObjCUnusedIVarsChecker.cpp - Check for unused ivars --------*- C++ -*-==// 2395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// 3395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// The LLVM Compiler Infrastructure 4395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// 5395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// This file is distributed under the University of Illinois Open Source 6395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// License. See LICENSE.TXT for details. 7395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// 8395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek//===----------------------------------------------------------------------===// 9395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// 10395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// This file defines a CheckObjCUnusedIvars, a checker that 11395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// analyzes an Objective-C class's interface/implementation to determine if it 12395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// has any ivars that are never accessed. 13395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek// 14395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek//===----------------------------------------------------------------------===// 15395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek 167dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis#include "ClangSACheckers.h" 17ec8605f1d7ec846dbf51047bfd5c56d32d1ff91cArgyrios Kyrtzidis#include "clang/StaticAnalyzer/Core/Checker.h" 189b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 199b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h" 20395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek#include "clang/AST/ExprObjC.h" 21395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek#include "clang/AST/Expr.h" 22395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek#include "clang/AST/DeclObjC.h" 23395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek#include "clang/Basic/LangOptions.h" 2458652887b08da3207226ec6d8bdb59ec0e96edfeBenjamin Kramer#include "clang/Basic/SourceManager.h" 25395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek 26395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenekusing namespace clang; 279ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremenekusing namespace ento; 28395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek 29395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenekenum IVarState { Unused, Used }; 300b2dd776318e612c682d32e1f4ca70f7b223c05eTed Kremenektypedef llvm::DenseMap<const ObjCIvarDecl*,IVarState> IvarUsageMap; 31395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek 329c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic void Scan(IvarUsageMap& M, const Stmt *S) { 33395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek if (!S) 34395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek return; 351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3635ffcf3c2a054ee124fe8d47152c5d1bcdf86261Ted Kremenek if (const ObjCIvarRefExpr *Ex = dyn_cast<ObjCIvarRefExpr>(S)) { 3735ffcf3c2a054ee124fe8d47152c5d1bcdf86261Ted Kremenek const ObjCIvarDecl *D = Ex->getDecl(); 38395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek IvarUsageMap::iterator I = M.find(D); 390b2dd776318e612c682d32e1f4ca70f7b223c05eTed Kremenek if (I != M.end()) 400b2dd776318e612c682d32e1f4ca70f7b223c05eTed Kremenek I->second = Used; 41694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek return; 42395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek } 431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4435ffcf3c2a054ee124fe8d47152c5d1bcdf86261Ted Kremenek // Blocks can reference an instance variable of a class. 4535ffcf3c2a054ee124fe8d47152c5d1bcdf86261Ted Kremenek if (const BlockExpr *BE = dyn_cast<BlockExpr>(S)) { 4635ffcf3c2a054ee124fe8d47152c5d1bcdf86261Ted Kremenek Scan(M, BE->getBody()); 4735ffcf3c2a054ee124fe8d47152c5d1bcdf86261Ted Kremenek return; 4835ffcf3c2a054ee124fe8d47152c5d1bcdf86261Ted Kremenek } 4935ffcf3c2a054ee124fe8d47152c5d1bcdf86261Ted Kremenek 505ec351c9507f12d5bede569c51d5257fad167134Anna Zaks if (const PseudoObjectExpr *POE = dyn_cast<PseudoObjectExpr>(S)) 515ec351c9507f12d5bede569c51d5257fad167134Anna Zaks for (PseudoObjectExpr::const_semantics_iterator 525ec351c9507f12d5bede569c51d5257fad167134Anna Zaks i = POE->semantics_begin(), e = POE->semantics_end(); i != e; ++i) { 535ec351c9507f12d5bede569c51d5257fad167134Anna Zaks const Expr *sub = *i; 545ec351c9507f12d5bede569c51d5257fad167134Anna Zaks if (const OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(sub)) 555ec351c9507f12d5bede569c51d5257fad167134Anna Zaks sub = OVE->getSourceExpr(); 565ec351c9507f12d5bede569c51d5257fad167134Anna Zaks Scan(M, sub); 575ec351c9507f12d5bede569c51d5257fad167134Anna Zaks } 585ec351c9507f12d5bede569c51d5257fad167134Anna Zaks 590b2dd776318e612c682d32e1f4ca70f7b223c05eTed Kremenek for (Stmt::const_child_iterator I=S->child_begin(),E=S->child_end(); I!=E;++I) 60694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek Scan(M, *I); 61694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek} 62694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek 639c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic void Scan(IvarUsageMap& M, const ObjCPropertyImplDecl *D) { 64694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek if (!D) 65694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek return; 661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 679c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCIvarDecl *ID = D->getPropertyIvarDecl(); 68694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek 69694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek if (!ID) 70694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek return; 711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 72694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek IvarUsageMap::iterator I = M.find(ID); 730b2dd776318e612c682d32e1f4ca70f7b223c05eTed Kremenek if (I != M.end()) 740b2dd776318e612c682d32e1f4ca70f7b223c05eTed Kremenek I->second = Used; 75395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek} 76395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek 779c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic void Scan(IvarUsageMap& M, const ObjCContainerDecl *D) { 788fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek // Scan the methods for accesses. 798fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek for (ObjCContainerDecl::instmeth_iterator I = D->instmeth_begin(), 808fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek E = D->instmeth_end(); I!=E; ++I) 818fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek Scan(M, (*I)->getBody()); 82e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek 83e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek if (const ObjCImplementationDecl *ID = dyn_cast<ObjCImplementationDecl>(D)) { 848fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek // Scan for @synthesized property methods that act as setters/getters 858fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek // to an ivar. 868fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek for (ObjCImplementationDecl::propimpl_iterator I = ID->propimpl_begin(), 878fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek E = ID->propimpl_end(); I!=E; ++I) 88581deb3da481053c4993c7600f97acf7768caac5David Blaikie Scan(M, *I); 89e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek 90e8ec699167a7c3a2872feefd03e0ea2fabb980e0Ted Kremenek // Scan the associated categories as well. 91e8ec699167a7c3a2872feefd03e0ea2fabb980e0Ted Kremenek for (const ObjCCategoryDecl *CD = 92e8ec699167a7c3a2872feefd03e0ea2fabb980e0Ted Kremenek ID->getClassInterface()->getCategoryList(); CD ; 93e8ec699167a7c3a2872feefd03e0ea2fabb980e0Ted Kremenek CD = CD->getNextClassCategory()) { 94e8ec699167a7c3a2872feefd03e0ea2fabb980e0Ted Kremenek if (const ObjCCategoryImplDecl *CID = CD->getImplementation()) 95e8ec699167a7c3a2872feefd03e0ea2fabb980e0Ted Kremenek Scan(M, CID); 96e8ec699167a7c3a2872feefd03e0ea2fabb980e0Ted Kremenek } 978fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek } 988fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek} 998fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek 100b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenekstatic void Scan(IvarUsageMap &M, const DeclContext *C, const FileID FID, 101b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek SourceManager &SM) { 102b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek for (DeclContext::decl_iterator I=C->decls_begin(), E=C->decls_end(); 103b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek I!=E; ++I) 104b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(*I)) { 105b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek SourceLocation L = FD->getLocStart(); 106e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek if (SM.getFileID(L) == FID) 107b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek Scan(M, FD->getBody()); 108b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek } 109b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek} 110b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek 1117dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidisstatic void checkObjCUnusedIvar(const ObjCImplementationDecl *D, 1122376002038c8b904acd20be754aedd1a7471be71Ted Kremenek BugReporter &BR) { 113395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek 1149c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCInterfaceDecl *ID = D->getClassInterface(); 115395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek IvarUsageMap M; 116395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek 117395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek // Iterate over the ivars. 1180b2dd776318e612c682d32e1f4ca70f7b223c05eTed Kremenek for (ObjCInterfaceDecl::ivar_iterator I=ID->ivar_begin(), 1190b2dd776318e612c682d32e1f4ca70f7b223c05eTed Kremenek E=ID->ivar_end(); I!=E; ++I) { 1201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 121581deb3da481053c4993c7600f97acf7768caac5David Blaikie const ObjCIvarDecl *ID = *I; 1221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 123e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek // Ignore ivars that... 124e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek // (a) aren't private 125e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek // (b) explicitly marked unused 126e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek // (c) are iboutlets 127ed50a8a7a8b5fbb5d365b39c81ec389e19e4360eTed Kremenek // (d) are unnamed bitfields 128e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek if (ID->getAccessControl() != ObjCIvarDecl::Private || 129857e918a8a40deb128840308a318bf623d68295fTed Kremenek ID->getAttr<UnusedAttr>() || ID->getAttr<IBOutletAttr>() || 130ed50a8a7a8b5fbb5d365b39c81ec389e19e4360eTed Kremenek ID->getAttr<IBOutletCollectionAttr>() || 131ed50a8a7a8b5fbb5d365b39c81ec389e19e4360eTed Kremenek ID->isUnnamedBitfield()) 132395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek continue; 1331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 134395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek M[ID] = Unused; 135395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek } 136395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek 137395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek if (M.empty()) 138395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek return; 139e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek 1408fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek // Now scan the implementation declaration. 1418fa3a1a6732dda5e4bd8815cc64ab516da5c19fcTed Kremenek Scan(M, D); 1421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 143b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek // Any potentially unused ivars? 144b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek bool hasUnused = false; 145b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek for (IvarUsageMap::iterator I = M.begin(), E = M.end(); I!=E; ++I) 146b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek if (I->second == Unused) { 147b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek hasUnused = true; 148b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek break; 149b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek } 150e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek 151b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek if (!hasUnused) 152b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek return; 153e3972a902d4a6f61fb21df092da2cace2b16cb3eTed Kremenek 154b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek // We found some potentially unused ivars. Scan the entire translation unit 155b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek // for functions inside the @implementation that reference these ivars. 156b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek // FIXME: In the future hopefully we can just use the lexical DeclContext 157b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek // to go from the ObjCImplementationDecl to the lexically "nested" 158b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek // C functions. 159b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek SourceManager &SM = BR.getSourceManager(); 160b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek Scan(M, D->getDeclContext(), SM.getFileID(D->getLocation()), SM); 161b221e4fb46f6e35b0721399ed2734daadbcc1f00Ted Kremenek 162395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek // Find ivars that are unused. 163395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek for (IvarUsageMap::iterator I = M.begin(), E = M.end(); I!=E; ++I) 164395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek if (I->second == Unused) { 16553ba0b636194dbeaa65a6f85316c9397a0c5298bTed Kremenek std::string sbuf; 16653ba0b636194dbeaa65a6f85316c9397a0c5298bTed Kremenek llvm::raw_string_ostream os(sbuf); 167b8989f27f116ff2400e92a52c067a69846119eb5Benjamin Kramer os << "Instance variable '" << *I->first << "' in class '" << *ID 168694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek << "' is never used by the methods in its @implementation " 169694eefb7452dd650bae16e1026571ab5a43a74fcTed Kremenek "(although it may be used by category methods)."; 170cc87ba2b950cfef2ef43019627330975a7daf73aTed Kremenek 171590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation L = 172590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation::create(I->first, BR.getSourceManager()); 17307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek BR.EmitBasicReport(D, "Unused instance variable", "Optimization", 174590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks os.str(), L); 175395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek } 176395aaf20d6e1ab04741562dc6b7d47164bcbd87eTed Kremenek} 1777dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis 1787dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 1797dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis// ObjCUnusedIvarsChecker 1807dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 1817dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis 1827dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidisnamespace { 183ec8605f1d7ec846dbf51047bfd5c56d32d1ff91cArgyrios Kyrtzidisclass ObjCUnusedIvarsChecker : public Checker< 1847dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis check::ASTDecl<ObjCImplementationDecl> > { 1857dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidispublic: 1867dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis void checkASTDecl(const ObjCImplementationDecl *D, AnalysisManager& mgr, 1877dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis BugReporter &BR) const { 1887dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis checkObjCUnusedIvar(D, BR); 1897dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis } 1907dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis}; 1917dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis} 1927dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis 1937dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidisvoid ento::registerObjCUnusedIvarsChecker(CheckerManager &mgr) { 1947dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis mgr.registerChecker<ObjCUnusedIvarsChecker>(); 1957dd445ec20e704846cfbdb132e56539280d71311Argyrios Kyrtzidis} 196