[clang-tidy] new check misc-use-internal-linkage #90830

HerrCai0907 · 2024-05-02T07:46:13Z

Add new check misc-use-internal-linkage to detect variable and function can be marked as static.

llvmbot · 2024-05-02T07:46:47Z

@llvm/pr-subscribers-clang-tools-extra

@llvm/pr-subscribers-clang-tidy

Author: Congcong Cai (HerrCai0907)

Changes

Add new check readability-mark-static to dectect variable and function can be marked as static.

Full diff: https://github.com/llvm/llvm-project/pull/90830.diff

11 Files Affected:

(modified) clang-tools-extra/clang-tidy/readability/CMakeLists.txt (+1)
(added) clang-tools-extra/clang-tidy/readability/MarkStaticCheck.cpp (+65)
(added) clang-tools-extra/clang-tidy/readability/MarkStaticCheck.h (+33)
(modified) clang-tools-extra/clang-tidy/readability/ReadabilityTidyModule.cpp (+2)
(modified) clang-tools-extra/docs/ReleaseNotes.rst (+5)
(modified) clang-tools-extra/docs/clang-tidy/checks/list.rst (+1)
(added) clang-tools-extra/docs/clang-tidy/checks/readability/mark-static.rst (+26)
(added) clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/mark-static-var/func.h (+3)
(added) clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/mark-static-var/var.h (+3)
(added) clang-tools-extra/test/clang-tidy/checkers/readability/mark-static-func.cpp (+24)
(added) clang-tools-extra/test/clang-tidy/checkers/readability/mark-static-var.cpp (+34)

diff --git a/clang-tools-extra/clang-tidy/readability/CMakeLists.txt b/clang-tools-extra/clang-tidy/readability/CMakeLists.txt
index 41065fc8e87859..3e0cbc4d943274 100644
--- a/clang-tools-extra/clang-tidy/readability/CMakeLists.txt
+++ b/clang-tools-extra/clang-tidy/readability/CMakeLists.txt
@@ -23,6 +23,7 @@ add_clang_library(clangTidyReadabilityModule
   IdentifierLengthCheck.cpp
   IdentifierNamingCheck.cpp
   ImplicitBoolConversionCheck.cpp
+  MarkStaticCheck.cpp
   RedundantInlineSpecifierCheck.cpp
   InconsistentDeclarationParameterNameCheck.cpp
   IsolateDeclarationCheck.cpp
diff --git a/clang-tools-extra/clang-tidy/readability/MarkStaticCheck.cpp b/clang-tools-extra/clang-tidy/readability/MarkStaticCheck.cpp
new file mode 100644
index 00000000000000..c8881963071de8
--- /dev/null
+++ b/clang-tools-extra/clang-tidy/readability/MarkStaticCheck.cpp
@@ -0,0 +1,65 @@
+//===--- MarkStaticCheck.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 "MarkStaticCheck.h"
+#include "clang/AST/Decl.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "clang/ASTMatchers/ASTMatchers.h"
+#include "clang/ASTMatchers/ASTMatchersMacros.h"
+#include "clang/Basic/Specifiers.h"
+
+using namespace clang::ast_matchers;
+
+namespace clang::tidy::readability {
+
+namespace {
+
+AST_POLYMORPHIC_MATCHER(isFirstDecl,
+                        AST_POLYMORPHIC_SUPPORTED_TYPES(FunctionDecl,
+                                                        VarDecl)) {
+  return Node.isFirstDecl();
+}
+
+AST_MATCHER(Decl, isInMainFile) {
+  return Finder->getASTContext().getSourceManager().isInMainFile(
+      Node.getLocation());
+}
+
+AST_POLYMORPHIC_MATCHER(isExternStorageClass,
+                        AST_POLYMORPHIC_SUPPORTED_TYPES(FunctionDecl,
+                                                        VarDecl)) {
+  return Node.getStorageClass() == SC_Extern;
+}
+
+} // namespace
+
+void MarkStaticCheck::registerMatchers(MatchFinder *Finder) {
+  auto Common =
+      allOf(isFirstDecl(), isInMainFile(),
+            unless(anyOf(isStaticStorageClass(), isExternStorageClass(),
+                         isInAnonymousNamespace())));
+  Finder->addMatcher(
+      functionDecl(Common, unless(cxxMethodDecl()), unless(isMain()))
+          .bind("fn"),
+      this);
+  Finder->addMatcher(varDecl(Common, hasGlobalStorage()).bind("var"), this);
+}
+
+void MarkStaticCheck::check(const MatchFinder::MatchResult &Result) {
+  if (const auto *FD = Result.Nodes.getNodeAs<FunctionDecl>("fn")) {
+    diag(FD->getLocation(), "function %0 can be static") << FD;
+    return;
+  }
+  if (const auto *VD = Result.Nodes.getNodeAs<VarDecl>("var")) {
+    diag(VD->getLocation(), "variable %0 can be static") << VD;
+    return;
+  }
+  llvm_unreachable("");
+}
+
+} // namespace clang::tidy::readability
diff --git a/clang-tools-extra/clang-tidy/readability/MarkStaticCheck.h b/clang-tools-extra/clang-tidy/readability/MarkStaticCheck.h
new file mode 100644
index 00000000000000..0af6788d3e3d85
--- /dev/null
+++ b/clang-tools-extra/clang-tidy/readability/MarkStaticCheck.h
@@ -0,0 +1,33 @@
+//===--- MarkStaticCheck.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_READABILITY_MARKSTATICCHECK_H
+#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_MARKSTATICCHECK_H
+
+#include "../ClangTidyCheck.h"
+
+namespace clang::tidy::readability {
+
+/// Detects variable and function can be marked as static.
+///
+/// For the user-facing documentation see:
+/// http://clang.llvm.org/extra/clang-tidy/checks/readability/mark-static.html
+class MarkStaticCheck : public ClangTidyCheck {
+public:
+  MarkStaticCheck(StringRef Name, ClangTidyContext *Context)
+      : ClangTidyCheck(Name, Context) {}
+  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
+  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
+  std::optional<TraversalKind> getCheckTraversalKind() const override {
+    return TK_IgnoreUnlessSpelledInSource;
+  }
+};
+
+} // namespace clang::tidy::readability
+
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_MARKSTATICCHECK_H
diff --git a/clang-tools-extra/clang-tidy/readability/ReadabilityTidyModule.cpp b/clang-tools-extra/clang-tidy/readability/ReadabilityTidyModule.cpp
index d61c0ba39658e5..5c04426818b5f7 100644
--- a/clang-tools-extra/clang-tidy/readability/ReadabilityTidyModule.cpp
+++ b/clang-tools-extra/clang-tidy/readability/ReadabilityTidyModule.cpp
@@ -32,6 +32,7 @@
 #include "IsolateDeclarationCheck.h"
 #include "MagicNumbersCheck.h"
 #include "MakeMemberFunctionConstCheck.h"
+#include "MarkStaticCheck.h"
 #include "MathMissingParenthesesCheck.h"
 #include "MisleadingIndentationCheck.h"
 #include "MisplacedArrayIndexCheck.h"
@@ -106,6 +107,7 @@ class ReadabilityModule : public ClangTidyModule {
         "readability-identifier-naming");
     CheckFactories.registerCheck<ImplicitBoolConversionCheck>(
         "readability-implicit-bool-conversion");
+    CheckFactories.registerCheck<MarkStaticCheck>("readability-mark-static");
     CheckFactories.registerCheck<MathMissingParenthesesCheck>(
         "readability-math-missing-parentheses");
     CheckFactories.registerCheck<RedundantInlineSpecifierCheck>(
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 5956ccb925485c..35e4d7e722f1de 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -151,6 +151,11 @@ New checks
   Enforces consistent style for enumerators' initialization, covering three
   styles: none, first only, or all initialized explicitly.
 
+- New :doc:`readability-mark-static
+  <clang-tidy/checks/readability/mark-static>` check.
+
+  Detects variable and function can be marked as static.
+
 - New :doc:`readability-math-missing-parentheses
   <clang-tidy/checks/readability/math-missing-parentheses>` check.
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst
index 5cdaf9e35b6acd..4f473e13eb9480 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -364,6 +364,7 @@ Clang-Tidy Checks
    :doc:`readability-isolate-declaration <readability/isolate-declaration>`, "Yes"
    :doc:`readability-magic-numbers <readability/magic-numbers>`,
    :doc:`readability-make-member-function-const <readability/make-member-function-const>`, "Yes"
+   :doc:`readability-mark-static <readability/mark-static>`,
    :doc:`readability-math-missing-parentheses <readability/math-missing-parentheses>`, "Yes"
    :doc:`readability-misleading-indentation <readability/misleading-indentation>`,
    :doc:`readability-misplaced-array-index <readability/misplaced-array-index>`, "Yes"
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/mark-static.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/mark-static.rst
new file mode 100644
index 00000000000000..331e969ee061b9
--- /dev/null
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability/mark-static.rst
@@ -0,0 +1,26 @@
+.. title:: clang-tidy - readability-mark-static
+
+readability-mark-static
+=======================
+
+Detects variable and function can be marked as static.
+
+Static functions and variables are scoped to a single file. Marking functions
+and variables as static helps to better remove dead code. In addition, it gives
+the compiler more information and can help compiler make more aggressive
+optimizations.
+
+Example:
+
+.. code-block:: c++
+  int v1; // can be marked as static
+
+  void fn1(); // can be marked as static
+
+  namespace {
+    // no need since already in anonymous namespace
+    int v2;
+    void fn2();
+  }
+  // no need since already in anonymous namespace
+  extern int v2;
diff --git a/clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/mark-static-var/func.h b/clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/mark-static-var/func.h
new file mode 100644
index 00000000000000..31c68e9ad0cd92
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/mark-static-var/func.h
@@ -0,0 +1,3 @@
+#pragma once
+
+void func_header();
diff --git a/clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/mark-static-var/var.h b/clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/mark-static-var/var.h
new file mode 100644
index 00000000000000..37e4cfbafff146
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/checkers/readability/Inputs/mark-static-var/var.h
@@ -0,0 +1,3 @@
+#pragma once
+
+extern int gloabl_header;
diff --git a/clang-tools-extra/test/clang-tidy/checkers/readability/mark-static-func.cpp b/clang-tools-extra/test/clang-tidy/checkers/readability/mark-static-func.cpp
new file mode 100644
index 00000000000000..c9adcc70b8c5cb
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/checkers/readability/mark-static-func.cpp
@@ -0,0 +1,24 @@
+// RUN: %check_clang_tidy %s readability-mark-static %t -- -- -I%S/Inputs/mark-static-var
+
+#include "func.h"
+
+void func() {}
+// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function 'func'
+
+template<class T>
+void func_template() {}
+// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: function 'func_template'
+
+struct S {
+  void method();
+};
+void S::method() {}
+
+void func_header();
+extern void func_extern();
+static void func_static();
+namespace {
+void func_anonymous_ns();
+} // namespace
+
+int main(int argc, const char*argv[]) {}
diff --git a/clang-tools-extra/test/clang-tidy/checkers/readability/mark-static-var.cpp b/clang-tools-extra/test/clang-tidy/checkers/readability/mark-static-var.cpp
new file mode 100644
index 00000000000000..f0b0486dd38c63
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/checkers/readability/mark-static-var.cpp
@@ -0,0 +1,34 @@
+// RUN: %check_clang_tidy %s readability-mark-static %t -- -- -I%S/Inputs/mark-static-var
+
+#include "var.h"
+
+int global;
+// CHECK-MESSAGES: :[[@LINE-1]]:5: warning: variable 'global'
+
+template<class T>
+T global_template;
+// CHECK-MESSAGES: :[[@LINE-1]]:3: warning: variable 'global_template'
+
+int gloabl_header;
+
+extern int global_extern;
+
+static int global_static;
+
+namespace {
+static int global_anonymous_ns;
+namespace NS {
+static int global_anonymous_ns;
+}
+}
+
+static void f(int para) {
+  int local;
+  static int local_static;
+}
+
+struct S {
+  int m1;
+  static int m2;
+};
+int S::m2;

PiotrZSL

Wrong check name, maybe readability-unessesary-external-linkage or something, maybe it should even be an performance check [as there it will bring more benefits] (current check suggest more an "static methods").
Add support for unity builds (.cpp files included from single .cpp file = isInMainFile is not sufficient)
Diagnostic need to be more detailed
When I run into these issues, i got questions from developers why not use anonymous namespaces (maybe it could be configurable, or finall check restrict only to static [I prefer static])

Additionally when those issues were being fixed in project, there were lot of situations where there were forward declaration in header file, but developer forget to include header file in .cpp, this is why diagnostic need to be more detailed, so developer could find issue, instead of adding static.

In summary, my main concern is check name & diagnostic, current name is too generic

clang-tools-extra/clang-tidy/readability/MarkStaticCheck.cpp

clang-tools-extra/docs/clang-tidy/checks/readability/mark-static.rst

HerrCai0907 · 2024-05-02T09:41:24Z

Add support for unity builds (.cpp files included from single .cpp file = isInMainFile is not sufficient)

For unity build, it looks like a project level decision. Then they can ignore this check. Maybe I can provide an option to treat some extension as main file also.

firewave · 2024-05-02T10:03:15Z

Isn't this already covered by -Wmissing-prototypes?

PiotrZSL · 2024-05-02T10:10:14Z

Isn't this already covered by -Wmissing-prototypes?

No, because -Wmissing-prototypes will not provide warning, when both declaration and definition is in .cpp

PiotrZSL · 2024-05-02T10:10:44Z

Maybe I can provide an option to treat some extension as main file also.

Clang-tidy already got those options, check just need to utilize them.

EugeneZelenko · 2024-05-02T14:01:41Z

readability-use-static?

carlosgalvezp · 2024-05-02T14:50:57Z

I'm not sure this is so much a readability check, I'd put it in misc, since it solves a variety of problems (dead code elimination, optimizations, ODR violations, etc). What about misc-use-internal-linkage?
The auto-fix should be configurable to choose static or anonymous namespace.

github-actions · 2024-05-03T07:36:14Z

✅ With the latest revision this PR passed the C/C++ code formatter.

clang-tools-extra/clang-tidy/readability/UnnecessaryExternalLinkageCheck.cpp

clang-tools-extra/docs/ReleaseNotes.rst

clang-tools-extra/docs/clang-tidy/checks/readability/unnecessary-external-linkage.rst

HerrCai0907 · 2024-05-04T13:48:10Z

The auto-fix should be configurable to choose static or anonymous namespace.

Should I implement auto-fix for this check? Maybe some functions / variables will be marked incorrectly and cause link error because the coder just forget to include the header file but this check mark it as internal linkage.
WDYT? @carlosgalvezp @PiotrZSL @EugeneZelenko @SimplyDanny

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp

clang-tools-extra/docs/ReleaseNotes.rst

clang-tools-extra/docs/clang-tidy/checks/misc/use-internal-linkage.rst

carlosgalvezp · 2024-05-04T14:38:06Z

Should I implement auto-fix for this check?

As a first step we can have it without auto-fix and add that as a second step once we figure out a good way to do it.

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp

Co-authored-by: Danny Mösch <danny.moesch@icloud.com>

…7/llvm-project into new-check-mark-static

5chmidti

Regarding unit build:
google-global-names-in-headers is one of the checks that check file extensions:

llvm-project/clang-tools-extra/clang-tidy/google/GlobalNamesInHeadersCheck.cpp

Lines 42 to 44 in d33937b

    
           if (!utils::isSpellingLocInHeaderFile( 
        
                   D->getBeginLoc(), *Result.SourceManager, HeaderFileExtensions)) 
        
             return;

Nice that there is a check for this now, it looks like there are a few instances of this issue in LLVM as well.

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp

5chmidti · 2024-05-05T17:30:10Z

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp

+  if (const auto *FD = Result.Nodes.getNodeAs<FunctionDecl>("fn")) {
+    diag(FD->getLocation(), Message) << "function" << FD;
+    return;
+  }
+  if (const auto *VD = Result.Nodes.getNodeAs<VarDecl>("var")) {
+    diag(VD->getLocation(), Message) << "variable" << VD;
+    return;
+  }


Please stream SourceRanges into the diagnostics. For the FunctionDecl you could use SourceRange(FD->getBeginLoc(), FD->getTypeSpecEndLoc()), which would not highlight the body (that would be quite noisy).

It won't. It does not provide the source range, then it will only mark the begin location instead of the whole source range. The warning would be like this:

a.cpp:3:3: warning: function 'f2' can be made static or moved into an anonymous namespace to enforce internal linkage [misc-use-internal-linkage] 3 | S f2(const S &val) { return val; } | ^

PiotrZSL · 2024-05-13T18:39:55Z

The auto-fix should be configurable to choose static or anonymous namespace.

Should I implement auto-fix for this check? Maybe some functions / variables will be marked incorrectly and cause link error because the coder just forget to include the header file but this check mark it as internal linkage. WDYT? @carlosgalvezp @PiotrZSL @EugeneZelenko @SimplyDanny

YES. I used such check on a project that I work for. In short it found over an 1000 issues, manually fixing them was not an option.
I had an quick fix with adding static, and that worked fine, in some places code didn't compile so had to fix those by my self, but that was fine.

Add an option for "static / anonymous namespace", and generate fixes/hints accordingly.
You can use optional values, or enums and by default suggest one or other, and in such state you may not need to provide fixes. In other config state just provide fixes, even if that would mean wrapping every function in separate anonymous namespace or adding static. There allways can be other check or some clang-format option to merge multiple namespaces.
Do not reorder functions, and one can use other. Also static is safer as it's does not change scope, with namespace user may run into issues, but still fixes are needed. You can always mention in documentation that fixes are not perfect and manual intervention may be required. Even if check will do 80% of job, thats already huge help.

PiotrZSL

Few nits.

Missing:

more proper handling for unity files (.cpp included from .cpp)
nits
auto-fixes (any) - in worst case you can provide just fixes with static, but attaching them to notes.

PiotrZSL · 2024-05-13T18:29:16Z

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp

+    return SM.isInMainFile(L) &&
+           !utils::isSpellingLocInHeaderFile(L, SM, HeaderFileExtensions);
+  });


should be:

#source files or main file if its not a header. return utils::isSpellingLocInFile(L, SM, SourceFileExtensions) || (SM.isInMainFile(L) && !utils::isSpellingLocInFile(L, SM, HeaderFileExtensions));

isSpellingLocInHeaderFile should be renamed into isSpellingLocInFile, that "Header" is not needed in those functions.

It will match more cases which I cannot understand the code style.
e.g.

/// a.cpp void f(); // decl-1 /// b.cpp #include <a.cpp> void f() {} // decl-2

The current version will ignore this cases because decl-1 is not in main file.
But the suggestion version will catch this cases because both file is source fill extensions.

Actually I don't understand and didn't meet this code style, so I keep conservative to avoid false positive.

"because decl-1 is not in main file" but thats still source file and thats a point.

Take into account 2 use cases:

user want to run check on a header files, in such case header file will be a main file, and check wont work.

user want to run check on unity cpp, where there is single .cpp file generated by cmake that include other cpp files and those files include header files.
In both cases user should be able to do that.

You already got "allOf(isFirstDecl(), isInMainFile(HeaderFileExtensions)," and thats fine. so check should work only if first declaration is in source file (no additional header) or when declaration and definition is in header file, in such case adding static/anonymous namespace is also expected (but only if user explicitly want to run check on headers - by messing up with compile commands json for example).

