1. Patchew
  2. linux
  3. [PATCH RESEND v6 0/2] codingstyle: avoid unused parameters for a function-like macro
  4. View patch

[PATCH RESEND v6 2/2] scripts: checkpatch: check unused parameters for function-like macro

Barry Song posted 2 patches 1 year, 7 months ago
There is a newer version of this series
[PATCH RESEND v6 2/2] scripts: checkpatch: check unused parameters for function-like macro
Posted by Barry Song 1 year, 7 months ago 
From: Xining Xu <mac.xxn@outlook.com>

If function-like macros do not utilize a parameter, it might result in a
build warning.  In our coding style guidelines, we advocate for utilizing
static inline functions to replace such macros.  This patch verifies
compliance with the new rule.

For a macro such as the one below,

 #define test(a) do { } while (0)

The test result is as follows.

 WARNING: Argument 'a' is not used in function-like macro
 #21: FILE: mm/init-mm.c:20:
 +#define test(a) do { } while (0)

 total: 0 errors, 1 warnings, 8 lines checked

Signed-off-by: Xining Xu <mac.xxn@outlook.com>
Tested-by: Barry Song <v-songbaohua@oppo.com>
Signed-off-by: Barry Song <v-songbaohua@oppo.com>
Cc: Chris Zankel <chris@zankel.net>
Cc: Huacai Chen <chenhuacai@loongson.cn>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Mark Brown <broonie@kernel.org>
Cc: Andy Whitcroft <apw@canonical.com>
Cc: Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc: Joe Perches <joe@perches.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: Max Filippov <jcmvbkbc@gmail.com>
Cc: Jeff Johnson <quic_jjohnson@quicinc.com>
Cc: Charlemagne Lasse <charlemagnelasse@gmail.com>
---
 Documentation/dev-tools/checkpatch.rst | 14 ++++++++++++++
 scripts/checkpatch.pl                  |  6 ++++++
 2 files changed, 20 insertions(+)

diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index 127968995847..a9fac978a525 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -906,6 +906,20 @@ Macros, Attributes and Symbols
 
     See: https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/
 
+  **MACRO_ARG_UNUSED**
+    If function-like macros do not utilize a parameter, it might result
+    in a build warning. We advocate for utilizing static inline functions
+    to replace such macros.
+    For example, for a macro such as the one below::
+
+      #define test(a) do { } while (0)
+
+    there would be a warning like below::
+
+      WARNING: Argument 'a' is not used in function-like macro.
+
+    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl
+
   **SINGLE_STATEMENT_DO_WHILE_MACRO**
     For the multi-statement macros, it is necessary to use the do-while
     loop to avoid unpredictable code paths. The do-while loop helps to
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 9c4c4a61bc83..9895d7e38a9f 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -6040,6 +6040,12 @@ sub process {
 					CHK("MACRO_ARG_PRECEDENCE",
 					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
 				}
+
+# check if this is an unused argument
+				if ($define_stmt !~ /\b$arg\b/) {
+					WARN("MACRO_ARG_UNUSED",
+						"Argument '$arg' is not used in function-like macro\n" . "$herectx");
+				}
 			}
 
 # check for macros with flow control, but without ## concatenation
-- 
2.34.1
Re: [PATCH RESEND v6 2/2] scripts: checkpatch: check unused parameters for function-like macro
Posted by Joe Perches 1 year, 7 months ago 
On Mon, 2024-05-06 at 13:46 +1200, Barry Song wrote:
> From: Xining Xu <mac.xxn@outlook.com>
> 
> If function-like macros do not utilize a parameter, it might result in a
> build warning.  In our coding style guidelines, we advocate for utilizing
> static inline functions to replace such macros.  This patch verifies
> compliance with the new rule.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -6040,6 +6040,12 @@ sub process {
>  					CHK("MACRO_ARG_PRECEDENCE",
>  					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
>  				}
> +
> +# check if this is an unused argument
> +				if ($define_stmt !~ /\b$arg\b/) {
> +					WARN("MACRO_ARG_UNUSED",
> +						"Argument '$arg' is not used in function-like macro\n" . "$herectx");

trivia:  This should be aligned to the open parenthesis.

Otherwise:
Acked-by: Joe Perches <joe@perches.com>
Re: [PATCH RESEND v6 2/2] scripts: checkpatch: check unused parameters for function-like macro
Posted by Barry Song 1 year, 7 months ago 
>> From: Xining Xu <mac.xxn@outlook.com>
>> 
>> If function-like macros do not utilize a parameter, it might result in a
>> build warning.  In our coding style guidelines, we advocate for utilizing
>> static inline functions to replace such macros.  This patch verifies
>> compliance with the new rule.
> []
>> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> []
>> @@ -6040,6 +6040,12 @@ sub process {
>>  					CHK("MACRO_ARG_PRECEDENCE",
>>  					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
>>  				}
>> +
>> +# check if this is an unused argument
>> +				if ($define_stmt !~ /\b$arg\b/) {
>> +					WARN("MACRO_ARG_UNUSED",
>> +						"Argument '$arg' is not used in function-like macro\n" . "$herectx");
> 
> trivia:  This should be aligned to the open parenthesis.
> 

Hi Joe,
I assume you mean the below?

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 9895d7e38a9f..2b812210b412 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -6044,7 +6044,7 @@ sub process {
 # check if this is an unused argument
 				if ($define_stmt !~ /\b$arg\b/) {
 					WARN("MACRO_ARG_UNUSED",
-						"Argument '$arg' is not used in function-like macro\n" . "$herectx");
+					     "Argument '$arg' is not used in function-like macro\n" . "$herectx");
 				}
 			}
> Otherwise:
> Acked-by: Joe Perches <joe@perches.com>

Thanks!

-Barry
Re: [PATCH RESEND v6 2/2] scripts: checkpatch: check unused parameters for function-like macro
Posted by Joe Perches 1 year, 7 months ago 
On Mon, 2024-05-06 at 19:16 +1200, Barry Song wrote:
> > > From: Xining Xu <mac.xxn@outlook.com>
> > > 
> > > If function-like macros do not utilize a parameter, it might result in a
> > > build warning.  In our coding style guidelines, we advocate for utilizing
> > > static inline functions to replace such macros.  This patch verifies
> > > compliance with the new rule.
> > []
> > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > []
> > > @@ -6040,6 +6040,12 @@ sub process {
> > >  					CHK("MACRO_ARG_PRECEDENCE",
> > >  					    "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
> > >  				}
> > > +
> > > +# check if this is an unused argument
> > > +				if ($define_stmt !~ /\b$arg\b/) {
> > > +					WARN("MACRO_ARG_UNUSED",
> > > +						"Argument '$arg' is not used in function-like macro\n" . "$herectx");
> > 
> > trivia:  This should be aligned to the open parenthesis.
> > 
> 
> Hi Joe,
> I assume you mean the below?
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 9895d7e38a9f..2b812210b412 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -6044,7 +6044,7 @@ sub process {
>  # check if this is an unused argument
>  				if ($define_stmt !~ /\b$arg\b/) {
>  					WARN("MACRO_ARG_UNUSED",
> -						"Argument '$arg' is not used in function-like macro\n" . "$herectx");
> +					     "Argument '$arg' is not used in function-like macro\n" . "$herectx");
>  				}
>  			}
> > Otherwise:
> > Acked-by: Joe Perches <joe@perches.com>

Yes, but please send a v7 instead of a separate patch
to akpm or perhaps Andrew could combine them or fix it
when applying v6

Patchew 2.1-devel-b67e4c2

© 2016 - 2025 Red Hat, Inc.