mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-16 09:06:39 +00:00
c94444390f
Certain `awaitable` types could be safe to `co_await` on even when we have suspension-hostile RAII objects in scope. This PR adds a way for users to mark such safe `awaitable` and silence false positive warnings in `co_await` expressions involving such an `awaitable`. `co_await`-ing an expression of `awaitable` type is considered safe if the type is part of `SafeAwaiatablesList` check option. RAII objects persisting across such a `co_await` expression are considered safe and hence are not flagged.
54 lines
2.0 KiB
C++
54 lines
2.0 KiB
C++
//===--- CoroutineHostileRAIICheck.h - clang-tidy ----------------*- C++-*-===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_COROUTINESHOSTILERAIICHECK_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_COROUTINESHOSTILERAIICHECK_H
|
|
|
|
#include "../ClangTidyCheck.h"
|
|
#include "clang/AST/ASTTypeTraits.h"
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include <vector>
|
|
|
|
namespace clang::tidy::misc {
|
|
|
|
/// Detects when objects of certain hostile RAII types persists across
|
|
/// suspension points in a coroutine. Such hostile types include scoped-lockable
|
|
/// types and types belonging to a configurable denylist.
|
|
///
|
|
/// For the user-facing documentation see:
|
|
/// http://clang.llvm.org/extra/clang-tidy/checks/misc/coroutine-hostile-raii.html
|
|
class CoroutineHostileRAIICheck : public ClangTidyCheck {
|
|
public:
|
|
CoroutineHostileRAIICheck(llvm::StringRef Name, ClangTidyContext *Context);
|
|
|
|
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
|
|
return LangOpts.CPlusPlus20;
|
|
}
|
|
|
|
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
|
|
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
|
|
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
|
|
|
|
std::optional<TraversalKind> getCheckTraversalKind() const override {
|
|
return TK_AsIs;
|
|
}
|
|
|
|
private:
|
|
// List of fully qualified types which should not persist across a suspension
|
|
// point in a coroutine.
|
|
std::vector<StringRef> RAIITypesList;
|
|
// List of fully qualified awaitable types which are considered safe to
|
|
// co_await.
|
|
std::vector<StringRef> AllowedAwaitablesList;
|
|
};
|
|
|
|
} // namespace clang::tidy::misc
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_COROUTINESHOSTILERAIICHECK_H
|