I got the point. Our main disagreement is about

when declaration and definition is in header file, in such case adding static/anonymous namespace is also expected

In my opinion, we should not emit any wrong for the definition in header file. Add static in header file is dangerous and cause potential bug.

e.g.

/// a.hpp PREFIX int f() { static int a = 1; return a++; } void b(); /// a.cpp #include "a.hpp" #include <iostream> int main() { std::cout << __func__ << " " << f() << "\n"; b(); std::cout << __func__ << " " << f() << "\n"; b(); } /// b.cpp #include "a.hpp" #include <iostream> void b() { std::cout << __func__ << " " << f() << "\n"; }

if PREFIX is inline, result is 1 2 3 4.
if PREFIX is static, result is 1 2 1 2.
if PREFIX is inline static, result is 1 2 1 2.

if PREFIX is template <int>, result is 1 2 3 4.
if PREFIX is template <int> static, result is 1 2 1 2.

I'm fine for lack of fixes in header files.

what is the expected behavior for unity files? use static or not? I am a little bit confused.

simply .cpp (source files) files included from main file should be treated like main file.

As a summary
If main file include non-header file (*.inc, *.cpp, etc..), this check should treat it as main file.
Then we just need to check there are no redecl in header file.

yes, that FirstDecl stuff will work. just note that we got config for header extensions and source extensions. better would be to use source. as those .inc could be part of header files also.

