misc: Add gen-compile-commands.py for code analysis #1756

honggyukim · 2023-07-10T13:04:06Z

This patch adds gen-compile-commands.py script that generates compile_commands.json, which is a JSON Compilation Database Format Specification[1].

This compile_commands.json can be used by static analysis tools such as clang-tidy[2] for advanced diagnosis or lintting.

The usage is as follows.

  $ ./configure

  $ make clean    # To print build commands for all source files.
  $ ./misc/gen-compile-commands.py
  (... compile_commands.json generated ...)

  $ run-clang-tidy

[1] https://clang.llvm.org/docs/JSONCompilationDatabase.html
[2] https://clang.llvm.org/extra/clang-tidy
Signed-off-by: Honggyu Kim honggyu.kp@gmail.com

honggyukim · 2023-07-10T13:12:19Z

You can see that the second patch is based on the automatic fix by clang-tidy. It's just show an example. I will drop the second patch before merging this PR.

honggyukim · 2023-07-10T13:15:22Z

There are many useful checkers in clang-tidy.
https://clang.llvm.org/docs/analyzer/checkers.html

namhyung

The changes in the second commit are too many so I don't know which one is meaningful. It'd be nice if we can control clang-tidy what to report.

namhyung · 2023-07-16T02:48:00Z

misc/gen-compile-commands.py

+    lines = do_dry_make()
+    for line in lines:
+        command = line
+        if command[:3] != 'gcc':


Why do you need this? I guess you wanted clang as well, no?

I've added a comment as follows.

We're only interested in compilation commands so skip otherwise.

honggyukim · 2023-08-11T15:43:14Z

The changes in the second commit are too many so I don't know which one is meaningful. It'd be nice if we can control clang-tidy what to report.

The second commit was to give you an idea what kind of changes can be made by clang-tidy. I've just dropped it and left only the compile_commands.json generation script.

You can still see what kind of warnings can be shown by running run-clang-tidy. We can set up only the checkers we're interested in at .clang-tidy.

You can take a look at the following as references.

This patch adds gen-compile-commands.py script that generates compile_commands.json, which is a JSON Compilation Database Format Specification[1]. This compile_commands.json can be used by static analysis tools such as clang-tidy[2] for advanced diagnosis or lintting. The usage is as follows. $ ./configure $ make clean # To print build commands for all source files. $ ./misc/gen-compile-commands.py (... compile_commands.json generated ...) $ run-clang-tidy [1] https://clang.llvm.org/docs/JSONCompilationDatabase.html [2] https://clang.llvm.org/extra/clang-tidy Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>

honggyukim · 2023-08-15T09:37:04Z

I've added one more commit that applies readability-non-const-parameter checker for reference.

I'm fine to drop the second commit. It's just to give an idea what clang-tidy can do.

This patch applies automatic fixes by running the following clang-tidy command. $ run-clang-tidy -fix -checks='-*,readability-non-const-parameter' A few of manual modification are also applied to make const correctness. Link: https://clang.llvm.org/extra/clang-tidy/checks/readability/non-const-parameter.html Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>

This patch applies automatic fixes by running the following clang-tidy command. $ run-clang-tidy -fix -checks='-*,readability-isolate-declaration' Link: https://clang.llvm.org/extra/clang-tidy/checks/readability/isolate-declaration.html Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>

This patch applies automatic fixes by running the following clang-tidy command. $ run-clang-tidy -fix -checks='-*,readability-else-after-return' Link: https://clang.llvm.org/extra/clang-tidy/checks/readability/else-after-return.html Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>

… checker This patch applies automatic fixes by a checker to catch inconsistent declaration parameter name by running the following command. $ run-clang-tidy -fix -checks='-*,readability-inconsistent-declaration-parameter-name' Link: https://clang.llvm.org/extra/clang-tidy/checks/readability/inconsistent-declaration-parameter-name.html Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>

This patch applies automatic fixes by running the following clang-tidy command. $ run-clang-tidy -fix -checks='-*,readability-redundant-declaration' Link: https://clang.llvm.org/extra/clang-tidy/checks/readability/redundant-declaration.html Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>

