115 lines
4.4 KiB
C++
115 lines
4.4 KiB
C++
//===--- CoroutineHostileRAII.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 "CoroutineHostileRAIICheck.h"
|
|
#include "../utils/OptionsUtils.h"
|
|
#include "clang/AST/Attr.h"
|
|
#include "clang/AST/Decl.h"
|
|
#include "clang/AST/ExprCXX.h"
|
|
#include "clang/AST/Stmt.h"
|
|
#include "clang/AST/Type.h"
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
#include "clang/ASTMatchers/ASTMatchers.h"
|
|
#include "clang/ASTMatchers/ASTMatchersInternal.h"
|
|
#include "clang/Basic/AttrKinds.h"
|
|
#include "clang/Basic/DiagnosticIDs.h"
|
|
|
|
using namespace clang::ast_matchers;
|
|
namespace clang::tidy::misc {
|
|
namespace {
|
|
using clang::ast_matchers::internal::BoundNodesTreeBuilder;
|
|
|
|
AST_MATCHER_P(Stmt, forEachPrevStmt, ast_matchers::internal::Matcher<Stmt>,
|
|
InnerMatcher) {
|
|
DynTypedNode P;
|
|
bool IsHostile = false;
|
|
for (const Stmt *Child = &Node; Child; Child = P.get<Stmt>()) {
|
|
auto Parents = Finder->getASTContext().getParents(*Child);
|
|
if (Parents.empty())
|
|
break;
|
|
P = *Parents.begin();
|
|
auto *PCS = P.get<CompoundStmt>();
|
|
if (!PCS)
|
|
continue;
|
|
for (const auto &Sibling : PCS->children()) {
|
|
// Child contains suspension. Siblings after Child do not persist across
|
|
// this suspension.
|
|
if (Sibling == Child)
|
|
break;
|
|
// In case of a match, add the bindings as a separate match. Also don't
|
|
// clear the bindings if a match is not found (unlike Matcher::matches).
|
|
BoundNodesTreeBuilder SiblingBuilder;
|
|
if (InnerMatcher.matches(*Sibling, Finder, &SiblingBuilder)) {
|
|
Builder->addMatch(SiblingBuilder);
|
|
IsHostile = true;
|
|
}
|
|
}
|
|
}
|
|
return IsHostile;
|
|
}
|
|
|
|
// Matches the expression awaited by the `co_await`.
|
|
AST_MATCHER_P(CoawaitExpr, awaitable, ast_matchers::internal::Matcher<Expr>,
|
|
InnerMatcher) {
|
|
if (Expr *E = Node.getOperand())
|
|
return InnerMatcher.matches(*E, Finder, Builder);
|
|
return false;
|
|
}
|
|
|
|
auto typeWithNameIn(const std::vector<StringRef> &Names) {
|
|
return hasType(
|
|
hasCanonicalType(hasDeclaration(namedDecl(hasAnyName(Names)))));
|
|
}
|
|
} // namespace
|
|
|
|
CoroutineHostileRAIICheck::CoroutineHostileRAIICheck(StringRef Name,
|
|
ClangTidyContext *Context)
|
|
: ClangTidyCheck(Name, Context),
|
|
RAIITypesList(utils::options::parseStringList(
|
|
Options.get("RAIITypesList", "std::lock_guard;std::scoped_lock"))),
|
|
AllowedAwaitablesList(utils::options::parseStringList(
|
|
Options.get("AllowedAwaitablesList", ""))) {}
|
|
|
|
void CoroutineHostileRAIICheck::registerMatchers(MatchFinder *Finder) {
|
|
// A suspension happens with co_await or co_yield.
|
|
auto ScopedLockable = varDecl(hasType(hasCanonicalType(hasDeclaration(
|
|
hasAttr(attr::Kind::ScopedLockable)))))
|
|
.bind("scoped-lockable");
|
|
auto OtherRAII = varDecl(typeWithNameIn(RAIITypesList)).bind("raii");
|
|
auto AllowedSuspend = awaitable(typeWithNameIn(AllowedAwaitablesList));
|
|
Finder->addMatcher(
|
|
expr(anyOf(coawaitExpr(unless(AllowedSuspend)), coyieldExpr()),
|
|
forEachPrevStmt(
|
|
declStmt(forEach(varDecl(anyOf(ScopedLockable, OtherRAII))))))
|
|
.bind("suspension"),
|
|
this);
|
|
}
|
|
|
|
void CoroutineHostileRAIICheck::check(const MatchFinder::MatchResult &Result) {
|
|
if (const auto *VD = Result.Nodes.getNodeAs<VarDecl>("scoped-lockable"))
|
|
diag(VD->getLocation(),
|
|
"%0 holds a lock across a suspension point of coroutine and could be "
|
|
"unlocked by a different thread")
|
|
<< VD;
|
|
if (const auto *VD = Result.Nodes.getNodeAs<VarDecl>("raii"))
|
|
diag(VD->getLocation(),
|
|
"%0 persists across a suspension point of coroutine")
|
|
<< VD;
|
|
if (const auto *Suspension = Result.Nodes.getNodeAs<Expr>("suspension"))
|
|
diag(Suspension->getBeginLoc(), "suspension point is here",
|
|
DiagnosticIDs::Note);
|
|
}
|
|
|
|
void CoroutineHostileRAIICheck::storeOptions(
|
|
ClangTidyOptions::OptionMap &Opts) {
|
|
Options.store(Opts, "RAIITypesList",
|
|
utils::options::serializeStringList(RAIITypesList));
|
|
Options.store(Opts, "SafeAwaitableList",
|
|
utils::options::serializeStringList(AllowedAwaitablesList));
|
|
}
|
|
} // namespace clang::tidy::misc
|