I think we can recursive to find the real file of non-header file. Tracking the include chain and find the first file which includes this decl.

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp

PiotrZSL

I accept this change as it's fine for 1.0 version
Any fixed can be always done in this or new change.

…check-mark-static

PiotrZSL · 2024-06-06T11:52:18Z

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp

+    return isInMainFile(D->getLocation(),
+                        Finder->getASTContext().getSourceManager(),
+                        HeaderFileExtensions);


this isn't needed.
All you need to do is just get location and:

return SM.isInMainFile(L) || !utils::isSpellingLocInHeaderFile(L, SM, HeaderFileExtensions);

Or better add: isSpellingLocInSourceFile

Still I would just assume that if first declaration isn't in header file, then such declaration could be considered to be internal. As include for header should be there anyway.

I prefer to tolerant some false negatives instead of introducing false positives for corner cases. It is more robust to check whether all redecls are in main file. And it will not cause performance issue since most of thing only have one declaration and one definition.

The reason of using recursive algorithm is there are some code practices will use macro and inc file to avoid duplicated code. In llvm-project, it is also used widely.

llvmbot added clang-tools-extra clang-tidy labels May 2, 2024

HerrCai0907 requested a review from PiotrZSL May 2, 2024 07:46

HerrCai0907 requested review from 5chmidti and SimplyDanny May 2, 2024 07:46

