| //===--- AnalysisConsumer.cpp - ASTConsumer for running Analyses ----------===// |
| // |
| // The LLVM Compiler Infrastructure |
| // |
| // This file is distributed under the University of Illinois Open Source |
| // License. See LICENSE.TXT for details. |
| // |
| //===----------------------------------------------------------------------===// |
| // |
| // "Meta" ASTConsumer for running different source analyses. |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #include "ASTConsumers.h" |
| #include "clang/Driver/HTMLDiagnostics.h" |
| #include "clang/AST/ASTConsumer.h" |
| #include "clang/AST/Decl.h" |
| #include "clang/AST/DeclObjC.h" |
| #include "llvm/Support/Compiler.h" |
| #include "llvm/ADT/OwningPtr.h" |
| #include "clang/AST/CFG.h" |
| #include "clang/Analysis/Analyses/LiveVariables.h" |
| #include "clang/Analysis/PathDiagnostic.h" |
| #include "clang/Basic/SourceManager.h" |
| #include "clang/Basic/FileManager.h" |
| #include "clang/AST/ParentMap.h" |
| #include "clang/AST/TranslationUnit.h" |
| #include "clang/Analysis/PathSensitive/BugReporter.h" |
| #include "clang/Analysis/Analyses/LiveVariables.h" |
| #include "clang/Analysis/LocalCheckers.h" |
| #include "clang/Analysis/PathSensitive/GRTransferFuncs.h" |
| #include "clang/Analysis/PathSensitive/GRExprEngine.h" |
| #include "llvm/Support/Streams.h" |
| #include "llvm/Support/raw_ostream.h" |
| #include "llvm/System/Path.h" |
| #include "llvm/System/Program.h" |
| #include <vector> |
| |
| using namespace clang; |
| |
| static ExplodedNodeImpl::Auditor* CreateUbiViz(); |
| |
| //===----------------------------------------------------------------------===// |
| // Basic type definitions. |
| //===----------------------------------------------------------------------===// |
| |
| namespace { |
| class AnalysisManager; |
| typedef void (*CodeAction)(AnalysisManager& Mgr); |
| } // end anonymous namespace |
| |
| //===----------------------------------------------------------------------===// |
| // AnalysisConsumer declaration. |
| //===----------------------------------------------------------------------===// |
| |
| namespace { |
| |
| class VISIBILITY_HIDDEN AnalysisConsumer : public ASTConsumer { |
| typedef std::vector<CodeAction> Actions; |
| Actions FunctionActions; |
| Actions ObjCMethodActions; |
| Actions ObjCImplementationActions; |
| |
| public: |
| const bool VisGraphviz; |
| const bool VisUbigraph; |
| const bool TrimGraph; |
| const LangOptions& LOpts; |
| Diagnostic &Diags; |
| ASTContext* Ctx; |
| Preprocessor* PP; |
| PreprocessorFactory* PPF; |
| const std::string HTMLDir; |
| const std::string FName; |
| llvm::OwningPtr<PathDiagnosticClient> PD; |
| bool AnalyzeAll; |
| |
| AnalysisConsumer(Diagnostic &diags, Preprocessor* pp, |
| PreprocessorFactory* ppf, |
| const LangOptions& lopts, |
| const std::string& fname, |
| const std::string& htmldir, |
| bool visgraphviz, bool visubi, bool trim, bool analyzeAll) |
| : VisGraphviz(visgraphviz), VisUbigraph(visubi), TrimGraph(trim), |
| LOpts(lopts), Diags(diags), |
| Ctx(0), PP(pp), PPF(ppf), |
| HTMLDir(htmldir), |
| FName(fname), |
| AnalyzeAll(analyzeAll) {} |
| |
| void addCodeAction(CodeAction action) { |
| FunctionActions.push_back(action); |
| ObjCMethodActions.push_back(action); |
| } |
| |
| void addObjCImplementationAction(CodeAction action) { |
| ObjCImplementationActions.push_back(action); |
| } |
| |
| virtual void Initialize(ASTContext &Context) { |
| Ctx = &Context; |
| } |
| |
| virtual void HandleTopLevelDecl(Decl *D); |
| virtual void HandleTranslationUnit(TranslationUnit &TU); |
| |
| void HandleCode(Decl* D, Stmt* Body, Actions actions); |
| }; |
| |
| |
| class VISIBILITY_HIDDEN AnalysisManager : public BugReporterData { |
| Decl* D; |
| Stmt* Body; |
| AnalysisConsumer& C; |
| bool DisplayedFunction; |
| |
| llvm::OwningPtr<CFG> cfg; |
| llvm::OwningPtr<LiveVariables> liveness; |
| llvm::OwningPtr<ParentMap> PM; |
| |
| public: |
| AnalysisManager(AnalysisConsumer& c, Decl* d, Stmt* b) |
| : D(d), Body(b), C(c), DisplayedFunction(false) {} |
| |
| |
| Decl* getCodeDecl() const { return D; } |
| Stmt* getBody() const { return Body; } |
| |
| virtual CFG* getCFG() { |
| if (!cfg) cfg.reset(CFG::buildCFG(getBody())); |
| return cfg.get(); |
| } |
| |
| virtual ParentMap& getParentMap() { |
| if (!PM) |
| PM.reset(new ParentMap(getBody())); |
| return *PM.get(); |
| } |
| |
| virtual ASTContext& getContext() { |
| return *C.Ctx; |
| } |
| |
| virtual SourceManager& getSourceManager() { |
| return getContext().getSourceManager(); |
| } |
| |
| virtual Diagnostic& getDiagnostic() { |
| return C.Diags; |
| } |
| |
| const LangOptions& getLangOptions() const { |
| return C.LOpts; |
| } |
| |
| virtual PathDiagnosticClient* getPathDiagnosticClient() { |
| if (C.PD.get() == 0 && !C.HTMLDir.empty()) |
| C.PD.reset(CreateHTMLDiagnosticClient(C.HTMLDir, C.PP, C.PPF)); |
| |
| return C.PD.get(); |
| } |
| |
| virtual LiveVariables* getLiveVariables() { |
| if (!liveness) { |
| CFG* c = getCFG(); |
| if (!c) return 0; |
| |
| liveness.reset(new LiveVariables(*c)); |
| liveness->runOnCFG(*c); |
| liveness->runOnAllBlocks(*c, 0, true); |
| } |
| |
| return liveness.get(); |
| } |
| |
| bool shouldVisualizeGraphviz() const { |
| return C.VisGraphviz; |
| } |
| |
| bool shouldVisualizeUbigraph() const { |
| return C.VisUbigraph; |
| } |
| |
| bool shouldVisualize() const { |
| return C.VisGraphviz || C.VisUbigraph; |
| } |
| |
| bool shouldTrimGraph() const { |
| return C.TrimGraph; |
| } |
| |
| void DisplayFunction() { |
| |
| if (DisplayedFunction) |
| return; |
| |
| DisplayedFunction = true; |
| |
| if (FunctionDecl *FD = dyn_cast<FunctionDecl>(getCodeDecl())) { |
| llvm::cerr << "ANALYZE: " |
| << getContext().getSourceManager().getSourceName(FD->getLocation()) |
| << ' ' |
| << FD->getIdentifier()->getName() |
| << '\n'; |
| } |
| else if (ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(getCodeDecl())) { |
| llvm::cerr << "ANALYZE (ObjC Method): " |
| << getContext().getSourceManager().getSourceName(MD->getLocation()) |
| << " '" |
| << MD->getSelector().getName() << "'\n"; |
| } |
| } |
| }; |
| |
| } // end anonymous namespace |
| |
| namespace llvm { |
| template <> struct FoldingSetTrait<CodeAction> { |
| static inline void Profile(CodeAction X, FoldingSetNodeID& ID) { |
| ID.AddPointer(reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(X))); |
| } |
| }; |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // AnalysisConsumer implementation. |
| //===----------------------------------------------------------------------===// |
| |
| void AnalysisConsumer::HandleTopLevelDecl(Decl *D) { |
| switch (D->getKind()) { |
| case Decl::Function: { |
| FunctionDecl* FD = cast<FunctionDecl>(D); |
| |
| if (FName.size() > 0 && FName != FD->getIdentifier()->getName()) |
| break; |
| |
| Stmt* Body = FD->getBody(); |
| if (Body) HandleCode(FD, Body, FunctionActions); |
| break; |
| } |
| |
| case Decl::ObjCMethod: { |
| ObjCMethodDecl* MD = cast<ObjCMethodDecl>(D); |
| |
| if (FName.size() > 0 && FName != MD->getSelector().getName()) |
| return; |
| |
| Stmt* Body = MD->getBody(); |
| if (Body) HandleCode(MD, Body, ObjCMethodActions); |
| break; |
| } |
| |
| default: |
| break; |
| } |
| } |
| |
| void AnalysisConsumer::HandleTranslationUnit(TranslationUnit& TU) { |
| |
| if (ObjCImplementationActions.empty()) |
| return; |
| |
| for (TranslationUnit::iterator I = TU.begin(), E = TU.end(); I!=E; ++I) { |
| |
| if (ObjCImplementationDecl* ID = dyn_cast<ObjCImplementationDecl>(*I)) |
| HandleCode(ID, 0, ObjCImplementationActions); |
| } |
| } |
| |
| void AnalysisConsumer::HandleCode(Decl* D, Stmt* Body, Actions actions) { |
| |
| // Don't run the actions if an error has occured with parsing the file. |
| if (Diags.hasErrorOccurred()) |
| return; |
| |
| SourceLocation Loc = D->getLocation(); |
| |
| // Only run actions on declarations defined in actual source. |
| if (!Loc.isFileID()) |
| return; |
| |
| // Don't run the actions on declarations in header files unless |
| // otherwise specified. |
| if (!AnalyzeAll && !Ctx->getSourceManager().isFromMainFile(Loc)) |
| return; |
| |
| // Create an AnalysisManager that will manage the state for analyzing |
| // this method/function. |
| AnalysisManager mgr(*this, D, Body); |
| |
| // Dispatch on the actions. |
| for (Actions::iterator I = actions.begin(), |
| E = actions.end(); I != E; ++I) |
| (*I)(mgr); |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // Analyses |
| //===----------------------------------------------------------------------===// |
| |
| static void ActionWarnDeadStores(AnalysisManager& mgr) { |
| if (LiveVariables* L = mgr.getLiveVariables()) { |
| BugReporter BR(mgr); |
| CheckDeadStores(*L, BR); |
| } |
| } |
| |
| static void ActionWarnUninitVals(AnalysisManager& mgr) { |
| if (CFG* c = mgr.getCFG()) |
| CheckUninitializedValues(*c, mgr.getContext(), mgr.getDiagnostic()); |
| } |
| |
| |
| static void ActionGRExprEngine(AnalysisManager& mgr, GRTransferFuncs* tf, |
| bool StandardWarnings = true) { |
| |
| |
| llvm::OwningPtr<GRTransferFuncs> TF(tf); |
| |
| // Construct the analysis engine. |
| LiveVariables* L = mgr.getLiveVariables(); |
| if (!L) return; |
| |
| // Display progress. |
| if (!mgr.shouldVisualize()) |
| mgr.DisplayFunction(); |
| |
| GRExprEngine Eng(*mgr.getCFG(), *mgr.getCodeDecl(), mgr.getContext(), *L); |
| Eng.setTransferFunctions(tf); |
| |
| if (StandardWarnings) { |
| Eng.RegisterInternalChecks(); |
| RegisterAppleChecks(Eng); |
| } |
| |
| // Set the graph auditor. |
| llvm::OwningPtr<ExplodedNodeImpl::Auditor> Auditor; |
| if (mgr.shouldVisualizeUbigraph()) { |
| Auditor.reset(CreateUbiViz()); |
| ExplodedNodeImpl::SetAuditor(Auditor.get()); |
| } |
| |
| // Execute the worklist algorithm. |
| Eng.ExecuteWorkList(); |
| |
| // Release the auditor (if any) so that it doesn't monitor the graph |
| // created BugReporter. |
| ExplodedNodeImpl::SetAuditor(0); |
| |
| // Display warnings. |
| Eng.EmitWarnings(mgr); |
| |
| // Visualize the exploded graph. |
| if (mgr.shouldVisualizeGraphviz()) |
| Eng.ViewGraph(mgr.shouldTrimGraph()); |
| } |
| |
| static void ActionCheckerCFRefAux(AnalysisManager& mgr, bool GCEnabled, |
| bool StandardWarnings) { |
| |
| GRTransferFuncs* TF = MakeCFRefCountTF(mgr.getContext(), |
| GCEnabled, |
| mgr.getLangOptions()); |
| |
| ActionGRExprEngine(mgr, TF, StandardWarnings); |
| } |
| |
| static void ActionCheckerCFRef(AnalysisManager& mgr) { |
| |
| switch (mgr.getLangOptions().getGCMode()) { |
| default: |
| assert (false && "Invalid GC mode."); |
| case LangOptions::NonGC: |
| ActionCheckerCFRefAux(mgr, false, true); |
| break; |
| |
| case LangOptions::GCOnly: |
| ActionCheckerCFRefAux(mgr, true, true); |
| break; |
| |
| case LangOptions::HybridGC: |
| ActionCheckerCFRefAux(mgr, false, true); |
| ActionCheckerCFRefAux(mgr, true, false); |
| break; |
| } |
| } |
| |
| static void ActionCheckerSimple(AnalysisManager& mgr) { |
| ActionGRExprEngine(mgr, MakeGRSimpleValsTF()); |
| } |
| |
| static void ActionDisplayLiveVariables(AnalysisManager& mgr) { |
| if (LiveVariables* L = mgr.getLiveVariables()) { |
| mgr.DisplayFunction(); |
| L->dumpBlockLiveness(mgr.getSourceManager()); |
| } |
| } |
| |
| static void ActionCFGDump(AnalysisManager& mgr) { |
| if (CFG* c = mgr.getCFG()) { |
| mgr.DisplayFunction(); |
| c->dump(); |
| } |
| } |
| |
| static void ActionCFGView(AnalysisManager& mgr) { |
| if (CFG* c = mgr.getCFG()) { |
| mgr.DisplayFunction(); |
| c->viewCFG(); |
| } |
| } |
| |
| static void ActionWarnObjCDealloc(AnalysisManager& mgr) { |
| if (mgr.getLangOptions().getGCMode() == LangOptions::GCOnly) |
| return; |
| |
| BugReporter BR(mgr); |
| |
| CheckObjCDealloc(cast<ObjCImplementationDecl>(mgr.getCodeDecl()), |
| mgr.getLangOptions(), BR); |
| } |
| |
| static void ActionWarnObjCUnusedIvars(AnalysisManager& mgr) { |
| BugReporter BR(mgr); |
| CheckObjCUnusedIvar(cast<ObjCImplementationDecl>(mgr.getCodeDecl()), BR); |
| } |
| |
| static void ActionWarnObjCMethSigs(AnalysisManager& mgr) { |
| BugReporter BR(mgr); |
| |
| CheckObjCInstMethSignature(cast<ObjCImplementationDecl>(mgr.getCodeDecl()), |
| BR); |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // AnalysisConsumer creation. |
| //===----------------------------------------------------------------------===// |
| |
| ASTConsumer* clang::CreateAnalysisConsumer(Analyses* Beg, Analyses* End, |
| Diagnostic &diags, Preprocessor* pp, |
| PreprocessorFactory* ppf, |
| const LangOptions& lopts, |
| const std::string& fname, |
| const std::string& htmldir, |
| bool VisGraphviz, bool VisUbi, |
| bool trim, |
| bool analyzeAll) { |
| |
| llvm::OwningPtr<AnalysisConsumer> |
| C(new AnalysisConsumer(diags, pp, ppf, lopts, fname, htmldir, |
| VisGraphviz, VisUbi, trim, analyzeAll)); |
| |
| for ( ; Beg != End ; ++Beg) |
| switch (*Beg) { |
| #define ANALYSIS(NAME, CMD, DESC, SCOPE)\ |
| case NAME:\ |
| C->add ## SCOPE ## Action(&Action ## NAME);\ |
| break; |
| #include "Analyses.def" |
| default: break; |
| } |
| |
| return C.take(); |
| } |
| |
| //===----------------------------------------------------------------------===// |
| // Ubigraph Visualization. FIXME: Move to separate file. |
| //===----------------------------------------------------------------------===// |
| |
| namespace { |
| |
| class UbigraphViz : public ExplodedNodeImpl::Auditor { |
| llvm::OwningPtr<llvm::raw_ostream> Out; |
| llvm::sys::Path Dir, Filename; |
| unsigned Cntr; |
| |
| typedef llvm::DenseMap<void*,unsigned> VMap; |
| VMap M; |
| |
| public: |
| UbigraphViz(llvm::raw_ostream* out, llvm::sys::Path& dir, |
| llvm::sys::Path& filename) |
| : Out(out), Dir(dir), Filename(filename), Cntr(0) {} |
| |
| ~UbigraphViz(); |
| |
| virtual void AddEdge(ExplodedNodeImpl* Src, ExplodedNodeImpl* Dst); |
| }; |
| |
| } // end anonymous namespace |
| |
| static ExplodedNodeImpl::Auditor* CreateUbiViz() { |
| std::string ErrMsg; |
| |
| llvm::sys::Path Dir = llvm::sys::Path::GetTemporaryDirectory(&ErrMsg); |
| if (!ErrMsg.empty()) |
| return 0; |
| |
| llvm::sys::Path Filename = Dir; |
| Filename.appendComponent("llvm_ubi"); |
| Filename.makeUnique(true,&ErrMsg); |
| |
| if (!ErrMsg.empty()) |
| return 0; |
| |
| llvm::cerr << "Writing '" << Filename << "'.\n"; |
| |
| llvm::OwningPtr<llvm::raw_fd_ostream> Stream; |
| std::string filename = Filename.toString(); |
| Stream.reset(new llvm::raw_fd_ostream(filename.c_str(), ErrMsg)); |
| |
| if (!ErrMsg.empty()) |
| return 0; |
| |
| return new UbigraphViz(Stream.take(), Dir, Filename); |
| } |
| |
| void UbigraphViz::AddEdge(ExplodedNodeImpl* Src, ExplodedNodeImpl* Dst) { |
| // Lookup the Src. If it is a new node, it's a root. |
| VMap::iterator SrcI= M.find(Src); |
| unsigned SrcID; |
| |
| if (SrcI == M.end()) { |
| M[Src] = SrcID = Cntr++; |
| *Out << "('vertex', " << SrcID << ", ('color','#00ff00'))\n"; |
| } |
| else |
| SrcID = SrcI->second; |
| |
| // Lookup the Dst. |
| VMap::iterator DstI= M.find(Dst); |
| unsigned DstID; |
| |
| if (DstI == M.end()) { |
| M[Dst] = DstID = Cntr++; |
| *Out << "('vertex', " << DstID << ")\n"; |
| } |
| else |
| DstID = DstI->second; |
| |
| // Add the edge. |
| *Out << "('edge', " << SrcID << ", " << DstID |
| << ", ('arrow','true'), ('oriented', 'true'))\n"; |
| } |
| |
| UbigraphViz::~UbigraphViz() { |
| Out.reset(0); |
| llvm::cerr << "Running 'ubiviz' program... "; |
| std::string ErrMsg; |
| llvm::sys::Path Ubiviz = llvm::sys::Program::FindProgramByName("ubiviz"); |
| std::vector<const char*> args; |
| args.push_back(Ubiviz.c_str()); |
| args.push_back(Filename.c_str()); |
| args.push_back(0); |
| |
| if (llvm::sys::Program::ExecuteAndWait(Ubiviz, &args[0],0,0,0,0,&ErrMsg)) { |
| llvm::cerr << "Error viewing graph: " << ErrMsg << "\n"; |
| } |
| |
| // Delete the directory. |
| Dir.eraseFromDisk(true); |
| } |