Rename tool

Author: ccotter

clang-tools-extra/clang-tidy/bugprone/BugproneTidyModule.cpp

@@ -86,7 +86,7 @@
 #include "TooSmallLoopVariableCheck.h"
 #include "UncheckedOptionalAccessCheck.h"
 #include "UndefinedMemoryManipulationCheck.h"
-#include "UndefinedSprintfOverlapCheck.h"
+#include "SprintfArgumentOverlapCheck.h"
 #include "UndelegatedConstructorCheck.h"
 #include "UnhandledExceptionAtNewCheck.h"
 #include "UnhandledSelfAssignmentCheck.h"
@@ -249,8 +249,8 @@ class BugproneModule : public ClangTidyModule {
  "bugprone-unchecked-optional-access");
  CheckFactories.registerCheck<UndefinedMemoryManipulationCheck>(
  "bugprone-undefined-memory-manipulation");
- CheckFactories.registerCheck<UndefinedSprintfOverlapCheck>(
- "bugprone-undefined-sprintf-overlap");
+ CheckFactories.registerCheck<SprintfArgumentOverlapCheck>(
+ "bugprone-sprintf-argument-overlap");
  CheckFactories.registerCheck<UndelegatedConstructorCheck>(
  "bugprone-undelegated-constructor");
  CheckFactories.registerCheck<UnhandledSelfAssignmentCheck>(

clang-tools-extra/clang-tidy/bugprone/CMakeLists.txt

@@ -83,7 +83,7 @@ add_clang_library(clangTidyBugproneModule STATIC
  TooSmallLoopVariableCheck.cpp
  UncheckedOptionalAccessCheck.cpp
  UndefinedMemoryManipulationCheck.cpp
- UndefinedSprintfOverlapCheck.cpp
+ SprintfArgumentOverlapCheck.cpp
  UndelegatedConstructorCheck.cpp
  UnhandledExceptionAtNewCheck.cpp
  UnhandledSelfAssignmentCheck.cpp

clang-tools-extra/clang-tidy/bugprone/UndefinedSprintfOverlapCheck.cpp renamed to clang-tools-extra/clang-tidy/bugprone/SprintfArgumentOverlapCheck.cpp

@@ -1,12 +1,12 @@
-//===--- UndefinedSprintfOverlapCheck.cpp - clang-tidy --------------------===//
+//===--- SprintfArgumentOverlapCheck.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 "UndefinedSprintfOverlapCheck.h"
+#include "SprintfArgumentOverlapCheck.h"
 #include "../utils/ASTUtils.h"
 #include "clang/ASTMatchers/ASTMatchFinder.h"
 #include "clang/Lex/Lexer.h"
@@ -48,12 +48,12 @@ AST_MATCHER_P(CallExpr, forEachArgument, ast_matchers::internal::Matcher<Expr>,
  return Matched;
 }
 
-UndefinedSprintfOverlapCheck::UndefinedSprintfOverlapCheck(
+SprintfArgumentOverlapCheck::SprintfArgumentOverlapCheck(
  StringRef Name, ClangTidyContext *Context)
  : ClangTidyCheck(Name, Context),
  SprintfRegex(Options.get("SprintfFunction", "(::std)?::sn?printf")) {}
 
-void UndefinedSprintfOverlapCheck::registerMatchers(MatchFinder *Finder) {
+void SprintfArgumentOverlapCheck::registerMatchers(MatchFinder *Finder) {
  Finder->addMatcher(
  callExpr(callee(functionDecl(matchesName(SprintfRegex)).bind("decl")),
  hasArgument(0, expr().bind("firstArgExpr")),
@@ -63,7 +63,7 @@ void UndefinedSprintfOverlapCheck::registerMatchers(MatchFinder *Finder) {
  this);
 }
 
-void UndefinedSprintfOverlapCheck::check(
+void SprintfArgumentOverlapCheck::check(
  const MatchFinder::MatchResult &Result) {
  const auto *FirstArg = Result.Nodes.getNodeAs<Expr>("firstArgExpr");
  const auto *OtherArg = Result.Nodes.getNodeAs<Expr>("otherArgExpr");
@@ -97,7 +97,7 @@ void UndefinedSprintfOverlapCheck::check(
  << OtherArg->getSourceRange();
 }
 
-void UndefinedSprintfOverlapCheck::storeOptions(
+void SprintfArgumentOverlapCheck::storeOptions(
  ClangTidyOptions::OptionMap &Opts) {
  Options.store(Opts, "SprintfRegex", SprintfRegex);
 }

clang-tools-extra/clang-tidy/bugprone/UndefinedSprintfOverlapCheck.h renamed to clang-tools-extra/clang-tidy/bugprone/SprintfArgumentOverlapCheck.h

@@ -1,13 +1,13 @@
-//===--- UndefinedSprintfOverlapCheck.h - clang-tidy ------------*- C++ -*-===//
+//===--- SprintfArgumentOverlapCheck.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_UNDEFINEDSPRINTFOVERLAPCHECK_H
-#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNDEFINEDSPRINTFOVERLAPCHECK_H
+#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SPRINTFARGUMENTOVERLAPCHECK_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SPRINTFARGUMENTOVERLAPCHECK_H
 
 #include "../ClangTidyCheck.h"
 
@@ -17,10 +17,10 @@ namespace clang::tidy::bugprone {
 /// the destination buffer (the first argument).
 ///
 /// For the user-facing documentation see:
-/// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/undefined-sprintf-overlap.html
-class UndefinedSprintfOverlapCheck : public ClangTidyCheck {
+/// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/sprintf-argument-overlap.html
+class SprintfArgumentOverlapCheck : public ClangTidyCheck {
 public:
- UndefinedSprintfOverlapCheck(StringRef Name, ClangTidyContext *Context);
+ SprintfArgumentOverlapCheck(StringRef Name, ClangTidyContext *Context);
  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
@@ -37,4 +37,4 @@ class UndefinedSprintfOverlapCheck : public ClangTidyCheck {
 
 } // namespace clang::tidy::bugprone
 
-#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_UNDEFINEDSPRINTFOVERLAPCHECK_H
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SPRINTFARGUMENTOVERLAPCHECK_H

clang-tools-extra/docs/ReleaseNotes.rst

@@ -157,8 +157,8 @@ New checks
  Gives warnings for tagged unions, where the number of tags is
  different from the number of data members inside the union.
 
-- New :doc:`bugprone-undefined-sprintf-overlap
- <clang-tidy/checks/bugprone/undefined-sprintf-overlap>` check.
+- New :doc:`bugprone-sprintf-argument-overlap
+ <clang-tidy/checks/bugprone/sprintf-argument-overlap>` check.
 
  Warns if any arguments to the ``sprintf`` family of functions overlap with the
  first argument.

clang-tools-extra/docs/clang-tidy/checks/bugprone/undefined-sprintf-overlap.rst renamed to clang-tools-extra/docs/clang-tidy/checks/bugprone/sprintf-argument-overlap.rst

@@ -1,7 +1,7 @@
-.. title:: clang-tidy - bugprone-undefined-sprintf-overlap
+.. title:: clang-tidy - bugprone-sprintf-argument-overlap
 
-bugprone-undefined-sprintf-overlap
-==================================
+bugprone-sprintf-argument-overlap
+=================================
 
 Warns if any arguments to the ``sprintf`` family of functions overlap with the
 destination buffer (the first argument).

clang-tools-extra/docs/clang-tidy/checks/list.rst

@@ -154,7 +154,7 @@ Clang-Tidy Checks
  :doc:`bugprone-too-small-loop-variable <bugprone/too-small-loop-variable>`,
  :doc:`bugprone-unchecked-optional-access <bugprone/unchecked-optional-access>`,
  :doc:`bugprone-undefined-memory-manipulation <bugprone/undefined-memory-manipulation>`,
- :doc:`bugprone-undefined-sprintf-overlap <bugprone/undefined-sprintf-overlap>`,
+ :doc:`bugprone-sprintf-argument-overlap <bugprone/sprintf-argument-overlap>`,
  :doc:`bugprone-undelegated-constructor <bugprone/undelegated-constructor>`,
  :doc:`bugprone-unhandled-exception-at-new <bugprone/unhandled-exception-at-new>`,
  :doc:`bugprone-unhandled-self-assignment <bugprone/unhandled-self-assignment>`,

clang-tools-extra/test/clang-tidy/checkers/bugprone/sprintf-argument-overlap.cpp

@@ -0,0 +1,82 @@
+// RUN: %check_clang_tidy %s bugprone-sprintf-argument-overlap %t
+
+using size_t = decltype(sizeof(int));
+
+extern "C" int sprintf(char *s, const char *format, ...);
+extern "C" int snprintf(char *s, size_t n, const char *format, ...);
+
+namespace std {
+ int snprintf(char *s, size_t n, const char *format, ...);
+}
+
+struct st_t {
+ char buf[10];
+ char buf2[10];
+};
+
+struct st2_t {
+ st_t inner;
+};
+
+struct st3_t {
+ st2_t inner;
+};
+
+void first_arg_overlaps() {
+ char buf[10];
+ sprintf(buf, "%s", buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:22: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ snprintf(buf, sizeof(buf), "%s", buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:36: warning: the 3rd argument in 'snprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ std::snprintf(buf, sizeof(buf), "%s", buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:41: warning: the 3rd argument in 'snprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+
+ char* c = &buf[0];
+ sprintf(c, "%s", c);
+ // CHECK-MESSAGES: :[[@LINE-1]]:20: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ snprintf(c, sizeof(buf), "%s", c);
+ // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: the 3rd argument in 'snprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+
+ snprintf(c, sizeof(buf), "%s%s", c, c);
+ // CHECK-MESSAGES: :[[@LINE-1]]:36: warning: the 3rd argument in 'snprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ // CHECK-MESSAGES: :[[@LINE-2]]:39: warning: the 4th argument in 'snprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+
+ char buf2[10];
+ sprintf(buf, "%s", buf2);
+ sprintf(buf, "%s", buf2, buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:28: warning: the 3rd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+
+ st_t st1, st2;
+ sprintf(st1.buf, "%s", st1.buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:26: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ sprintf(st1.buf, "%s", st1.buf2);
+ sprintf(st1.buf, "%s", st2.buf);
+
+ st3_t st3;
+ sprintf(st3.inner.inner.buf, "%s", st3.inner.inner.buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:38: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ sprintf((st3.inner.inner.buf), "%s", st3.inner.inner.buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:40: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+
+ st_t* stp;
+ sprintf(stp->buf, "%s", stp->buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:27: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ sprintf((stp->buf), "%s", stp->buf);
+ // CHECK-MESSAGES: :[[@LINE-1]]:29: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ stp = &st1;
+ sprintf(stp->buf, "%s", st1.buf);
+
+ char bufs[10][10];
+ sprintf(bufs[1], "%s", bufs[1]);
+ // CHECK-MESSAGES: :[[@LINE-1]]:26: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+ sprintf(bufs[0], "%s", bufs[1]);
+
+ char bufss[10][10][10];
+ sprintf(bufss[0][1], "%s", bufss[0][1]);
+ // CHECK-MESSAGES: :[[@LINE-1]]:30: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-sprintf-argument-overlap]
+
+ sprintf(bufss[0][0], "%s", bufss[0][1]);
+
+ int i = 0;
+ sprintf(bufss[0][++i], "%s", bufss[0][++i]);
+}

clang-tools-extra/test/clang-tidy/checkers/bugprone/undefined-sprintf-overlap.cpp

@@ -30,6 +30,9 @@ void first_arg_overlaps() {
  // CHECK-MESSAGES: :[[@LINE-1]]:36: warning: the 3rd argument in 'snprintf' overlaps the 1st argument, which is undefined behavior [bugprone-undefined-sprintf-overlap]
  std::snprintf(buf, sizeof(buf), "%s", buf);
  // CHECK-MESSAGES: :[[@LINE-1]]:41: warning: the 3rd argument in 'snprintf' overlaps the 1st argument, which is undefined behavior [bugprone-undefined-sprintf-overlap]
+ sprintf(buf+1, "%s", (buf+1));
+ // CHECK-MESSAGES: :[[@LINE-1]]:24: warning: the 2nd argument in 'sprintf' overlaps the 1st argument, which is undefined behavior [bugprone-undefined-sprintf-overlap]
+ sprintf(buf+1, "%s", buf+2);
 
  char* c = &buf[0];
  sprintf(c, "%s", c);