HerrCai0907 force-pushed the new-check-mark-static branch from 7f42888 to ec7ddff Compare May 2, 2024 07:48

PiotrZSL requested changes May 2, 2024

View reviewed changes

clang-tools-extra/clang-tidy/readability/MarkStaticCheck.cpp Outdated Show resolved Hide resolved

clang-tools-extra/docs/clang-tidy/checks/readability/mark-static.rst Outdated Show resolved Hide resolved

SimplyDanny reviewed May 3, 2024

View reviewed changes

reformat

24cbbd0

HerrCai0907 force-pushed the new-check-mark-static branch from 1bb5ed2 to 24cbbd0 Compare May 4, 2024 13:54

rename to misc-use-internal-linkage

fb55ca3

EugeneZelenko reviewed May 4, 2024

View reviewed changes

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp Outdated Show resolved Hide resolved

clang-tools-extra/docs/ReleaseNotes.rst Outdated Show resolved Hide resolved

clang-tools-extra/docs/clang-tidy/checks/misc/use-internal-linkage.rst Outdated Show resolved Hide resolved

fix

f8fe43f

HerrCai0907 force-pushed the new-check-mark-static branch from 329d6ea to f8fe43f Compare May 4, 2024 15:09

HerrCai0907 changed the title ~~[clang-tidy] new check readability-mark-static~~ [clang-tidy] new check misc-use-internal-linkage May 4, 2024

