6ac286cd49
This PR add stacktrace of escaped exception to `bugprone-exception-escape` check. Changes: 1. Modified `ExceptionAnalyzer` and `ExceptionInfo` classes to hold stacktrace of escaped exception in `llvm::MapVector`. `llvm::MapVector` is needed to hold relative positions of functions in stack as well as have fast lookup. 2. Added new diagnostics based of `misc-no-recursion` check. Fixes https://github.com/llvm/llvm-project/issues/87422.
123 lines
4.4 KiB
C++
123 lines
4.4 KiB
C++
//===--- ExceptionEscapeCheck.cpp - clang-tidy ----------------------------===//
|
|
//
|
|
// 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 "ExceptionEscapeCheck.h"
|
|
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
#include "llvm/ADT/StringSet.h"
|
|
|
|
using namespace clang::ast_matchers;
|
|
|
|
namespace clang::tidy::bugprone {
|
|
namespace {
|
|
|
|
AST_MATCHER_P(FunctionDecl, isEnabled, llvm::StringSet<>,
|
|
FunctionsThatShouldNotThrow) {
|
|
return FunctionsThatShouldNotThrow.contains(Node.getNameAsString());
|
|
}
|
|
|
|
AST_MATCHER(FunctionDecl, isExplicitThrow) {
|
|
return isExplicitThrowExceptionSpec(Node.getExceptionSpecType()) &&
|
|
Node.getExceptionSpecSourceRange().isValid();
|
|
}
|
|
|
|
AST_MATCHER(FunctionDecl, hasAtLeastOneParameter) {
|
|
return Node.getNumParams() > 0;
|
|
}
|
|
|
|
} // namespace
|
|
|
|
ExceptionEscapeCheck::ExceptionEscapeCheck(StringRef Name,
|
|
ClangTidyContext *Context)
|
|
: ClangTidyCheck(Name, Context), RawFunctionsThatShouldNotThrow(Options.get(
|
|
"FunctionsThatShouldNotThrow", "")),
|
|
RawIgnoredExceptions(Options.get("IgnoredExceptions", "")) {
|
|
llvm::SmallVector<StringRef, 8> FunctionsThatShouldNotThrowVec,
|
|
IgnoredExceptionsVec;
|
|
StringRef(RawFunctionsThatShouldNotThrow)
|
|
.split(FunctionsThatShouldNotThrowVec, ",", -1, false);
|
|
FunctionsThatShouldNotThrow.insert_range(FunctionsThatShouldNotThrowVec);
|
|
|
|
llvm::StringSet<> IgnoredExceptions;
|
|
StringRef(RawIgnoredExceptions).split(IgnoredExceptionsVec, ",", -1, false);
|
|
IgnoredExceptions.insert_range(IgnoredExceptionsVec);
|
|
Tracer.ignoreExceptions(std::move(IgnoredExceptions));
|
|
Tracer.ignoreBadAlloc(true);
|
|
}
|
|
|
|
void ExceptionEscapeCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
|
|
Options.store(Opts, "FunctionsThatShouldNotThrow",
|
|
RawFunctionsThatShouldNotThrow);
|
|
Options.store(Opts, "IgnoredExceptions", RawIgnoredExceptions);
|
|
}
|
|
|
|
void ExceptionEscapeCheck::registerMatchers(MatchFinder *Finder) {
|
|
Finder->addMatcher(
|
|
functionDecl(
|
|
isDefinition(),
|
|
anyOf(isNoThrow(),
|
|
allOf(anyOf(cxxDestructorDecl(),
|
|
cxxConstructorDecl(isMoveConstructor()),
|
|
cxxMethodDecl(isMoveAssignmentOperator()), isMain(),
|
|
allOf(hasAnyName("swap", "iter_swap", "iter_move"),
|
|
hasAtLeastOneParameter())),
|
|
unless(isExplicitThrow())),
|
|
isEnabled(FunctionsThatShouldNotThrow)))
|
|
.bind("thrower"),
|
|
this);
|
|
}
|
|
|
|
void ExceptionEscapeCheck::check(const MatchFinder::MatchResult &Result) {
|
|
const auto *MatchedDecl = Result.Nodes.getNodeAs<FunctionDecl>("thrower");
|
|
|
|
if (!MatchedDecl)
|
|
return;
|
|
|
|
const utils::ExceptionAnalyzer::ExceptionInfo Info =
|
|
Tracer.analyze(MatchedDecl);
|
|
|
|
if (Info.getBehaviour() != utils::ExceptionAnalyzer::State::Throwing)
|
|
return;
|
|
|
|
diag(MatchedDecl->getLocation(), "an exception may be thrown in function "
|
|
"%0 which should not throw exceptions")
|
|
<< MatchedDecl;
|
|
|
|
const auto &[ThrowType, ThrowInfo] = *Info.getExceptions().begin();
|
|
|
|
if (ThrowInfo.Loc.isInvalid())
|
|
return;
|
|
|
|
const utils::ExceptionAnalyzer::CallStack &Stack = ThrowInfo.Stack;
|
|
diag(ThrowInfo.Loc,
|
|
"frame #0: unhandled exception of type %0 may be thrown in function %1 "
|
|
"here",
|
|
DiagnosticIDs::Note)
|
|
<< QualType(ThrowType, 0U) << Stack.back().first;
|
|
|
|
size_t FrameNo = 1;
|
|
for (auto CurrIt = ++Stack.rbegin(), PrevIt = Stack.rbegin();
|
|
CurrIt != Stack.rend(); ++CurrIt, ++PrevIt) {
|
|
const FunctionDecl *CurrFunction = CurrIt->first;
|
|
const FunctionDecl *PrevFunction = PrevIt->first;
|
|
const SourceLocation PrevLocation = PrevIt->second;
|
|
if (PrevLocation.isValid()) {
|
|
diag(PrevLocation, "frame #%0: function %1 calls function %2 here",
|
|
DiagnosticIDs::Note)
|
|
<< FrameNo << CurrFunction << PrevFunction;
|
|
} else {
|
|
diag(CurrFunction->getLocation(),
|
|
"frame #%0: function %1 calls function %2", DiagnosticIDs::Note)
|
|
<< FrameNo << CurrFunction << PrevFunction;
|
|
}
|
|
++FrameNo;
|
|
}
|
|
}
|
|
|
|
} // namespace clang::tidy::bugprone
|