diff options
author | Reid Kleckner <rnk@google.com> | 2017-08-10 21:21:15 +0000 |
---|---|---|
committer | Reid Kleckner <rnk@google.com> | 2017-08-10 21:21:15 +0000 |
commit | 8d4d57035fd50c36d050585d22b50171c49fc6d9 (patch) | |
tree | ccdf78dc0f195d01def6c49d57ed64ff9ac8e563 /clang-tools-extra | |
parent | 6be1ed05c7a7e1e7a812f037b660ec693c5c1ca9 (diff) | |
download | bcm5719-llvm-8d4d57035fd50c36d050585d22b50171c49fc6d9.tar.gz bcm5719-llvm-8d4d57035fd50c36d050585d22b50171c49fc6d9.zip |
Revert "[clang-tidy] Refactor the code and add a close-on-exec check on memfd_create() in Android module."
This reverts commit r310630.
The new code broke on Windows and was untested. On Linux, it was
selecting the "int" overload of operator<<, which definitely does not
print the right thing when fed a "Mode" char.
llvm-svn: 310661
Diffstat (limited to 'clang-tools-extra')
10 files changed, 0 insertions, 360 deletions
diff --git a/clang-tools-extra/clang-tidy/android/AndroidTidyModule.cpp b/clang-tools-extra/clang-tidy/android/AndroidTidyModule.cpp index 729047ee35e..119f3c0db8b 100644 --- a/clang-tools-extra/clang-tidy/android/AndroidTidyModule.cpp +++ b/clang-tools-extra/clang-tidy/android/AndroidTidyModule.cpp @@ -12,7 +12,6 @@ #include "../ClangTidyModuleRegistry.h" #include "CloexecCreatCheck.h" #include "CloexecFopenCheck.h" -#include "CloexecMemfdCreateCheck.h" #include "CloexecOpenCheck.h" #include "CloexecSocketCheck.h" @@ -28,8 +27,6 @@ public: void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override { CheckFactories.registerCheck<CloexecCreatCheck>("android-cloexec-creat"); CheckFactories.registerCheck<CloexecFopenCheck>("android-cloexec-fopen"); - CheckFactories.registerCheck<CloexecMemfdCreateCheck>( - "android-cloexec-memfd-create"); CheckFactories.registerCheck<CloexecOpenCheck>("android-cloexec-open"); CheckFactories.registerCheck<CloexecSocketCheck>("android-cloexec-socket"); } diff --git a/clang-tools-extra/clang-tidy/android/CMakeLists.txt b/clang-tools-extra/clang-tidy/android/CMakeLists.txt index a70ea8de72f..a68c2d2c98a 100644 --- a/clang-tools-extra/clang-tidy/android/CMakeLists.txt +++ b/clang-tools-extra/clang-tidy/android/CMakeLists.txt @@ -2,10 +2,8 @@ set(LLVM_LINK_COMPONENTS support) add_clang_library(clangTidyAndroidModule AndroidTidyModule.cpp - CloexecCheck.cpp CloexecCreatCheck.cpp CloexecFopenCheck.cpp - CloexecMemfdCreateCheck.cpp CloexecOpenCheck.cpp CloexecSocketCheck.cpp diff --git a/clang-tools-extra/clang-tidy/android/CloexecCheck.cpp b/clang-tools-extra/clang-tidy/android/CloexecCheck.cpp deleted file mode 100644 index 490d3680da7..00000000000 --- a/clang-tools-extra/clang-tidy/android/CloexecCheck.cpp +++ /dev/null @@ -1,105 +0,0 @@ -//===--- CloexecCheck.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 "CloexecCheck.h" -#include "../utils/ASTUtils.h" -#include "clang/AST/ASTContext.h" -#include "clang/ASTMatchers/ASTMatchFinder.h" -#include "clang/Lex/Lexer.h" - -using namespace clang::ast_matchers; - -namespace clang { -namespace tidy { -namespace android { - -namespace { - -const char *const FuncDeclBindingStr = "funcDecl"; -const char *const FuncBindingStr = "func"; - -// Helper function to form the correct string mode for Type3. -// Build the replace text. If it's string constant, add <Mode> directly in the -// end of the string. Else, add <Mode>. -std::string buildFixMsgForStringFlag(const Expr *Arg, const SourceManager &SM, - const LangOptions &LangOpts, char Mode) { - if (Arg->getLocStart().isMacroID()) - return (Lexer::getSourceText( - CharSourceRange::getTokenRange(Arg->getSourceRange()), SM, - LangOpts) + - " \"" + Twine(Mode) + "\"") - .str(); - - StringRef SR = cast<StringLiteral>(Arg->IgnoreParenCasts())->getString(); - return ("\"" + SR + Twine(Mode) + "\"").str(); -} -} // namespace - -void CloexecCheck::registerMatchersImpl( - MatchFinder *Finder, internal::Matcher<FunctionDecl> Function) { - // We assume all the checked APIs are C functions. - Finder->addMatcher( - callExpr( - callee(functionDecl(isExternC(), Function).bind(FuncDeclBindingStr))) - .bind(FuncBindingStr), - this); -} - -void CloexecCheck::insertMacroFlag(const MatchFinder::MatchResult &Result, - StringRef MacroFlag, int ArgPos) { - const auto *MatchedCall = Result.Nodes.getNodeAs<CallExpr>(FuncBindingStr); - const auto *FlagArg = MatchedCall->getArg(ArgPos); - const auto *FD = Result.Nodes.getNodeAs<FunctionDecl>(FuncDeclBindingStr); - SourceManager &SM = *Result.SourceManager; - - if (utils::exprHasBitFlagWithSpelling(FlagArg->IgnoreParenCasts(), SM, - Result.Context->getLangOpts(), - MacroFlag)) - return; - - SourceLocation EndLoc = - Lexer::getLocForEndOfToken(SM.getFileLoc(FlagArg->getLocEnd()), 0, SM, - Result.Context->getLangOpts()); - - diag(EndLoc, "%0 should use %1 where possible") - << FD << MacroFlag - << FixItHint::CreateInsertion(EndLoc, (Twine(" | ") + MacroFlag).str()); -} - -void CloexecCheck::replaceFunc(const MatchFinder::MatchResult &Result, - StringRef WarningMsg, StringRef FixMsg) { - const auto *MatchedCall = Result.Nodes.getNodeAs<CallExpr>(FuncBindingStr); - diag(MatchedCall->getLocStart(), WarningMsg) - << FixItHint::CreateReplacement(MatchedCall->getSourceRange(), FixMsg); -} - -void CloexecCheck::insertStringFlag( - const ast_matchers::MatchFinder::MatchResult &Result, const char Mode, - const int ArgPos) { - const auto *MatchedCall = Result.Nodes.getNodeAs<CallExpr>(FuncBindingStr); - const auto *FD = Result.Nodes.getNodeAs<FunctionDecl>(FuncDeclBindingStr); - const auto *ModeArg = MatchedCall->getArg(ArgPos); - - // Check if the <Mode> may be in the mode string. - const auto *ModeStr = dyn_cast<StringLiteral>(ModeArg->IgnoreParenCasts()); - if (!ModeStr || (ModeStr->getString().find(Mode) != StringRef::npos)) - return; - - const std::string &ReplacementText = buildFixMsgForStringFlag( - ModeArg, *Result.SourceManager, Result.Context->getLangOpts(), Mode); - - diag(ModeArg->getLocStart(), "use %0 mode '%1' to set O_CLOEXEC") - << FD << Mode - << FixItHint::CreateReplacement(ModeArg->getSourceRange(), - ReplacementText); -} - -} // namespace android -} // namespace tidy -} // namespace clang diff --git a/clang-tools-extra/clang-tidy/android/CloexecCheck.h b/clang-tools-extra/clang-tidy/android/CloexecCheck.h deleted file mode 100644 index 8c94937d106..00000000000 --- a/clang-tools-extra/clang-tidy/android/CloexecCheck.h +++ /dev/null @@ -1,95 +0,0 @@ -//===--- CloexecCheck.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. -// -//===----------------------------------------------------------------------===// -/// -/// \file -/// This file contains the declaration of the CloexecCheck class, which is the -/// base class for all of the close-on-exec checks in Android module. -/// -//===----------------------------------------------------------------------===// - -#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_H -#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_H - -#include "../ClangTidy.h" - -namespace clang { -namespace tidy { -namespace android { - -/// \brief The base class for all close-on-exec checks in Android module. -/// To be specific, there are some functions that need the close-on-exec flag to -/// prevent the file descriptor leakage on fork+exec and this class provides -/// utilities to identify and fix these C functions. -class CloexecCheck : public ClangTidyCheck { -public: - CloexecCheck(StringRef Name, ClangTidyContext *Context) - : ClangTidyCheck(Name, Context) {} - -protected: - void - registerMatchersImpl(ast_matchers::MatchFinder *Finder, - ast_matchers::internal::Matcher<FunctionDecl> Function); - - /// Currently, we have three types of fixes. - /// - /// Type1 is to insert the necessary macro flag in the flag argument. For - /// example, 'O_CLOEXEC' is required in function 'open()', so - /// \code - /// open(file, O_RDONLY); - /// \endcode - /// should be - /// \code - /// open(file, O_RDONLY | O_CLOEXE); - /// \endcode - /// - /// \param [out] Result MatchResult from AST matcher. - /// \param MacroFlag The macro name of the flag. - /// \param ArgPos The 0-based position of the flag argument. - void insertMacroFlag(const ast_matchers::MatchFinder::MatchResult &Result, - StringRef MarcoFlag, int ArgPos); - - /// Type2 is to replace the API to another function that has required the - /// ability. For example: - /// \code - /// creat(path, mode); - /// \endcode - /// should be - /// \code - /// open(path, O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, mode) - /// \endcode - /// - /// \param [out] Result MatchResult from AST matcher. - /// \param WarningMsg The warning message. - /// \param FixMsg The fix message. - void replaceFunc(const ast_matchers::MatchFinder::MatchResult &Result, - StringRef WarningMsg, StringRef FixMsg); - - /// Type3 is also to add a flag to the corresponding argument, but this time, - /// the flag is some string and each char represents a mode rather than a - /// macro. For example, 'fopen' needs char 'e' in its mode argument string, so - /// \code - /// fopen(in_file, "r"); - /// \endcode - /// should be - /// \code - /// fopen(in_file, "re"); - /// \endcode - /// - /// \param [out] Result MatchResult from AST matcher. - /// \param Mode The required mode char. - /// \param ArgPos The 0-based position of the flag argument. - void insertStringFlag(const ast_matchers::MatchFinder::MatchResult &Result, - char Mode, const int ArgPos); -}; - -} // namespace android -} // namespace tidy -} // namespace clang - -#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_H diff --git a/clang-tools-extra/clang-tidy/android/CloexecMemfdCreateCheck.cpp b/clang-tools-extra/clang-tidy/android/CloexecMemfdCreateCheck.cpp deleted file mode 100644 index 4820e2bdcc4..00000000000 --- a/clang-tools-extra/clang-tidy/android/CloexecMemfdCreateCheck.cpp +++ /dev/null @@ -1,32 +0,0 @@ -//===--- CloexecMemfdCreateCheck.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 "CloexecMemfdCreateCheck.h" - -using namespace clang::ast_matchers; - -namespace clang { -namespace tidy { -namespace android { - -void CloexecMemfdCreateCheck::registerMatchers(MatchFinder *Finder) { - auto CharPointerType = hasType(pointerType(pointee(isAnyCharacter()))); - registerMatchersImpl( - Finder, functionDecl(returns(isInteger()), hasName("memfd_create"), - hasParameter(0, CharPointerType), - hasParameter(1, hasType(isInteger())))); -} - -void CloexecMemfdCreateCheck::check(const MatchFinder::MatchResult &Result) { - insertMacroFlag(Result, "MFD_CLOEXEC", /*ArgPos=*/1); -} - -} // namespace android -} // namespace tidy -} // namespace clang diff --git a/clang-tools-extra/clang-tidy/android/CloexecMemfdCreateCheck.h b/clang-tools-extra/clang-tidy/android/CloexecMemfdCreateCheck.h deleted file mode 100644 index 0fe96f46dd1..00000000000 --- a/clang-tools-extra/clang-tidy/android/CloexecMemfdCreateCheck.h +++ /dev/null @@ -1,35 +0,0 @@ -//===--- CloexecMemfdCreateCheck.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_MEMFD_CREATE_H -#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CLOEXEC_MEMFD_CREATE_H - -#include "CloexecCheck.h" - -namespace clang { -namespace tidy { -namespace android { - -/// Finds code that uses memfd_create() without using the MFD_CLOEXEC flag. -/// -/// For the user-facing documentation see: -/// http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-memfd-create.html -class CloexecMemfdCreateCheck : public CloexecCheck { -public: - CloexecMemfdCreateCheck(StringRef Name, ClangTidyContext *Context) - : CloexecCheck(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_MEMFD_CREATE_H diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index b98ce2a53c8..d5ee472520f 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -70,12 +70,6 @@ Improvements to clang-tidy ``AllowConditionalIntegerCasts`` -> ``AllowIntegerConditions``, ``AllowConditionalPointerCasts`` -> ``AllowPointerConditions``. -- New `android-cloexec-memfd_create - <http://clang.llvm.org/extra/clang-tidy/checks/android-cloexec-memfd_create.html>`_ check - - Checks if the required file flag ``MFD_CLOEXEC`` is present in the argument - of ``memfd_create()``. - - New `bugprone-integer-division <http://clang.llvm.org/extra/clang-tidy/checks/bugprone-integer-division.html>`_ check diff --git a/clang-tools-extra/docs/clang-tidy/checks/android-cloexec-memfd-create.rst b/clang-tools-extra/docs/clang-tidy/checks/android-cloexec-memfd-create.rst deleted file mode 100644 index a45321d64b3..00000000000 --- a/clang-tools-extra/docs/clang-tidy/checks/android-cloexec-memfd-create.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. title:: clang-tidy - android-cloexec-memfd-create - -android-cloexec-memfd-create -============================ - -``memfd_create()`` should include ``MFD_CLOEXEC`` in its type argument to avoid -the file descriptor leakage. Without this flag, an opened sensitive file would -remain open across a fork+exec to a lower-privileged SELinux domain. - -Examples: - -.. code-block:: c++ - - memfd_create(name, MFD_ALLOW_SEALING); - - // becomes - - memfd_create(name, MFD_ALLOW_SEALING | MFD_CLOEXEC); diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst index cce277e782d..ae024cb467e 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -6,7 +6,6 @@ Clang-Tidy Checks .. toctree:: android-cloexec-creat android-cloexec-fopen - android-cloexec-memfd-create android-cloexec-open android-cloexec-socket boost-use-to-string diff --git a/clang-tools-extra/test/clang-tidy/android-cloexec-memfd-create.cpp b/clang-tools-extra/test/clang-tidy/android-cloexec-memfd-create.cpp deleted file mode 100644 index a8dafd5e887..00000000000 --- a/clang-tools-extra/test/clang-tidy/android-cloexec-memfd-create.cpp +++ /dev/null @@ -1,63 +0,0 @@ -// RUN: %check_clang_tidy %s android-cloexec-memfd-create %t - -#define MFD_ALLOW_SEALING 1 -#define __O_CLOEXEC 3 -#define MFD_CLOEXEC __O_CLOEXEC -#define TEMP_FAILURE_RETRY(exp) \ - ({ \ - int _rc; \ - do { \ - _rc = (exp); \ - } while (_rc == -1); \ - }) -#define NULL 0 - -extern "C" int memfd_create(const char *name, unsigned int flags); - -void a() { - memfd_create(NULL, MFD_ALLOW_SEALING); - // CHECK-MESSAGES: :[[@LINE-1]]:39: warning: 'memfd_create' should use MFD_CLOEXEC where possible [android-cloexec-memfd-create] - // CHECK-FIXES: memfd_create(NULL, MFD_ALLOW_SEALING | MFD_CLOEXEC) - TEMP_FAILURE_RETRY(memfd_create(NULL, MFD_ALLOW_SEALING)); - // CHECK-MESSAGES: :[[@LINE-1]]:58: warning: 'memfd_create' - // CHECK-FIXES: TEMP_FAILURE_RETRY(memfd_create(NULL, MFD_ALLOW_SEALING | MFD_CLOEXEC)) -} - -void f() { - memfd_create(NULL, 3); - // CHECK-MESSAGES: :[[@LINE-1]]:23: warning: 'memfd_create' - // CHECK-FIXES: memfd_create(NULL, 3 | MFD_CLOEXEC) - TEMP_FAILURE_RETRY(memfd_create(NULL, 3)); - // CHECK-MESSAGES: :[[@LINE-1]]:42: warning: 'memfd_create' - // CHECK-FIXES: TEMP_FAILURE_RETRY(memfd_create(NULL, 3 | MFD_CLOEXEC)) - - int flag = 3; - memfd_create(NULL, flag); - TEMP_FAILURE_RETRY(memfd_create(NULL, flag)); -} - -namespace i { -int memfd_create(const char *name, unsigned int flags); - -void d() { - memfd_create(NULL, MFD_ALLOW_SEALING); - TEMP_FAILURE_RETRY(memfd_create(NULL, MFD_ALLOW_SEALING)); -} - -} // namespace i - -void e() { - memfd_create(NULL, MFD_CLOEXEC); - TEMP_FAILURE_RETRY(memfd_create(NULL, MFD_CLOEXEC)); - memfd_create(NULL, MFD_ALLOW_SEALING | MFD_CLOEXEC); - TEMP_FAILURE_RETRY(memfd_create(NULL, MFD_ALLOW_SEALING | MFD_CLOEXEC)); -} - -class G { -public: - int memfd_create(const char *name, unsigned int flags); - void d() { - memfd_create(NULL, MFD_ALLOW_SEALING); - TEMP_FAILURE_RETRY(memfd_create(NULL, MFD_ALLOW_SEALING)); - } -}; |