From cf1fe2247e68e1f3f65e79eebccfd1dde950a875 Mon Sep 17 00:00:00 2001 From: Kristof Umann Date: Wed, 15 May 2019 19:47:26 +0000 Subject: [PATCH] [analyzer] Add a test for plugins using checker dependencies Also, I moved the existing analyzer plugin to test/ as well, in order not to give the illusion that the analyzer supports plugins -- it's capable of handling them, but does not _support_ them. Differential Revision: https://reviews.llvm.org/D59464 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@360799 91177308-0d34-0410-b5e6-96231b3b80d8 --- examples/CMakeLists.txt | 3 -- test/Analysis/checker-plugins.c | 26 +++++++++++++++-- test/Analysis/lit.local.cfg | 2 ++ test/Analysis/plugins/CMakeLists.txt | 10 +++++++ .../CheckerDependencyHandling/CMakeLists.txt | 11 ++++++++ .../CheckerDependencyHandling.cpp | 28 +++++++++++++++++++ ...erDependencyHandlingAnalyzerPlugin.exports | 0 .../plugins/SampleAnalyzer}/CMakeLists.txt | 0 .../SampleAnalyzer}/MainCallChecker.cpp | 18 ++++++------ .../SampleAnalyzerPlugin.exports | 2 ++ test/CMakeLists.txt | 4 ++- 11 files changed, 89 insertions(+), 15 deletions(-) create mode 100644 test/Analysis/plugins/CMakeLists.txt create mode 100644 test/Analysis/plugins/CheckerDependencyHandling/CMakeLists.txt create mode 100644 test/Analysis/plugins/CheckerDependencyHandling/CheckerDependencyHandling.cpp rename examples/analyzer-plugin/SampleAnalyzerPlugin.exports => test/Analysis/plugins/CheckerDependencyHandling/CheckerDependencyHandlingAnalyzerPlugin.exports (100%) rename {examples/analyzer-plugin => test/Analysis/plugins/SampleAnalyzer}/CMakeLists.txt (100%) rename {examples/analyzer-plugin => test/Analysis/plugins/SampleAnalyzer}/MainCallChecker.cpp (74%) create mode 100644 test/Analysis/plugins/SampleAnalyzer/SampleAnalyzerPlugin.exports diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 8c2654840a..e4fedf3682 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -3,9 +3,6 @@ if(NOT CLANG_BUILD_EXAMPLES) set(EXCLUDE_FROM_ALL ON) endif() -if(CLANG_ENABLE_STATIC_ANALYZER) -add_subdirectory(analyzer-plugin) -endif() add_subdirectory(clang-interpreter) add_subdirectory(PrintFunctionNames) add_subdirectory(AnnotateFunctions) diff --git a/test/Analysis/checker-plugins.c b/test/Analysis/checker-plugins.c index ee60ec6e21..f0a5484ae1 100644 --- a/test/Analysis/checker-plugins.c +++ b/test/Analysis/checker-plugins.c @@ -1,5 +1,8 @@ -// RUN: %clang_analyze_cc1 -load %llvmshlibdir/SampleAnalyzerPlugin%pluginext -analyzer-checker='example.MainCallChecker' -verify %s -// REQUIRES: plugins, examples +// RUN: %clang_analyze_cc1 -verify %s \ +// RUN: -load %llvmshlibdir/SampleAnalyzerPlugin%pluginext \ +// RUN: -analyzer-checker='example.MainCallChecker' + +// REQUIRES: plugins // Test that the MainCallChecker example analyzer plugin loads and runs. @@ -8,3 +11,22 @@ int main(); void caller() { main(); // expected-warning {{call to main}} } + +// RUN: %clang_analyze_cc1 %s \ +// RUN: -load %llvmshlibdir/CheckerDependencyHandlingAnalyzerPlugin%pluginext\ +// RUN: -analyzer-checker=example.DependendentChecker \ +// RUN: -analyzer-list-enabled-checkers \ +// RUN: 2>&1 | FileCheck %s -check-prefix=CHECK-IMPLICITLY-ENABLED + +// CHECK-IMPLICITLY-ENABLED: example.Dependency +// CHECK-IMPLICITLY-ENABLED: example.DependendentChecker + +// RUN: %clang_analyze_cc1 %s \ +// RUN: -load %llvmshlibdir/CheckerDependencyHandlingAnalyzerPlugin%pluginext\ +// RUN: -analyzer-checker=example.DependendentChecker \ +// RUN: -analyzer-disable-checker=example.Dependency \ +// RUN: -analyzer-list-enabled-checkers \ +// RUN: 2>&1 | FileCheck %s -check-prefix=CHECK-IMPLICITLY-DISABLED + +// CHECK-IMPLICITLY-DISABLED-NOT: example.Dependency +// CHECK-IMPLICITLY-DISABLED-NOT: example.DependendentChecker diff --git a/test/Analysis/lit.local.cfg b/test/Analysis/lit.local.cfg index 84f7569152..b77cae8ece 100644 --- a/test/Analysis/lit.local.cfg +++ b/test/Analysis/lit.local.cfg @@ -18,5 +18,7 @@ config.substitutions.append(('%diff_plist', config.substitutions.append(('%diff_sarif', '''diff -U1 -w -I ".*file:.*%basename_t" -I '"version":' -I "2\.0\.0\-csd\.[0-9]*\.beta\."''')) +config.excludes.add('plugins') + if not config.root.clang_staticanalyzer: config.unsupported = True diff --git a/test/Analysis/plugins/CMakeLists.txt b/test/Analysis/plugins/CMakeLists.txt new file mode 100644 index 0000000000..3f538d9e0e --- /dev/null +++ b/test/Analysis/plugins/CMakeLists.txt @@ -0,0 +1,10 @@ +add_subdirectory(SampleAnalyzer) +add_subdirectory(CheckerDependencyHandling) + +set(CLANG_ANALYZER_PLUGIN_DEPS + SampleAnalyzerPlugin + CheckerDependencyHandlingAnalyzerPlugin + ) + +add_custom_target(clang-analyzer-plugin + DEPENDS ${CLANG_ANALYZER_PLUGIN_DEPS}) diff --git a/test/Analysis/plugins/CheckerDependencyHandling/CMakeLists.txt b/test/Analysis/plugins/CheckerDependencyHandling/CMakeLists.txt new file mode 100644 index 0000000000..80e2cdbd3a --- /dev/null +++ b/test/Analysis/plugins/CheckerDependencyHandling/CMakeLists.txt @@ -0,0 +1,11 @@ +set(LLVM_EXPORTED_SYMBOL_FILE ${CMAKE_CURRENT_SOURCE_DIR}/CheckerDependencyHandlingAnalyzerPlugin.exports) +add_llvm_library(CheckerDependencyHandlingAnalyzerPlugin MODULE CheckerDependencyHandling.cpp PLUGIN_TOOL clang) + +if(LLVM_ENABLE_PLUGINS AND (WIN32 OR CYGWIN)) + target_link_libraries(CheckerDependencyHandlingAnalyzerPlugin PRIVATE + clangAnalysis + clangAST + clangStaticAnalyzerCore + LLVMSupport + ) +endif() diff --git a/test/Analysis/plugins/CheckerDependencyHandling/CheckerDependencyHandling.cpp b/test/Analysis/plugins/CheckerDependencyHandling/CheckerDependencyHandling.cpp new file mode 100644 index 0000000000..be8e1200d0 --- /dev/null +++ b/test/Analysis/plugins/CheckerDependencyHandling/CheckerDependencyHandling.cpp @@ -0,0 +1,28 @@ +#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" +#include "clang/StaticAnalyzer/Core/Checker.h" +#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h" +#include "clang/StaticAnalyzer/Frontend/CheckerRegistry.h" + +using namespace clang; +using namespace ento; + +namespace { +struct Dependency : public Checker { + void checkBeginFunction(CheckerContext &Ctx) const {} +}; +struct DependendentChecker : public Checker { + void checkBeginFunction(CheckerContext &Ctx) const {} +}; +} // end anonymous namespace + +// Register plugin! +extern "C" void clang_registerCheckers(CheckerRegistry ®istry) { + registry.addChecker("example.Dependency", "", ""); + registry.addChecker("example.DependendentChecker", "", + ""); + + registry.addDependency("example.DependendentChecker", "example.Dependency"); +} + +extern "C" const char clang_analyzerAPIVersionString[] = + CLANG_ANALYZER_API_VERSION_STRING; diff --git a/examples/analyzer-plugin/SampleAnalyzerPlugin.exports b/test/Analysis/plugins/CheckerDependencyHandling/CheckerDependencyHandlingAnalyzerPlugin.exports similarity index 100% rename from examples/analyzer-plugin/SampleAnalyzerPlugin.exports rename to test/Analysis/plugins/CheckerDependencyHandling/CheckerDependencyHandlingAnalyzerPlugin.exports diff --git a/examples/analyzer-plugin/CMakeLists.txt b/test/Analysis/plugins/SampleAnalyzer/CMakeLists.txt similarity index 100% rename from examples/analyzer-plugin/CMakeLists.txt rename to test/Analysis/plugins/SampleAnalyzer/CMakeLists.txt diff --git a/examples/analyzer-plugin/MainCallChecker.cpp b/test/Analysis/plugins/SampleAnalyzer/MainCallChecker.cpp similarity index 74% rename from examples/analyzer-plugin/MainCallChecker.cpp rename to test/Analysis/plugins/SampleAnalyzer/MainCallChecker.cpp index 77316d696d..8bd4085108 100644 --- a/examples/analyzer-plugin/MainCallChecker.cpp +++ b/test/Analysis/plugins/SampleAnalyzer/MainCallChecker.cpp @@ -1,13 +1,13 @@ -#include "clang/StaticAnalyzer/Core/Checker.h" #include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" -#include "clang/StaticAnalyzer/Frontend/CheckerRegistry.h" +#include "clang/StaticAnalyzer/Core/Checker.h" #include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h" +#include "clang/StaticAnalyzer/Frontend/CheckerRegistry.h" using namespace clang; using namespace ento; namespace { -class MainCallChecker : public Checker < check::PreStmt > { +class MainCallChecker : public Checker> { mutable std::unique_ptr BT; public: @@ -15,7 +15,8 @@ public: }; } // end anonymous namespace -void MainCallChecker::checkPreStmt(const CallExpr *CE, CheckerContext &C) const { +void MainCallChecker::checkPreStmt(const CallExpr *CE, + CheckerContext &C) const { const Expr *Callee = CE->getCallee(); const FunctionDecl *FD = C.getSVal(Callee).getAsFunctionDecl(); @@ -24,7 +25,7 @@ void MainCallChecker::checkPreStmt(const CallExpr *CE, CheckerContext &C) const // Get the name of the callee. IdentifierInfo *II = FD->getIdentifier(); - if (!II) // if no identifier, not a simple C function + if (!II) // if no identifier, not a simple C function return; if (II->isStr("main")) { @@ -43,12 +44,11 @@ void MainCallChecker::checkPreStmt(const CallExpr *CE, CheckerContext &C) const } // Register plugin! -extern "C" -void clang_registerCheckers (CheckerRegistry ®istry) { +extern "C" void clang_registerCheckers(CheckerRegistry ®istry) { registry.addChecker( "example.MainCallChecker", "Disallows calls to functions called main", ""); } -extern "C" -const char clang_analyzerAPIVersionString[] = CLANG_ANALYZER_API_VERSION_STRING; +extern "C" const char clang_analyzerAPIVersionString[] = + CLANG_ANALYZER_API_VERSION_STRING; diff --git a/test/Analysis/plugins/SampleAnalyzer/SampleAnalyzerPlugin.exports b/test/Analysis/plugins/SampleAnalyzer/SampleAnalyzerPlugin.exports new file mode 100644 index 0000000000..8d9ff882cf --- /dev/null +++ b/test/Analysis/plugins/SampleAnalyzer/SampleAnalyzerPlugin.exports @@ -0,0 +1,2 @@ +clang_registerCheckers +clang_analyzerAPIVersionString diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index 65a1d6e91f..43e49d5b95 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -139,13 +139,15 @@ if (CLANG_ENABLE_STATIC_ANALYZER) # check-all would launch those tests via check-clang. set(EXCLUDE_FROM_ALL ON) + add_subdirectory(Analysis/plugins) + list(APPEND CLANG_TEST_DEPS clang-analyzer-plugin) + add_lit_testsuite(check-clang-analyzer "Running the Clang analyzer tests" ${CMAKE_CURRENT_BINARY_DIR}/Analysis PARAMS ${ANALYZER_TEST_PARAMS} DEPENDS ${CLANG_TEST_DEPS}) set_target_properties(check-clang-analyzer PROPERTIES FOLDER "Clang tests") - if (LLVM_WITH_Z3) add_lit_testsuite(check-clang-analyzer-z3 "Running the Clang analyzer tests, using Z3 as a solver" ${CMAKE_CURRENT_BINARY_DIR}/Analysis -- 2.40.0