a807e8ea9f
This commit tweaks the interface of `CheckerRegistry::addChecker` to make it more practical for plugins and tests: - The parameter `IsHidden` now defaults to `false` even in the non-templated overload (because setting it to true is unusual, especially in plugins). - The parameter `DocsUri` defaults to the dummy placeholder string `"NoDocsUri"` because (as of now) nothing queries its value from the checker registry (it's only used by the logic that generates the clang-tidy documentation, but that loads it directly from `Checkers.td` without involving the `CheckerRegistry`), so there is no reason to demand specifying this value. In addition to propagating these changes, this commit clarifies, corrects and extends lots of comments and performs various minor code quality improvements in the code of unit tests and example plugins. I originally wrote the bulk of this commit when I was planning to add an extra parameter to `addChecker` in order to implement some technical details of the CheckerFamily framework. At the end I decided against adding that extra parameter, so this cleanup was left out of the PR https://github.com/llvm/llvm-project/pull/139256 and I'm merging it now as a separate commit (after minor tweaks). This commit is mostly NFC: the only functional change is that the analyzer will be compatible with plugins that rely on the default argument values and don't specify `IsHidden` or `DocsUri`. (But existing plugin code will remain valid as well.)
103 lines
3.5 KiB
C++
103 lines
3.5 KiB
C++
//===- unittests/StaticAnalyzer/SValSimplifyerTest.cpp --------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "CheckerRegistration.h"
|
|
#include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h"
|
|
#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
|
|
#include "clang/StaticAnalyzer/Core/Checker.h"
|
|
#include "clang/StaticAnalyzer/Core/PathSensitive/CallDescription.h"
|
|
#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
|
|
#include "clang/StaticAnalyzer/Frontend/AnalysisConsumer.h"
|
|
#include "clang/StaticAnalyzer/Frontend/CheckerRegistry.h"
|
|
#include "llvm/ADT/Twine.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
#include "gtest/gtest.h"
|
|
|
|
using namespace clang;
|
|
using namespace ento;
|
|
|
|
static std::string toString(SVal V) {
|
|
std::string Result;
|
|
llvm::raw_string_ostream Stream(Result);
|
|
V.dumpToStream(Stream);
|
|
return Result;
|
|
}
|
|
|
|
static void replace(std::string &Content, StringRef Substr,
|
|
StringRef Replacement) {
|
|
std::size_t Pos = 0;
|
|
while ((Pos = Content.find(Substr, Pos)) != std::string::npos) {
|
|
Content.replace(Pos, Substr.size(), Replacement);
|
|
Pos += Replacement.size();
|
|
}
|
|
}
|
|
|
|
namespace {
|
|
|
|
class SimplifyChecker : public Checker<check::PreCall> {
|
|
const BugType Bug{this, "SimplifyChecker"};
|
|
const CallDescription SimplifyCall{CDM::SimpleFunc, {"simplify"}, 1};
|
|
|
|
void report(CheckerContext &C, const Expr *E, StringRef Description) const {
|
|
PathDiagnosticLocation Loc(E->getExprLoc(), C.getSourceManager());
|
|
auto Report = std::make_unique<BasicBugReport>(Bug, Description, Loc);
|
|
C.emitReport(std::move(Report));
|
|
}
|
|
|
|
public:
|
|
void checkPreCall(const CallEvent &Call, CheckerContext &C) const {
|
|
if (!SimplifyCall.matches(Call))
|
|
return;
|
|
const Expr *Arg = Call.getArgExpr(0);
|
|
SVal Val = C.getSVal(Arg);
|
|
SVal SimplifiedVal = C.getSValBuilder().simplifySVal(C.getState(), Val);
|
|
std::string Subject = toString(Val);
|
|
std::string Simplified = toString(SimplifiedVal);
|
|
std::string Message = (llvm::Twine{Subject} + " -> " + Simplified).str();
|
|
report(C, Arg, Message);
|
|
}
|
|
};
|
|
} // namespace
|
|
|
|
static void addSimplifyChecker(AnalysisASTConsumer &AnalysisConsumer,
|
|
AnalyzerOptions &AnOpts) {
|
|
AnOpts.CheckersAndPackages = {{"SimplifyChecker", true}};
|
|
AnalysisConsumer.AddCheckerRegistrationFn([](CheckerRegistry &Registry) {
|
|
Registry.addChecker<SimplifyChecker>("SimplifyChecker", "MockDescription");
|
|
});
|
|
}
|
|
|
|
static void runThisCheckerOnCode(const std::string &Code, std::string &Diags) {
|
|
ASSERT_TRUE(runCheckerOnCode<addSimplifyChecker>(Code, Diags,
|
|
/*OnlyEmitWarnings=*/true));
|
|
ASSERT_FALSE(Diags.empty());
|
|
ASSERT_EQ(Diags.back(), '\n');
|
|
Diags.pop_back();
|
|
}
|
|
|
|
namespace {
|
|
|
|
TEST(SValSimplifyerTest, LHSConstrainedNullPtrDiff) {
|
|
constexpr auto Code = R"cpp(
|
|
template <class T> void simplify(T);
|
|
void LHSConstrainedNullPtrDiff(char *p, char *q) {
|
|
int diff = p - q;
|
|
if (!p)
|
|
simplify(diff);
|
|
})cpp";
|
|
|
|
std::string Diags;
|
|
runThisCheckerOnCode(Code, Diags);
|
|
replace(Diags, "(reg_$0<char * p>)", "reg_p");
|
|
replace(Diags, "(reg_$1<char * q>)", "reg_q");
|
|
// This should not be simplified to "Unknown".
|
|
EXPECT_EQ(Diags, "SimplifyChecker: reg_p - reg_q -> 0U - reg_q");
|
|
}
|
|
|
|
} // namespace
|