Skip to content

Commit b1be584

Browse files
Xining Xuakpm00
Xining Xu
authored andcommitted
scripts: checkpatch: check unused parameters for function-like macro
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 torvalds#21: FILE: mm/init-mm.c:20: +#define test(a) do { } while (0) total: 0 errors, 1 warnings, 8 lines checked Link: https://lkml.kernel.org/r/20240507032757.146386-3-21cnbao@gmail.com 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> Acked-by: Joe Perches <joe@perches.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: 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> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
1 parent 6813216 commit b1be584

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

Documentation/dev-tools/checkpatch.rst

+14
Original file line numberDiff line numberDiff line change
@@ -906,6 +906,20 @@ Macros, Attributes and Symbols
906906

907907
See: https://lore.kernel.org/lkml/1399671106.2912.21.camel@joe-AO725/
908908

909+
**MACRO_ARG_UNUSED**
910+
If function-like macros do not utilize a parameter, it might result
911+
in a build warning. We advocate for utilizing static inline functions
912+
to replace such macros.
913+
For example, for a macro such as the one below::
914+
915+
#define test(a) do { } while (0)
916+
917+
there would be a warning like below::
918+
919+
WARNING: Argument 'a' is not used in function-like macro.
920+
921+
See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl
922+
909923
**SINGLE_STATEMENT_DO_WHILE_MACRO**
910924
For the multi-statement macros, it is necessary to use the do-while
911925
loop to avoid unpredictable code paths. The do-while loop helps to

scripts/checkpatch.pl

+6
Original file line numberDiff line numberDiff line change
@@ -6040,6 +6040,12 @@ sub process {
60406040
CHK("MACRO_ARG_PRECEDENCE",
60416041
"Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
60426042
}
6043+
6044+
# check if this is an unused argument
6045+
if ($define_stmt !~ /\b$arg\b/) {
6046+
WARN("MACRO_ARG_UNUSED",
6047+
"Argument '$arg' is not used in function-like macro\n" . "$herectx");
6048+
}
60436049
}
60446050

60456051
# check for macros with flow control, but without ## concatenation

0 commit comments

Comments
 (0)