SimplyDanny approved these changes May 4, 2024

View reviewed changes

clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp Outdated Show resolved Hide resolved

HerrCai0907 and others added 3 commits May 4, 2024 23:44

Update clang-tools-extra/clang-tidy/misc/UseInternalLinkageCheck.cpp

91a798f

Co-authored-by: Danny Mösch <danny.moesch@icloud.com>

fix doc

3b3dda3

Merge branch 'new-check-mark-static' of https://github.com/HerrCai090…

d940f5b

…7/llvm-project into new-check-mark-static

HerrCai0907 requested a review from PiotrZSL May 5, 2024 04:50

5chmidti reviewed May 5, 2024

View reviewed changes

HerrCai0907 added 2 commits May 7, 2024 00:04

fix comments

eda2fad

fix

a67b602

PiotrZSL reviewed May 13, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into new-check-mark-static

65e11fa

HerrCai0907 requested a review from PiotrZSL May 15, 2024 09:28

Merge branch 'main' into new-check-mark-static

11544d6

PiotrZSL approved these changes Jun 5, 2024

View reviewed changes

HerrCai0907 added 2 commits June 6, 2024 18:10

Merge branch 'main' of https://github.com/llvm/llvm-project into new-…

82c274d

…check-mark-static

Recursive search for include files in non-header files

25f7d64

PiotrZSL reviewed Jun 6, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[clang-tidy] new check misc-use-internal-linkage #90830

[clang-tidy] new check misc-use-internal-linkage #90830

HerrCai0907 commented May 2, 2024 •

edited

llvmbot commented May 2, 2024 •

edited

PiotrZSL left a comment

HerrCai0907 commented May 2, 2024

firewave commented May 2, 2024

PiotrZSL commented May 2, 2024

PiotrZSL commented May 2, 2024

EugeneZelenko commented May 2, 2024

carlosgalvezp commented May 2, 2024 •

edited

github-actions bot commented May 3, 2024 •

edited

HerrCai0907 commented May 4, 2024

carlosgalvezp commented May 4, 2024

5chmidti left a comment

5chmidti May 5, 2024

HerrCai0907 May 6, 2024

PiotrZSL commented May 13, 2024

PiotrZSL left a comment

PiotrZSL May 13, 2024

HerrCai0907 May 14, 2024

PiotrZSL May 21, 2024

HerrCai0907 May 24, 2024

PiotrZSL May 28, 2024

HerrCai0907 Jun 4, 2024

PiotrZSL Jun 4, 2024

HerrCai0907 Jun 5, 2024

PiotrZSL Jun 5, 2024

HerrCai0907 Jun 6, 2024

PiotrZSL left a comment

PiotrZSL Jun 6, 2024

PiotrZSL Jun 6, 2024

HerrCai0907 Jun 6, 2024

HerrCai0907 Jun 6, 2024

	if (!utils::isSpellingLocInHeaderFile(
	D->getBeginLoc(), *Result.SourceManager, HeaderFileExtensions))
	return;

[clang-tidy] new check misc-use-internal-linkage #90830

Are you sure you want to change the base?

[clang-tidy] new check misc-use-internal-linkage #90830

Conversation

HerrCai0907 commented May 2, 2024 • edited

llvmbot commented May 2, 2024 • edited

PiotrZSL left a comment

Choose a reason for hiding this comment

HerrCai0907 commented May 2, 2024

firewave commented May 2, 2024

PiotrZSL commented May 2, 2024

PiotrZSL commented May 2, 2024

EugeneZelenko commented May 2, 2024

carlosgalvezp commented May 2, 2024 • edited

github-actions bot commented May 3, 2024 • edited

HerrCai0907 commented May 4, 2024

carlosgalvezp commented May 4, 2024

5chmidti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PiotrZSL commented May 13, 2024

PiotrZSL left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PiotrZSL left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HerrCai0907 commented May 2, 2024 •

edited

llvmbot commented May 2, 2024 •

edited

carlosgalvezp commented May 2, 2024 •

edited

github-actions bot commented May 3, 2024 •

edited