balazske updated this revision to Diff 324013.
balazske added a comment.
Adding missed alias to CERT module.
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D96719/new/
https://reviews.llvm.org/D96719
Files:
clang-tools-extra/clang-tidy/bugprone/BugproneTidyModule.cpp
clang-tools-extra/clang-tidy/bugprone/CMakeLists.txt
clang-tools-extra/clang-tidy/bugprone/ThreadCanceltypeAsynchronousCheck.cpp
clang-tools-extra/clang-tidy/bugprone/ThreadCanceltypeAsynchronousCheck.h
clang-tools-extra/clang-tidy/cert/CERTTidyModule.cpp
clang-tools-extra/docs/ReleaseNotes.rst
clang-tools-extra/docs/clang-tidy/checks/bugprone-thread-canceltype-asynchronous.rst
clang-tools-extra/docs/clang-tidy/checks/cert-pos47-c.rst
clang-tools-extra/docs/clang-tidy/checks/list.rst
clang-tools-extra/test/clang-tidy/checkers/bugprone-thread-canceltype-asynchronous.cpp
Index: clang-tools-extra/test/clang-tidy/checkers/bugprone-thread-canceltype-asynchronous.cpp
===================================================================
--- /dev/null
+++ clang-tools-extra/test/clang-tidy/checkers/bugprone-thread-canceltype-asynchronous.cpp
@@ -0,0 +1,32 @@
+// RUN: %check_clang_tidy %s bugprone-thread-canceltype-asynchronous %t
+
+#define PTHREAD_CANCEL_DEFERRED 0
+#define PTHREAD_CANCEL_ASYNCHRONOUS 1
+
+int pthread_setcanceltype(int type, int *oldtype);
+
+int main() {
+ int result, oldtype;
+
+ if ((result = pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldtype)) != 0) {
+ // CHECK-MESSAGES: :[[@LINE-1]]:17: warning: asynchronous cancelability type should not be used [bugprone-thread-canceltype-asynchronous]
+ return 1;
+ }
+
+ if ((result = pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, &oldtype)) != 0) {
+ return 1;
+ }
+
+ return 0;
+}
+
+int f() {
+ int result, oldtype;
+
+ if ((result = pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldtype)) != 0) {
+ // CHECK-MESSAGES: :[[@LINE-1]]:17: warning: asynchronous cancelability type should not be used [bugprone-thread-canceltype-asynchronous]
+ return 1;
+ }
+
+ return 0;
+}
Index: clang-tools-extra/docs/clang-tidy/checks/list.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -95,6 +95,7 @@
`bugprone-suspicious-string-compare <bugprone-suspicious-string-compare.html>`_, "Yes"
`bugprone-swapped-arguments <bugprone-swapped-arguments.html>`_, "Yes"
`bugprone-terminating-continue <bugprone-terminating-continue.html>`_, "Yes"
+ `bugprone-thread-canceltype-asynchronous <bugprone-thread-canceltype-asynchronous.html>`_, "No"
`bugprone-throw-keyword-missing <bugprone-throw-keyword-missing.html>`_,
`bugprone-too-small-loop-variable <bugprone-too-small-loop-variable.html>`_,
`bugprone-undefined-memory-manipulation <bugprone-undefined-memory-manipulation.html>`_,
@@ -334,6 +335,7 @@
`cert-oop11-cpp <cert-oop11-cpp.html>`_, `performance-move-constructor-init <performance-move-constructor-init.html>`_, "Yes"
`cert-oop54-cpp <cert-oop54-cpp.html>`_, `bugprone-unhandled-self-assignment <bugprone-unhandled-self-assignment.html>`_,
`cert-pos44-c <cert-pos44-c.html>`_, `bugprone-bad-signal-to-kill-thread <bugprone-bad-signal-to-kill-thread.html>`_,
+ `cert-pos47-c <cert-pos47-c.html>`_, `bugprone-thread-canceltype-asynchronous <bugprone-thread-canceltype-asynchronous.html>`_,
`cert-str34-c <cert-str34-c.html>`_, `bugprone-signed-char-misuse <bugprone-signed-char-misuse.html>`_,
`clang-analyzer-core.CallAndMessage <clang-analyzer-core.CallAndMessage.html>`_, `Clang Static Analyzer <https://clang.llvm.org/docs/analyzer/checkers.html>`_,
`clang-analyzer-core.DivideZero <clang-analyzer-core.DivideZero.html>`_, `Clang Static Analyzer <https://clang.llvm.org/docs/analyzer/checkers.html>`_,
Index: clang-tools-extra/docs/clang-tidy/checks/cert-pos47-c.rst
===================================================================
--- /dev/null
+++ clang-tools-extra/docs/clang-tidy/checks/cert-pos47-c.rst
@@ -0,0 +1,9 @@
+.. title:: clang-tidy - cert-pos47-c
+.. meta::
+ :http-equiv=refresh: 5;URL=bugprone-thread-canceltype-asynchronous.html
+
+cert-pos47-c
+============
+
+The cert-pos47-c check is an alias, please see
+`bugprone-thread-canceltype-asynchronous <bugprone-thread-canceltype-asynchronous.html>`_ for more information.
Index: clang-tools-extra/docs/clang-tidy/checks/bugprone-thread-canceltype-asynchronous.rst
===================================================================
--- /dev/null
+++ clang-tools-extra/docs/clang-tidy/checks/bugprone-thread-canceltype-asynchronous.rst
@@ -0,0 +1,19 @@
+.. title:: clang-tidy - bugprone-thread-canceltype-asynchronous
+
+bugprone-thread-canceltype-asynchronous
+=======================================
+
+Finds ``pthread_setcanceltype`` function calls where a thread's cancellation
+type is set to asynchronous. Asynchronous cancellation type
+(``PTHREAD_CANCEL_ASYNCHRONOUS``) is generally unsafe, use type
+``PTHREAD_CANCEL_DEFERRED`` instead which is the default. Even with deferred
+cancellation, a cancellation point in an asynchronous signal handler may still
+be acted upon and the effect is as if it was an asynchronous cancellation.
+
+.. code-block: c++
+
+ pthread_setcanceltype(PTHREAD_CANCEL_ASYNCHRONOUS, &oldtype);
+
+This check corresponds to the CERT C Coding Standard rule
+`POS47-C. Do not use threads that can be canceled asynchronously
+<https://wiki.sei.cmu.edu/confluence/display/c/POS47-C.+Do+not+use+threads+that+can+be+canceled+asynchronously>`_.
Index: clang-tools-extra/docs/ReleaseNotes.rst
===================================================================
--- clang-tools-extra/docs/ReleaseNotes.rst
+++ clang-tools-extra/docs/ReleaseNotes.rst
@@ -67,7 +67,22 @@
Improvements to clang-tidy
--------------------------
-The improvements are...
+New checks
+^^^^^^^^^^
+
+- New :doc:`bugprone-thread-canceltype-asynchronous
+ <clang-tidy/checks/bugprone-thread-canceltype-asynchronous>` check.
+
+ Finds ``pthread_setcanceltype`` function calls where a thread's cancellation
+ type is set to asynchronous.
+
+New check aliases
+^^^^^^^^^^^^^^^^^
+
+- New alias :doc:`cert-pos47-c
+ <clang-tidy/checks/cert-pos47-c>` to
+ :doc:`bugprone-thread-canceltype-asynchronous
+ <clang-tidy/checks/bugprone-thread-canceltype-asynchronous>` was added.
Improvements to include-fixer
-----------------------------
Index: clang-tools-extra/clang-tidy/cert/CERTTidyModule.cpp
===================================================================
--- clang-tools-extra/clang-tidy/cert/CERTTidyModule.cpp
+++ clang-tools-extra/clang-tidy/cert/CERTTidyModule.cpp
@@ -14,6 +14,7 @@
#include "../bugprone/SignalHandlerCheck.h"
#include "../bugprone/SignedCharMisuseCheck.h"
#include "../bugprone/SpuriouslyWakeUpFunctionsCheck.h"
+#include "../bugprone/ThreadCanceltypeAsynchronousCheck.h"
#include "../bugprone/UnhandledSelfAssignmentCheck.h"
#include "../google/UnnamedNamespaceInHeaderCheck.h"
#include "../misc/NewDeleteOverloadsCheck.h"
@@ -110,6 +111,8 @@
// POS
CheckFactories.registerCheck<bugprone::BadSignalToKillThreadCheck>(
"cert-pos44-c");
+ CheckFactories.registerCheck<bugprone::ThreadCanceltypeAsynchronousCheck>(
+ "cert-pos47-c");
// SIG
CheckFactories.registerCheck<bugprone::SignalHandlerCheck>("cert-sig30-c");
// STR
Index: clang-tools-extra/clang-tidy/bugprone/ThreadCanceltypeAsynchronousCheck.h
===================================================================
--- /dev/null
+++ clang-tools-extra/clang-tidy/bugprone/ThreadCanceltypeAsynchronousCheck.h
@@ -0,0 +1,37 @@
+//===--- ThreadCanceltypeAsynchronousCheck.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_BUGPRONE_THREADCANCELTYPEASYNCHRONOUSCHECK_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_THREADCANCELTYPEASYNCHRONOUSCHECK_H
+
+#include "../ClangTidyCheck.h"
+
+namespace clang {
+namespace tidy {
+namespace bugprone {
+
+/// Finds ``pthread_setcanceltype`` function calls where a thread's
+/// cancellation type is set to asynchronous.
+/// For the user-facing documentation see:
+/// http://clang.llvm.org/extra/clang-tidy/checks/bugprone-thread-canceltype-asynchronous.html
+class ThreadCanceltypeAsynchronousCheck : public ClangTidyCheck {
+public:
+ ThreadCanceltypeAsynchronousCheck(StringRef Name, ClangTidyContext *Context)
+ : ClangTidyCheck(Name, Context) {}
+ void registerMatchers(ast_matchers::MatchFinder *Finder) override;
+ void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+ void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
+ Preprocessor *ModuleExpanderPP) override;
+ Optional<Optional<unsigned>> PthreadCancelAsynchronousValue;
+};
+
+} // namespace bugprone
+} // namespace tidy
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_THREADCANCELTYPEASYNCHRONOUSCHECK_H
Index: clang-tools-extra/clang-tidy/bugprone/ThreadCanceltypeAsynchronousCheck.cpp
===================================================================
--- /dev/null
+++ clang-tools-extra/clang-tidy/bugprone/ThreadCanceltypeAsynchronousCheck.cpp
@@ -0,0 +1,79 @@
+//===--- ThreadCanceltypeAsynchronousCheck.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 "ThreadCanceltypeAsynchronousCheck.h"
+#include "clang/AST/ASTContext.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "clang/Lex/Preprocessor.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang {
+namespace tidy {
+namespace bugprone {
+
+void ThreadCanceltypeAsynchronousCheck::registerMatchers(MatchFinder *Finder) {
+ Finder->addMatcher(
+ callExpr(allOf(callee(functionDecl(hasName("::pthread_setcanceltype"))),
+ argumentCountIs(2)),
+ hasArgument(0, integerLiteral().bind("integer-literal")))
+ .bind("setcanceltype"),
+ this);
+}
+
+static Preprocessor *PP;
+
+void ThreadCanceltypeAsynchronousCheck::check(
+ const MatchFinder::MatchResult &Result) {
+ if (!PthreadCancelAsynchronousValue) {
+ const auto IsAsynchronous = [](const auto &KeyValue) -> bool {
+ return KeyValue.first->getName() == "PTHREAD_CANCEL_ASYNCHRONOUS" &&
+ KeyValue.first->hasMacroDefinition();
+ };
+ const auto TryExpandAsInteger =
+ [](Preprocessor::macro_iterator It) -> Optional<unsigned> {
+ if (It == PP->macro_end())
+ return llvm::None;
+ const MacroInfo *MI = PP->getMacroInfo(It->first);
+ const Token &T = MI->tokens().back();
+ if (!T.isLiteral() || !T.getLiteralData())
+ return llvm::None;
+ StringRef ValueStr = StringRef(T.getLiteralData(), T.getLength());
+
+ llvm::APInt IntValue;
+ constexpr unsigned AutoSenseRadix = 0;
+ if (ValueStr.getAsInteger(AutoSenseRadix, IntValue))
+ return llvm::None;
+ return IntValue.getZExtValue();
+ };
+
+ const auto AsynchronousMacro = llvm::find_if(PP->macros(), IsAsynchronous);
+
+ PthreadCancelAsynchronousValue = TryExpandAsInteger(AsynchronousMacro);
+ }
+
+ if (!*PthreadCancelAsynchronousValue)
+ return;
+
+ const auto *MatchedExpr = Result.Nodes.getNodeAs<Expr>("setcanceltype");
+ const auto *MatchedIntLiteral =
+ Result.Nodes.getNodeAs<IntegerLiteral>("integer-literal");
+ if (MatchedIntLiteral->getValue() == **PthreadCancelAsynchronousValue) {
+ diag(MatchedExpr->getBeginLoc(),
+ "asynchronous cancelability type should not be used");
+ }
+}
+
+void ThreadCanceltypeAsynchronousCheck::registerPPCallbacks(
+ const SourceManager &SM, Preprocessor *Pp, Preprocessor *ModuleExpanderPP) {
+ PP = Pp;
+}
+
+} // namespace bugprone
+} // namespace tidy
+} // namespace clang
Index: clang-tools-extra/clang-tidy/bugprone/CMakeLists.txt
===================================================================
--- clang-tools-extra/clang-tidy/bugprone/CMakeLists.txt
+++ clang-tools-extra/clang-tidy/bugprone/CMakeLists.txt
@@ -51,6 +51,7 @@
SuspiciousStringCompareCheck.cpp
SwappedArgumentsCheck.cpp
TerminatingContinueCheck.cpp
+ ThreadCanceltypeAsynchronousCheck.cpp
ThrowKeywordMissingCheck.cpp
TooSmallLoopVariableCheck.cpp
UndefinedMemoryManipulationCheck.cpp
Index: clang-tools-extra/clang-tidy/bugprone/BugproneTidyModule.cpp
===================================================================
--- clang-tools-extra/clang-tidy/bugprone/BugproneTidyModule.cpp
+++ clang-tools-extra/clang-tidy/bugprone/BugproneTidyModule.cpp
@@ -56,6 +56,7 @@
#include "SuspiciousStringCompareCheck.h"
#include "SwappedArgumentsCheck.h"
#include "TerminatingContinueCheck.h"
+#include "ThreadCanceltypeAsynchronousCheck.h"
#include "ThrowKeywordMissingCheck.h"
#include "TooSmallLoopVariableCheck.h"
#include "UndefinedMemoryManipulationCheck.h"
@@ -165,6 +166,8 @@
"bugprone-swapped-arguments");
CheckFactories.registerCheck<TerminatingContinueCheck>(
"bugprone-terminating-continue");
+ CheckFactories.registerCheck<ThreadCanceltypeAsynchronousCheck>(
+ "bugprone-thread-canceltype-asynchronous");
CheckFactories.registerCheck<ThrowKeywordMissingCheck>(
"bugprone-throw-keyword-missing");
CheckFactories.registerCheck<TooSmallLoopVariableCheck>(
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
