yawanng created this revision.
yawanng added a project: clang-tools-extra.
Herald added subscribers: xazax.hun, JDevlieghere, mgorny, srhines.
socket() is better to include SOCK_CLOEXEC in its type argument to avoid the
file descriptor leakage.
Repository:
rL LLVM
https://reviews.llvm.org/D34913
Files:
clang-tidy/android/AndroidTidyModule.cpp
clang-tidy/android/CMakeLists.txt
clang-tidy/android/CloexecOpenCheck.cpp
clang-tidy/android/CloexecSocketCheck.cpp
clang-tidy/android/CloexecSocketCheck.h
clang-tidy/utils/CMakeLists.txt
clang-tidy/utils/CloexecFlagChecker.cpp
clang-tidy/utils/CloexecFlagChecker.h
docs/ReleaseNotes.rst
docs/clang-tidy/checks/android-cloexec-socket.rst
docs/clang-tidy/checks/list.rst
test/clang-tidy/android-cloexec-socket.cpp
Index: test/clang-tidy/android-cloexec-socket.cpp
===================================================================
--- /dev/null
+++ test/clang-tidy/android-cloexec-socket.cpp
@@ -0,0 +1,92 @@
+// RUN: %check_clang_tidy %s android-cloexec-socket %t
+
+#define SOCK_STREAM 1
+#define SOCK_DGRAM 2
+#define __O_CLOEXEC 3
+#define SOCK_CLOEXEC __O_CLOEXEC
+#define TEMP_FAILURE_RETRY(exp) \
+ ({ \
+ int _rc; \
+ do { \
+ _rc = (exp); \
+ } while (_rc == -1); \
+ })
+
+extern "C" int socket(int domain, int type, int protocol);
+
+void a() {
+ socket(0, SOCK_STREAM, 0);
+ // CHECK-MESSAGES: :[[@LINE-1]]:24: warning: 'socket' should use SOCK_CLOEXEC where possible [android-cloexec-socket]
+ // CHECK-FIXES: SOCK_STREAM | SOCK_CLOEXEC
+ TEMP_FAILURE_RETRY(socket(0, SOCK_STREAM, 0));
+ // CHECK-MESSAGES: :[[@LINE-1]]:43: warning: 'socket'
+ // CHECK-FIXES: SOCK_STREAM | SOCK_CLOEXEC
+ socket(0, SOCK_STREAM | SOCK_DGRAM, 0);
+ // CHECK-MESSAGES: :[[@LINE-1]]:37: warning: 'socket'
+ // CHECK-FIXES: SOCK_STREAM | SOCK_DGRAM | SOCK_CLOEXEC
+ TEMP_FAILURE_RETRY(socket(0, SOCK_STREAM | SOCK_DGRAM, 0));
+ // CHECK-MESSAGES: :[[@LINE-1]]:56: warning: 'socket'
+ // CHECK-FIXES: SOCK_STREAM | SOCK_DGRAM | SOCK_CLOEXEC
+}
+
+void f() {
+ socket(0, 3, 0);
+ // CHECK-MESSAGES: :[[@LINE-1]]:14: warning: 'socket'
+ // CHECK-FIXES: 3 | SOCK_CLOEXEC
+ TEMP_FAILURE_RETRY(socket(0, 3, 0));
+ // CHECK-MESSAGES: :[[@LINE-1]]:33: warning: 'socket'
+ // CHECK-FIXES: 3 | SOCK_CLOEXEC
+
+ int flag = 3;
+ socket(0, flag, 0);
+ // CHECK-MESSAGES-NOT: warning:
+ TEMP_FAILURE_RETRY(socket(0, flag, 0));
+ // CHECK-MESSAGES-NOT: warning:
+}
+
+namespace i {
+int socket(int domain, int type, int protocol);
+
+void d() {
+ socket(0, SOCK_STREAM, 0);
+ // CHECK-MESSAGES-NOT: warning:
+ TEMP_FAILURE_RETRY(socket(0, SOCK_STREAM, 0));
+ // CHECK-MESSAGES-NOT: warning:
+ socket(0, SOCK_STREAM | SOCK_DGRAM, 0);
+ // CHECK-MESSAGES-NOT: warning:
+ TEMP_FAILURE_RETRY(socket(0, SOCK_STREAM | SOCK_DGRAM, 0));
+ // CHECK-MESSAGES-NOT: warning:
+}
+
+} // namespace i
+
+void e() {
+ socket(0, SOCK_CLOEXEC, 0);
+ // CHECK-MESSAGES-NOT: warning:
+ TEMP_FAILURE_RETRY(socket(0, SOCK_CLOEXEC, 0));
+ // CHECK-MESSAGES-NOT: warning:
+ socket(0, SOCK_STREAM | SOCK_CLOEXEC, 0);
+ // CHECK-MESSAGES-NOT: warning:
+ TEMP_FAILURE_RETRY(socket(0, SOCK_STREAM | SOCK_CLOEXEC, 0));
+ // CHECK-MESSAGES-NOT: warning:
+ socket(0, SOCK_STREAM | SOCK_CLOEXEC | SOCK_DGRAM, 0);
+ // CHECK-MESSAGES-NOT: warning:
+ TEMP_FAILURE_RETRY(socket(0, SOCK_STREAM | SOCK_CLOEXEC | SOCK_DGRAM, 0));
+ // CHECK-MESSAGES-NOT: warning:
+}
+
+class G {
+public:
+ int socket(int domain, int type, int protocol);
+ void d() {
+ socket(0, SOCK_STREAM, 0);
+ // CHECK-MESSAGES-NOT: warning:
+ TEMP_FAILURE_RETRY(socket(0, SOCK_STREAM, 0));
+ // CHECK-MESSAGES-NOT: warning:
+ socket(0, SOCK_STREAM | SOCK_DGRAM, 0);
+ // CHECK-MESSAGES-NOT: warning:
+ TEMP_FAILURE_RETRY(socket(0, SOCK_STREAM | SOCK_DGRAM, 0));
+ // CHECK-MESSAGES-NOT: warning:
+ }
+};
+
Index: docs/clang-tidy/checks/list.rst
===================================================================
--- docs/clang-tidy/checks/list.rst
+++ docs/clang-tidy/checks/list.rst
@@ -7,6 +7,7 @@
android-cloexec-creat
android-cloexec-fopen
android-cloexec-open
+ android-cloexec-socket
boost-use-to-string
cert-dcl03-c (redirects to misc-static-assert) <cert-dcl03-c>
cert-dcl21-cpp
Index: docs/clang-tidy/checks/android-cloexec-socket.rst
===================================================================
--- /dev/null
+++ docs/clang-tidy/checks/android-cloexec-socket.rst
@@ -0,0 +1,16 @@
+.. title:: clang-tidy - android-cloexec-socket
+
+android-cloexec-socket
+======================
+``socket()`` should include ``SOCK_CLOEXEC`` in its type argument to avoid the
+file descriptor leakage.
+
+Examples:
+
+.. code-block:: c++
+
+ socket(domain, type, SOCK_STREAM);
+
+ // becomes
+
+ socket(domain, type, SOCK_STREAM | SOCK_CLOEXEC);
Index: docs/ReleaseNotes.rst
===================================================================
--- docs/ReleaseNotes.rst
+++ docs/ReleaseNotes.rst
@@ -73,6 +73,11 @@
Checks if the required mode ``e`` exists in the mode argument of ``fopen()``.
+- New `android-cloexec-socket
+ <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-socket.html>`_ check
+
+ Checks if the required file flag ``SOCK_CLOEXEC`` exists in ``socket()``.
+
- New `cert-dcl21-cpp
<http://clang.llvm.org/extra/clang-tidy/checks/cert-dcl21-cpp.html>`_ check
Index: clang-tidy/utils/CloexecFlagChecker.h
===================================================================
--- /dev/null
+++ clang-tidy/utils/CloexecFlagChecker.h
@@ -0,0 +1,28 @@
+//===------------ CloexecFlagChecker.h - clang-tidy -----------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLOEXECFLAGCHECKER_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLOEXECFLAGCHECKER_H
+
+#include "../ClangTidy.h"
+
+namespace clang {
+namespace tidy {
+namespace utils {
+
+/// Method used by many close-on-exec checks to check the existence of a
+/// specific macro flag in a given argument.
+bool hasCloseOnExecFlag(const Expr *Flags, const SourceManager &SM,
+ const LangOptions &LangOpts,
+ const char *CloseOnExecFlag);
+
+} // namespace utils
+} // namespace tidy
+} // namespace clang
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLOEXECFLAGCHECKER_H
Index: clang-tidy/utils/CloexecFlagChecker.cpp
===================================================================
--- /dev/null
+++ clang-tidy/utils/CloexecFlagChecker.cpp
@@ -0,0 +1,45 @@
+//===---------- CloexecFlagChecker.cpp - clang-tidy -----------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "CloexecFlagChecker.h"
+
+namespace clang {
+namespace tidy {
+namespace utils {
+
+bool hasCloseOnExecFlag(const Expr *Flags, const SourceManager &SM,
+ const LangOptions &LangOpts,
+ const char *CloseOnExecFlag) {
+ // If the Flag is an integer constant, check it.
+ if (isa<IntegerLiteral>(Flags)) {
+ if (!SM.isMacroBodyExpansion(Flags->getLocStart()) &&
+ !SM.isMacroArgExpansion(Flags->getLocStart()))
+ return false;
+
+ // Get the Marco name.
+ auto MacroName = Lexer::getSourceText(
+ CharSourceRange::getTokenRange(Flags->getSourceRange()), SM, LangOpts);
+
+ return MacroName == CloseOnExecFlag;
+ }
+ // If it's a binary OR operation.
+ if (const auto *BO = dyn_cast<BinaryOperator>(Flags))
+ if (BO->getOpcode() == clang::BinaryOperatorKind::BO_Or)
+ return hasCloseOnExecFlag(BO->getLHS()->IgnoreParenCasts(), SM, LangOpts,
+ CloseOnExecFlag) ||
+ hasCloseOnExecFlag(BO->getRHS()->IgnoreParenCasts(), SM, LangOpts,
+ CloseOnExecFlag);
+
+ // Otherwise, assume it has the flag.
+ return true;
+}
+
+} // namespace utils
+} // namespace tidy
+} // namespace clang
Index: clang-tidy/utils/CMakeLists.txt
===================================================================
--- clang-tidy/utils/CMakeLists.txt
+++ clang-tidy/utils/CMakeLists.txt
@@ -2,6 +2,7 @@
add_clang_library(clangTidyUtils
ASTUtils.cpp
+ CloexecFlagChecker.cpp
DeclRefExprUtils.cpp
ExprSequence.cpp
FixItHintUtils.cpp
Index: clang-tidy/android/CloexecSocketCheck.h
===================================================================
--- /dev/null
+++ clang-tidy/android/CloexecSocketCheck.h
@@ -0,0 +1,35 @@
+//===--- CloexecSocketCheck.h - clang-tidy-----------------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_SOCKET_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_SOCKET_H
+
+#include "../ClangTidy.h"
+
+namespace clang {
+namespace tidy {
+namespace android {
+
+/// Finds code that uses socket() without using the SOCK_CLOEXEC flag.
+///
+/// For the user-facing documentation see:
+/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-socket.html
+class CloexecSocketCheck : public ClangTidyCheck {
+public:
+ CloexecSocketCheck(StringRef Name, ClangTidyContext *Context)
+ : ClangTidyCheck(Name, Context) {}
+ void registerMatchers(ast_matchers::MatchFinder *Finder) override;
+ void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+};
+
+} // namespace android
+} // namespace tidy
+} // namespace clang
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_SOCKET_H
Index: clang-tidy/android/CloexecSocketCheck.cpp
===================================================================
--- /dev/null
+++ clang-tidy/android/CloexecSocketCheck.cpp
@@ -0,0 +1,59 @@
+//===--- CloexecSocketCheck.cpp - clang-tidy-------------------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "CloexecSocketCheck.h"
+#include "../utils/CloexecFlagChecker.h"
+#include "clang/AST/ASTContext.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang {
+namespace tidy {
+namespace android {
+
+namespace {
+static constexpr const char *SOCK_CLOEXEC = "SOCK_CLOEXEC";
+} // namespace
+
+void CloexecSocketCheck::registerMatchers(MatchFinder *Finder) {
+ Finder->addMatcher(
+ callExpr(callee(functionDecl(isExternC(), returns(isInteger()),
+ hasName("socket"),
+ hasParameter(0, hasType(isInteger())),
+ hasParameter(1, hasType(isInteger())),
+ hasParameter(2, hasType(isInteger())))
+ .bind("funcDecl")))
+ .bind("socketFn"),
+ this);
+}
+
+void CloexecSocketCheck::check(const MatchFinder::MatchResult &Result) {
+ const auto *MatchedCall = Result.Nodes.getNodeAs<CallExpr>("socketFn");
+ const auto *FD = Result.Nodes.getNodeAs<FunctionDecl>("funcDecl");
+ const Expr *FlagArg = MatchedCall->getArg(1);
+ SourceManager &SM = *Result.SourceManager;
+
+ if (utils::hasCloseOnExecFlag(FlagArg->IgnoreParenCasts(), SM,
+ Result.Context->getLangOpts(), SOCK_CLOEXEC))
+ return;
+
+ SourceLocation EndLoc =
+ Lexer::getLocForEndOfToken(SM.getFileLoc(FlagArg->getLocEnd()), 0, SM,
+ Result.Context->getLangOpts());
+
+ diag(EndLoc, "%0 should use %1 where possible")
+ << FD << SOCK_CLOEXEC
+ << FixItHint::CreateInsertion(EndLoc,
+ (Twine(" | ") + SOCK_CLOEXEC).str());
+}
+
+} // namespace android
+} // namespace tidy
+} // namespace clang
Index: clang-tidy/android/CloexecOpenCheck.cpp
===================================================================
--- clang-tidy/android/CloexecOpenCheck.cpp
+++ clang-tidy/android/CloexecOpenCheck.cpp
@@ -8,6 +8,7 @@
//===----------------------------------------------------------------------===//
#include "CloexecOpenCheck.h"
+#include "../utils/CloexecFlagChecker.h"
#include "clang/AST/ASTContext.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Lex/Lexer.h"
@@ -20,31 +21,6 @@
namespace {
static constexpr const char *O_CLOEXEC = "O_CLOEXEC";
-
-bool hasCloseOnExecFlag(const Expr *Flags, const SourceManager &SM,
- const LangOptions &LangOpts) {
- // If the Flag is an integer constant, check it.
- if (isa<IntegerLiteral>(Flags)) {
- if (!SM.isMacroBodyExpansion(Flags->getLocStart()) &&
- !SM.isMacroArgExpansion(Flags->getLocStart()))
- return false;
-
- // Get the Marco name.
- auto MacroName = Lexer::getSourceText(
- CharSourceRange::getTokenRange(Flags->getSourceRange()), SM, LangOpts);
-
- return MacroName == O_CLOEXEC;
- }
- // If it's a binary OR operation.
- if (const auto *BO = dyn_cast<BinaryOperator>(Flags))
- if (BO->getOpcode() == clang::BinaryOperatorKind::BO_Or)
- return hasCloseOnExecFlag(BO->getLHS()->IgnoreParenCasts(), SM,
- LangOpts) ||
- hasCloseOnExecFlag(BO->getRHS()->IgnoreParenCasts(), SM, LangOpts);
-
- // Otherwise, assume it has the flag.
- return true;
-}
} // namespace
void CloexecOpenCheck::registerMatchers(MatchFinder *Finder) {
@@ -82,8 +58,8 @@
// Check the required flag.
SourceManager &SM = *Result.SourceManager;
- if (hasCloseOnExecFlag(FlagArg->IgnoreParenCasts(), SM,
- Result.Context->getLangOpts()))
+ if (utils::hasCloseOnExecFlag(FlagArg->IgnoreParenCasts(), SM,
+ Result.Context->getLangOpts(), O_CLOEXEC))
return;
SourceLocation EndLoc =
Index: clang-tidy/android/CMakeLists.txt
===================================================================
--- clang-tidy/android/CMakeLists.txt
+++ clang-tidy/android/CMakeLists.txt
@@ -5,6 +5,7 @@
CloexecCreatCheck.cpp
CloexecFopenCheck.cpp
CloexecOpenCheck.cpp
+ CloexecSocketCheck.cpp
LINK_LIBS
clangAST
Index: clang-tidy/android/AndroidTidyModule.cpp
===================================================================
--- clang-tidy/android/AndroidTidyModule.cpp
+++ clang-tidy/android/AndroidTidyModule.cpp
@@ -13,6 +13,7 @@
#include "CloexecCreatCheck.h"
#include "CloexecFopenCheck.h"
#include "CloexecOpenCheck.h"
+#include "CloexecSocketCheck.h"
using namespace clang::ast_matchers;
@@ -27,6 +28,7 @@
CheckFactories.registerCheck<CloexecCreatCheck>("android-cloexec-creat");
CheckFactories.registerCheck<CloexecFopenCheck>("android-cloexec-fopen");
CheckFactories.registerCheck<CloexecOpenCheck>("android-cloexec-open");
+ CheckFactories.registerCheck<CloexecSocketCheck>("android-cloexec-socket");
}
};
_______________________________________________
cfe-commits mailing list
[email protected]
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
