clang-tools  14.0.0git
SignalHandlerCheck.h
Go to the documentation of this file.
1 //===--- SignalHandlerCheck.h - clang-tidy ----------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SIGNALHANDLERCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SIGNALHANDLERCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "llvm/ADT/StringSet.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace bugprone {
18 
19 /// Checker for signal handler functions.
20 ///
21 /// For the user-facing documentation see:
22 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone-signal-handler-check.html
24 public:
26 
27  SignalHandlerCheck(StringRef Name, ClangTidyContext *Context);
28  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
29  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override;
30  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
31  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
32 
33 private:
34  void reportBug(const FunctionDecl *CalledFunction, const Expr *CallOrRef,
35  const CallExpr *SignalCall, const FunctionDecl *HandlerDecl);
36  bool isSystemCallAllowed(const FunctionDecl *FD) const;
37 
38  AsyncSafeFunctionSetType AsyncSafeFunctionSet;
39  llvm::StringSet<> &ConformingFunctions;
40 
41  static llvm::StringSet<> MinimalConformingFunctions;
42  static llvm::StringSet<> POSIXConformingFunctions;
43 };
44 
45 } // namespace bugprone
46 } // namespace tidy
47 } // namespace clang
48 
49 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SIGNALHANDLERCHECK_H
clang::tidy::bugprone::SignalHandlerCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: SignalHandlerCheck.cpp:115
clang::tidy::bugprone::SignalHandlerCheck
Checker for signal handler functions.
Definition: SignalHandlerCheck.h:23
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::SignalHandlerCheck::AsyncSafeFunctionSetType::POSIX
@ POSIX
clang::tidy::bugprone::SignalHandlerCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: SignalHandlerCheck.cpp:92
clang::tidy::bugprone::SignalHandlerCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: SignalHandlerCheck.cpp:88
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::bugprone::SignalHandlerCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: SignalHandlerCheck.cpp:101
clang::tidy::bugprone::SignalHandlerCheck::AsyncSafeFunctionSetType
AsyncSafeFunctionSetType
Definition: SignalHandlerCheck.h:25
clang::tidy::bugprone::SignalHandlerCheck::AsyncSafeFunctionSetType::Minimal
@ Minimal
clang::tidy::bugprone::SignalHandlerCheck::SignalHandlerCheck
SignalHandlerCheck(StringRef Name, ClangTidyContext *Context)
Definition: SignalHandlerCheck.cpp:78