Index: clang-tidy/android/AndroidTidyModule.cpp =================================================================== --- clang-tidy/android/AndroidTidyModule.cpp +++ clang-tidy/android/AndroidTidyModule.cpp @@ -10,6 +10,7 @@ #include "../ClangTidy.h" #include "../ClangTidyModule.h" #include "../ClangTidyModuleRegistry.h" +#include "CreatUsageCheck.h" #include "FileOpenFlagCheck.h" using namespace clang::ast_matchers; @@ -24,6 +25,7 @@ public: void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override { CheckFactories.registerCheck("android-file-open-flag"); + CheckFactories.registerCheck("android-creat-usage"); } }; Index: clang-tidy/android/CMakeLists.txt =================================================================== --- clang-tidy/android/CMakeLists.txt +++ clang-tidy/android/CMakeLists.txt @@ -2,6 +2,7 @@ add_clang_library(clangTidyAndroidModule AndroidTidyModule.cpp + CreatUsageCheck.cpp FileOpenFlagCheck.cpp LINK_LIBS Index: clang-tidy/android/CreatUsageCheck.h =================================================================== --- /dev/null +++ clang-tidy/android/CreatUsageCheck.h @@ -0,0 +1,39 @@ +//===--- CreatUsageCheck.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_CREAT_USAGE_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CREAT_USAGE_H + +#include "../ClangTidy.h" + +namespace clang { +namespace tidy { +namespace android { + +/// creat() is better to be replaced by open(). +/// Find the usage of creat() and redirect user to use open(). + +/// http://clang.llvm.org/extra/clang-tidy/checks/android-creat-usage.html + +class CreatUsageCheck : public ClangTidyCheck { +public: + CreatUsageCheck(StringRef Name, ClangTidyContext *Context) + : ClangTidyCheck(Name, Context) {} + void registerMatchers(ast_matchers::MatchFinder *Finder) override; + void check(const ast_matchers::MatchFinder::MatchResult &Result) override; + inline std::string BuildReplaceText(const Expr *FirstArg, + const Expr *SecondArg, + const SourceManager &SM); +}; + +} // namespace android +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ANDROID_CREAT_USAGE_H Index: clang-tidy/android/CreatUsageCheck.cpp =================================================================== --- /dev/null +++ clang-tidy/android/CreatUsageCheck.cpp @@ -0,0 +1,58 @@ +//===--- CreatUsageCheck.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 "CreatUsageCheck.h" +#include "../utils/ExprToStr.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 { + +void CreatUsageCheck::registerMatchers(MatchFinder *Finder) { + auto CharPointerType = hasType(pointerType(pointee(isAnyCharacter()))); + auto MODETType = hasType(namedDecl(hasName("mode_t"))); + + Finder->addMatcher( + callExpr( + callee(functionDecl(isExternC(), hasParameter(0, CharPointerType), + hasParameter(1, MODETType), returns(isInteger()), + hasName("creat")) + .bind("funcDecl"))) + .bind("creatFn"), + this); +} + +void CreatUsageCheck::check(const MatchFinder::MatchResult &Result) { + const auto *MatchedCall = Result.Nodes.getNodeAs("creatFn"); + const SourceManager &SM = *Result.SourceManager; + + SourceRange Range(MatchedCall->getLocStart(), MatchedCall->getLocEnd()); + const std::string &ReplacementText = + BuildReplaceText(MatchedCall->getArg(0), MatchedCall->getArg(1), SM); + diag(MatchedCall->getLocStart(), + "prefer open() to creat() because open() allows O_CLOEXEC.") + << FixItHint::CreateReplacement(Range, ReplacementText); +} + +std::string CreatUsageCheck::BuildReplaceText(const Expr *FirstArg, + const Expr *SecondArg, + const SourceManager &SM) { + return "open (" + utils::ExprToStr(FirstArg, SM, getLangOpts()) + + ", O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC, " + + utils::ExprToStr(SecondArg, SM, getLangOpts()) + ")"; +} + +} // namespace android +} // namespace tidy +} // namespace clang Index: clang-tidy/utils/CMakeLists.txt =================================================================== --- clang-tidy/utils/CMakeLists.txt +++ clang-tidy/utils/CMakeLists.txt @@ -4,6 +4,7 @@ ASTUtils.cpp DeclRefExprUtils.cpp ExprSequence.cpp + ExprToStr.cpp FixItHintUtils.cpp HeaderFileExtensionsUtils.cpp HeaderGuard.cpp Index: clang-tidy/utils/ExprToStr.h =================================================================== --- /dev/null +++ clang-tidy/utils/ExprToStr.h @@ -0,0 +1,28 @@ +//===---------- ExprToStr.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_EXPRTOSTR_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_EXPRTOSTR_H + +#include "../ClangTidy.h" +#include "clang/Lex/Lexer.h" + +namespace clang { +namespace tidy { +namespace utils { + +// Get the source code of the corresponding expr. +std::string ExprToStr(const Expr *EX, const SourceManager &SM, + const LangOptions &LangOpts); + +} // namespace utils +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_EXPRTOSTR_H Index: clang-tidy/utils/ExprToStr.cpp =================================================================== --- /dev/null +++ clang-tidy/utils/ExprToStr.cpp @@ -0,0 +1,27 @@ +//===---------- ExprToStr.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 "ExprToStr.h" + +namespace clang { +namespace tidy { +namespace utils { + +std::string ExprToStr(const Expr *EX, const SourceManager &SM, + const LangOptions &LangOpts) { + clang::SourceLocation B(SM.getFileLoc(EX->getLocStart())), + E(SM.getFileLoc(EX->getLocEnd())); + SourceLocation TE(Lexer::getLocForEndOfToken(E, 0, SM, LangOpts)); + return std::string(SM.getCharacterData(B), + SM.getCharacterData(TE) - SM.getCharacterData(B)); +} + +} // namespace utils +} // namespace tidy +} // namespace clang Index: docs/ReleaseNotes.rst =================================================================== --- docs/ReleaseNotes.rst +++ docs/ReleaseNotes.rst @@ -57,6 +57,11 @@ Improvements to clang-tidy -------------------------- +- New `android-creat-call + `_ check + + Detect usage of ``creat()``. + - New `android-file-open-flag `_ check Index: docs/clang-tidy/checks/android-creat-usage.cpp =================================================================== --- /dev/null +++ docs/clang-tidy/checks/android-creat-usage.cpp @@ -0,0 +1,31 @@ +// RUN: %check_clang_tidy %s android-creat-usage %t + +typedef int mode_t; + +extern "C" int creat(const char *path, mode_t, ...); +extern "C" int create(const char *path, mode_t, ...); + +void f() { + creat("filename", 0); + // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: prefer open() to creat() because open() allows O_CLOEXEC. [android-creat-usage] + // CHECK-FIXES: open ("filename", O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC, 0); + create("filename", 0); + // CHECK-MESSAGES-NOT: warning: +} + +namespace i { +int creat(const char *path, mode_t, ...); +void g() { + creat("filename", 0); + // CHECK-MESSAGES-NOT: warning: +} +} // namespace i + +class C { +public: + int creat(const char *path, mode_t, ...); + void h() { + creat("filename", 0); + // CHECK-MESSAGES-NOT: warning: + } +}; Index: test/clang-tidy/android-creat-usage.cpp =================================================================== --- /dev/null +++ test/clang-tidy/android-creat-usage.cpp @@ -0,0 +1,31 @@ +// RUN: %check_clang_tidy %s android-creat-usage %t + +typedef int mode_t; + +extern "C" int creat(const char *path, mode_t, ...); +extern "C" int create(const char *path, mode_t, ...); + +void f() { + creat("filename", 0); + // CHECK-MESSAGES: :[[@LINE-1]]:3: warning: prefer open() to creat() because open() allows O_CLOEXEC. [android-creat-usage] + // CHECK-FIXES: open ("filename", O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC, 0); + create("filename", 0); + // CHECK-MESSAGES-NOT: warning: +} + +namespace i { +int creat(const char *path, mode_t, ...); +void g() { + creat("filename", 0); + // CHECK-MESSAGES-NOT: warning: +} +} // namespace i + +class C { +public: + int creat(const char *path, mode_t, ...); + void h() { + creat("filename", 0); + // CHECK-MESSAGES-NOT: warning: + } +};