This patch applies automatic fixes by running the following clang-tidy command. $ run-clang-tidy -fix -checks='-*,bugprone-macro-parentheses' Link: https://clang.llvm.org/extra/clang-tidy/checks/bugprone/macro-parentheses.html Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>

This patch applies automatic fixes by running the following clang-tidy command. $ run-clang-tidy -fix -checks='-*,bugprone-suspicious-string-compare' Link: https://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-string-compare.html Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>

honggyukim · 2023-08-15T12:49:26Z

I've just added a few more commits that applies each clang-tidy checkers.

namhyung

Is it possible to disable clang-tidy in some specific code?

namhyung · 2023-08-30T05:56:17Z

.clang-tidy

@@ -1,3 +1,4 @@
 Checks: >-
    -*,
    readability-non-const-parameter,
+    readability-isolate-declaration,


Not sure if it's worth.

Ack. I will remove it.

namhyung · 2023-08-30T06:00:43Z

.clang-tidy

@@ -6,3 +6,4 @@ Checks: >-
    readability-inconsistent-declaration-parameter-name,
    readability-redundant-declaration,
    bugprone-macro-parentheses,
+    bugprone-suspicious-string-compare,


I don't think it's better. :(

Ack. will remove it as well.

honggyukim

Is it possible to disable clang-tidy in some specific code?

Yes, we can ignore clang-tidy warning as follows.

If a specific suppression mechanism is not available for a certain warning, or its use is not desired for some reason, clang-tidy has a generic mechanism to suppress diagnostics using NOLINT, NOLINTNEXTLINE, and NOLINTBEGIN … NOLINTEND comments.

https://clang.llvm.org/extra/clang-tidy/#suppressing-undesired-diagnostics

honggyukim · 2023-09-02T00:53:51Z

.clang-tidy

@@ -1,3 +1,4 @@
 Checks: >-
    -*,
    readability-non-const-parameter,
+    readability-isolate-declaration,


Ack. I will remove it.

honggyukim · 2023-09-02T00:54:04Z

.clang-tidy

@@ -6,3 +6,4 @@ Checks: >-
    readability-inconsistent-declaration-parameter-name,
    readability-redundant-declaration,
    bugprone-macro-parentheses,
+    bugprone-suspicious-string-compare,


Ack. will remove it as well.

namhyung reviewed Jul 16, 2023

View reviewed changes

honggyukim force-pushed the check/gen-compile-commands.py branch from 3376704 to 16fcbf2 Compare August 11, 2023 15:37

honggyukim force-pushed the check/gen-compile-commands.py branch from 16fcbf2 to f9a29d0 Compare August 15, 2023 09:34

honggyukim added 7 commits August 15, 2023 21:42

honggyukim force-pushed the check/gen-compile-commands.py branch from f9a29d0 to 87aac06 Compare August 15, 2023 12:48

honggyukim mentioned this pull request Aug 28, 2023

Generating compile_commands.json for clang-tidy #1755

Open

namhyung reviewed Aug 30, 2023

View reviewed changes

honggyukim commented Sep 2, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

misc: Add gen-compile-commands.py for code analysis #1756

misc: Add gen-compile-commands.py for code analysis #1756

honggyukim commented Jul 10, 2023

honggyukim commented Jul 10, 2023

honggyukim commented Jul 10, 2023

namhyung left a comment

namhyung Jul 16, 2023

honggyukim Aug 11, 2023

honggyukim commented Aug 11, 2023

honggyukim commented Aug 15, 2023

honggyukim commented Aug 15, 2023

namhyung left a comment

namhyung Aug 30, 2023

honggyukim Sep 2, 2023

namhyung Aug 30, 2023

honggyukim Sep 2, 2023

honggyukim left a comment

honggyukim Sep 2, 2023

honggyukim Sep 2, 2023

misc: Add gen-compile-commands.py for code analysis #1756

Are you sure you want to change the base?

misc: Add gen-compile-commands.py for code analysis #1756

Conversation

honggyukim commented Jul 10, 2023

honggyukim commented Jul 10, 2023

honggyukim commented Jul 10, 2023

namhyung left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

honggyukim commented Aug 11, 2023

honggyukim commented Aug 15, 2023

honggyukim commented Aug 15, 2023

namhyung 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

honggyukim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment