coccinelle: misc: add uninitialized_var.cocci script
Subsystems (2)
RFC PATCH 1/1 coccinelle: misc: add uninitialized_var.cocci script
Commit 63a0895d960a ("compiler: Remove uninitialized_var() macro") and commit 4b19bec97c88 ("docs: deprecated.rst: Add uninitialized_var()") removed uninitialized_var() and deprecated it.
The purpose of this script is to prevent new occurrences of open-coded variants of uninitialized_var().
---
List of warnings:
./lib/glob.c:48:31-39: WARNING: this kind of initialization is deprecated ./tools/testing/selftests/vm/userfaultfd.c:349:15-22: WARNING: this kind of initialization is deprecated ./drivers/block/drbd/drbd_vli.h:330:5-9: WARNING: this kind of initialization is deprecated ./drivers/char/hw_random/intel-rng.c:333:15-18: WARNING: this kind of initialization is deprecated ./drivers/gpu/drm/nouveau/nvkm/subdev/instmem/nv50.c:316:7-10: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:455:15-20: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:455:30-35: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:455:45-50: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:475:15-20: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:475:30-35: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:476:2-7: WARNING: this kind of initialization isdeprecated ./arch/x86/include/asm/paravirt_types.h:476:17-22: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:476:32-37: WARNING: this kind of initialization is deprecated
.../coccinelle/misc/uninitialized_var.cocci | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 scripts/coccinelle/misc/uninitialized_var.cocci
scripts/coccinelle/misc/uninitialized_var.cocci new file +51 -0
@@ -0,0 +1,51 @@ +// SPDX-License-Identifier: GPL-2.0-only +/// +/// uninitialized_var() and its open-coded variations are +/// deprecated. For details, see: +/// Documentation/process/deprecated.rst +/// +// Confidence: High +// Copyright: (C) 2020 Denis Efremov ISPRAS +// Options: --no-includes --include-headers +// + +virtual context +virtual report +virtual org + +@r@ +identifier var; +type T; +position p; +@@ + +( +* T var@p = var; +| +* T var@p = *(&(var)); +//| +// TODO: Actually, I'm not sure about this pattern. +// Looks like it's used in wireless drivers to determine +// whether data belongs to the driver or not. +// Here are all matches: +// https://elixir.bootlin.com/linux/latest/source/net/mac802154/util.c#L14 +// https://elixir.bootlin.com/linux/latest/source/drivers/staging/wlan-ng/cfg80211.c#L48 +// https://elixir.bootlin.com/linux/latest/source/drivers/net/wireless/intersil/orinoco/cfg.c#L21 +// https://elixir.bootlin.com/linux/latest/source/net/mac80211/util.c#L37 +// https://elixir.bootlin.com/linux/latest/source/drivers/net/wireless/rndis_wlan.c#L544 +// * T *var@p = &var; +) + +@script:python depends on report@ +p << r.p; +@@ + +coccilib.report.print_report(p[0], + "WARNING: this kind of initialization is deprecated") + +@script:python depends on org@ +p << r.p; +@@ + +coccilib.org.print_todo(p[0], + "WARNING: this kind of initialization is deprecated")
Signature · 1 line
2.26.2
Quoted 10 lines · Denis Efremov
Commit
63a0895d960a("compiler: Removeuninitialized_var()macro") and commit4b19bec97c88("docs:deprecated.rst: Adduninitialized_var()") removeduninitialized_var()and deprecated it.The purpose of this script is to prevent new occurrences of open-coded variants of
uninitialized_var().Cc Kees Cook <[email protected]>Cc Gustavo A. R. Silva <[email protected]>Signed-off-by Denis Efremov <[email protected]>
Applied, without the commented out part.
I only got three warnings, though. Perhaps the others have been fixed?
lib/glob.c:48:31-39: WARNING: this kind of initialization is deprecated drivers/gpu/drm/nouveau/nvkm/subdev/instmem/nv50.c:316:7-10: WARNING: this kind of initialization is deprecated tools/testing/selftests/vm/userfaultfd.c:349:15-22: WARNING: this kind of initialization is deprecated
julia
Quoted 81 lines
---
List of warnings:
./lib/glob.c:48:31-39: WARNING: this kind of initialization is deprecated ./tools/testing/selftests/vm/userfaultfd.c:349:15-22: WARNING: this kind of initialization is deprecated ./drivers/block/drbd/drbd_vli.h:330:5-9: WARNING: this kind of initialization is deprecated ./drivers/char/hw_random/intel-rng.c:333:15-18: WARNING: this kind of initialization is deprecated ./drivers/gpu/drm/nouveau/nvkm/subdev/instmem/nv50.c:316:7-10: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:455:15-20: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:455:30-35: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:455:45-50: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:475:15-20: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:475:30-35: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:476:2-7: WARNING: this kind of initialization isdeprecated ./arch/x86/include/asm/paravirt_types.h:476:17-22: WARNING: this kind of initialization is deprecated ./arch/x86/include/asm/paravirt_types.h:476:32-37: WARNING: this kind of initialization is deprecated.../coccinelle/misc/uninitialized_var.cocci | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 scripts/coccinelle/misc/uninitialized_var.cocciscripts/coccinelle/misc/uninitialized_var.cocci new file +51
-1@@ -0,0 +1,51 @@ +// SPDX-License-Identifier: GPL-2.0-only +/// +/// uninitialized_var() and its open-coded variations are +/// deprecated. For details, see: +/// Documentation/process/deprecated.rst +/// +// Confidence: High +// Copyright: (C) 2020 Denis Efremov ISPRAS +// Options: --no-includes --include-headers +// + +virtual context +virtual report +virtual org + +@r@ +identifier var; +type T; +position p; +@@ + +( +* T var@p = var; +| +* T var@p = *(&(var)); +//| +// TODO: Actually, I'm not sure about this pattern. +// Looks like it's used in wireless drivers to determine +// whether data belongs to the driver or not. +// Here are all matches: +// https://elixir.bootlin.com/linux/latest/source/net/mac802154/util.c#L14 +// https://elixir.bootlin.com/linux/latest/source/drivers/staging/wlan-ng/cfg80211.c#L48 +// https://elixir.bootlin.com/linux/latest/source/drivers/net/wireless/intersil/orinoco/cfg.c#L21 +// https://elixir.bootlin.com/linux/latest/source/net/mac80211/util.c#L37 +// https://elixir.bootlin.com/linux/latest/source/drivers/net/wireless/rndis_wlan.c#L544 +// * T *var@p = &var; +) + +@script:python depends on report@ +p << r.p; +@@ + +coccilib.report.print_report(p[0], + "WARNING: this kind of initialization is deprecated") + +@script:python depends on org@ +p << r.p; +@@ + +coccilib.org.print_todo(p[0], + "WARNING: this kind of initialization is deprecated") --2.26.2
Joe Perches
maintainerQuoted 10 lines · Julia Lawall
Quoted 6 lines · Denis Efremov
Commit
63a0895d960a("compiler: Removeuninitialized_var()macro") and commit4b19bec97c88("docs:deprecated.rst: Adduninitialized_var()") removeduninitialized_var()and deprecated it.The purpose of this script is to prevent new occurrences of open-coded variants of
uninitialized_var().
Quoted 7 lines
Quoted 3 lines
Cc Kees Cook <[email protected]>Cc Gustavo A. R. Silva <[email protected]>Signed-off-by Denis Efremov <[email protected]>Applied, without the commented out part.
I only got three warnings, though. Perhaps the others have been fixed?
uninitialized_var does not exist in -next
Julia Lawall
maintainerQuoted 15 lines · Joe Perches
Quoted 14 lines · Julia Lawall
Quoted 10 lines · Denis Efremov
Commit
63a0895d960a("compiler: Removeuninitialized_var()macro") and commit4b19bec97c88("docs:deprecated.rst: Adduninitialized_var()") removeduninitialized_var()and deprecated it.The purpose of this script is to prevent new occurrences of open-coded variants of
uninitialized_var().Cc Kees Cook <[email protected]>Cc Gustavo A. R. Silva <[email protected]>Signed-off-by Denis Efremov <[email protected]>
Quoted 5 lines
Quoted 3 lines
Applied, without the commented out part.
I only got three warnings, though. Perhaps the others have been fixed?
uninitialized_vardoes not exist in -next
OK, if it seems better, I can remove it. Out of the threee reported, one was a completely unnecessary initialization.
julia
Quoted 19 lines · Julia Lawall
Quoted 15 lines · Joe Perches
Quoted 14 lines · Julia Lawall
Quoted 10 lines · Denis Efremov
Commit
63a0895d960a("compiler: Removeuninitialized_var()macro") and commit4b19bec97c88("docs:deprecated.rst: Adduninitialized_var()") removeduninitialized_var()and deprecated it.The purpose of this script is to prevent new occurrences of open-coded variants of
uninitialized_var().Cc Kees Cook <[email protected]>Cc Gustavo A. R. Silva <[email protected]>Signed-off-by Denis Efremov <[email protected]>
Quoted 5 lines
Quoted 5 lines
Quoted 3 lines
Applied, without the commented out part.
I only got three warnings, though. Perhaps the others have been fixed?
uninitialized_vardoes not exist in -next
Yes, and this rule checks for not introducing these initializations once again.
i.e, checks for:
int a = a;
int a = *(&a);
Quoted 4 lines
OK, if it seems better, I can remove it. Out of the threee reported, one was a completely unnecessary initialization.
I would like send v2 with better description and link to the documentation because it's now available online:
https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var
Thanks,
Denis
Julia Lawall
maintainerQuoted 37 lines · Denis Efremov
Quoted 19 lines · Julia Lawall
Quoted 15 lines · Joe Perches
Quoted 14 lines · Julia Lawall
Quoted 10 lines · Denis Efremov
Commit
63a0895d960a("compiler: Removeuninitialized_var()macro") and commit4b19bec97c88("docs:deprecated.rst: Adduninitialized_var()") removeduninitialized_var()and deprecated it.The purpose of this script is to prevent new occurrences of open-coded variants of
uninitialized_var().Cc Kees Cook <[email protected]>Cc Gustavo A. R. Silva <[email protected]>Signed-off-by Denis Efremov <[email protected]>Quoted 5 lines
Quoted 5 lines
Quoted 3 lines
Applied, without the commented out part.
I only got three warnings, though. Perhaps the others have been fixed?
uninitialized_vardoes not exist in -nextYes, and this rule checks for not introducing these initializations once again.
i.e, checks for:
int a = a;
int a = *(&a);
Quoted 1 line
Quoted 7 lines
Quoted 3 lines
OK, if it seems better, I can remove it. Out of the threee reported, one was a completely unnecessary initialization.
I would like send v2 with better description and link to the documentation because it's now available online:
https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var
OK, thanks.
julia
_______________________________________________
Cocci mailing list
[email protected]
https://systeme.lip6.fr/mailman/listinfo/cocci
PATCH v2 1/1 coccinelle: misc: add uninitialized_var.cocci script
In reply to Denis EfremovCommit 63a0895d960a ("compiler: Remove uninitialized_var() macro") and commit 4b19bec97c88 ("docs: deprecated.rst: Add uninitialized_var()") removed uninitialized_var() and deprecated it.
The purpose of this script is to prevent new occurrences of open-coded variants of uninitialized_var().
---
Changes in v2:
- Documentation cited in the script's description
- kernel.org link added to the diagnostics messages
- "T *var = &var;" pattern removed
- "var =@p var", "var =@p *(&(var))" patterns added
.../coccinelle/misc/uninitialized_var.cocci | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 scripts/coccinelle/misc/uninitialized_var.cocci
scripts/coccinelle/misc/uninitialized_var.cocci new file +51 -0
@@ -0,0 +1,51 @@ +// SPDX-License-Identifier: GPL-2.0-only +/// +/// Please, don't reintroduce uninitialized_var(). +/// From Documentation/process/deprecated.rst: +/// For any compiler warnings about uninitialized variables, just add +/// an initializer. Using warning-silencing tricks is dangerous as it +/// papers over real bugs (or can in the future), and suppresses unrelated +/// compiler warnings (e.g. "unused variable"). If the compiler thinks it +/// is uninitialized, either simply initialize the variable or make compiler +/// changes. Keep in mind that in most cases, if an initialization is +/// obviously redundant, the compiler's dead-store elimination pass will make +/// sure there are no needless variable writes. +/// +// Confidence: High +// Copyright: (C) 2020 Denis Efremov ISPRAS +// Options: --no-includes --include-headers +// + +virtual context +virtual report +virtual org + +@r@ +identifier var; +type T; +position p; +@@ + +( +* T var =@p var; +| +* T var =@p *(&(var)); +| +* var =@p var +| +* var =@p *(&(var)) +) + +@script:python depends on report@ +p << r.p; +@@ + +coccilib.report.print_report(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)") + +@script:python depends on org@ +p << r.p; +@@ + +coccilib.org.print_todo(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)")
Signature · 1 line
2.26.2
Julia Lawall
maintainerQuoted 3 lines · Denis Efremov
Commit
63a0895d960a("compiler: Removeuninitialized_var()macro") and commit4b19bec97c88("docs:deprecated.rst: Adduninitialized_var()") removeduninitialized_var()and deprecated it.
I'm not really sure to understand the above. How can something that has already been removed be deprecated, since it doesn't exist any more? Maybe the commits should be mentioned in the opposite order?
Personally, I would find the sentence a lot easier to read without the commit subject lines in parentheses in the middle of it. It inspires me to just ignore the paragraph completely. I wonder if it could be allowed to just mention the commit ids in the sentence and then put the ids followed by the subject line afterwards?
julia
Quoted 79 lines
The purpose of this script is to prevent new occurrences of open-coded variants of
uninitialized_var().Cc Kees Cook <[email protected]>Cc Gustavo A. R. Silva <[email protected]>Signed-off-by Denis Efremov <[email protected]>---
Changes in v2:
- Documentation cited in the script's description
- kernel.org link added to the diagnostics messages
- "T *var = &var;" pattern removed
- "var =@p var", "var =@p *(&(var))" patterns added.../coccinelle/misc/uninitialized_var.cocci | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 scripts/coccinelle/misc/uninitialized_var.cocciscripts/coccinelle/misc/uninitialized_var.cocci new file +51
-1@@ -0,0 +1,51 @@ +// SPDX-License-Identifier: GPL-2.0-only +/// +/// Please, don't reintroduce uninitialized_var(). +/// From Documentation/process/deprecated.rst: +/// For any compiler warnings about uninitialized variables, just add +/// an initializer. Using warning-silencing tricks is dangerous as it +/// papers over real bugs (or can in the future), and suppresses unrelated +/// compiler warnings (e.g. "unused variable"). If the compiler thinks it +/// is uninitialized, either simply initialize the variable or make compiler +/// changes. Keep in mind that in most cases, if an initialization is +/// obviously redundant, the compiler's dead-store elimination pass will make +/// sure there are no needless variable writes. +/// +// Confidence: High +// Copyright: (C) 2020 Denis Efremov ISPRAS +// Options: --no-includes --include-headers +// + +virtual context +virtual report +virtual org + +@r@ +identifier var; +type T; +position p; +@@ + +( +* T var =@p var; +| +* T var =@p *(&(var)); +| +* var =@p var +| +* var =@p *(&(var)) +) + +@script:python depends on report@ +p << r.p; +@@ + +coccilib.report.print_report(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)") + +@script:python depends on org@ +p << r.p; +@@ + +coccilib.org.print_todo(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)") --2.26.2
PATCH v3 1/1 coccinelle: misc: add uninitialized_var.cocci script
In reply to Denis Efremovuninitialized_var() macro was removed from the sources [1] and other warning-silencing tricks were deprecated [2]. The purpose of this cocci script is to prevent new occurrences of uninitialized_var() open-coded variants.
[1] commit 63a0895d960a ("compiler: Remove uninitialized_var() macro")
[2] commit 4b19bec97c88 ("docs: deprecated.rst: Add uninitialized_var()")
---
Changes in v2:
- Documentation cited in the script's description
- kernel.org link added to the diagnostics messages
- "T *var = &var;" pattern removed
- "var =@p var", "var =@p *(&(var))" patterns added
Changes in v3:
- commit's description changed
.../coccinelle/misc/uninitialized_var.cocci | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 scripts/coccinelle/misc/uninitialized_var.cocci
scripts/coccinelle/misc/uninitialized_var.cocci new file +51 -0
@@ -0,0 +1,51 @@ +// SPDX-License-Identifier: GPL-2.0-only +/// +/// Please, don't reintroduce uninitialized_var(). +/// From Documentation/process/deprecated.rst: +/// For any compiler warnings about uninitialized variables, just add +/// an initializer. Using warning-silencing tricks is dangerous as it +/// papers over real bugs (or can in the future), and suppresses unrelated +/// compiler warnings (e.g. "unused variable"). If the compiler thinks it +/// is uninitialized, either simply initialize the variable or make compiler +/// changes. Keep in mind that in most cases, if an initialization is +/// obviously redundant, the compiler's dead-store elimination pass will make +/// sure there are no needless variable writes. +/// +// Confidence: High +// Copyright: (C) 2020 Denis Efremov ISPRAS +// Options: --no-includes --include-headers +// + +virtual context +virtual report +virtual org + +@r@ +identifier var; +type T; +position p; +@@ + +( +* T var =@p var; +| +* T var =@p *(&(var)); +| +* var =@p var +| +* var =@p *(&(var)) +) + +@script:python depends on report@ +p << r.p; +@@ + +coccilib.report.print_report(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)") + +@script:python depends on org@ +p << r.p; +@@ + +coccilib.org.print_todo(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)")
Signature · 1 line
2.26.2
Julia Lawall
maintainerQuoted 7 lines · Denis Efremov
uninitialized_var()macro was removed from the sources [1] and other warning-silencing tricks were deprecated [2]. The purpose of this cocci script is to prevent new occurrences ofuninitialized_var()open-coded variants.[1] commit
63a0895d960a("compiler: Removeuninitialized_var()macro")
[2] commit4b19bec97c88("docs:deprecated.rst: Adduninitialized_var()")
Thanks! I find that much more understandable.
julia
Quoted 78 lines
Cc Kees Cook <[email protected]>Cc Gustavo A. R. Silva <[email protected]>Signed-off-by Denis Efremov <[email protected]>---
Changes in v2:
- Documentation cited in the script's description
- kernel.org link added to the diagnostics messages
- "T *var = &var;" pattern removed
- "var =@p var", "var =@p *(&(var))" patterns added
Changes in v3:
- commit's description changed.../coccinelle/misc/uninitialized_var.cocci | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 scripts/coccinelle/misc/uninitialized_var.cocciscripts/coccinelle/misc/uninitialized_var.cocci new file +51
-1@@ -0,0 +1,51 @@ +// SPDX-License-Identifier: GPL-2.0-only +/// +/// Please, don't reintroduce uninitialized_var(). +/// From Documentation/process/deprecated.rst: +/// For any compiler warnings about uninitialized variables, just add +/// an initializer. Using warning-silencing tricks is dangerous as it +/// papers over real bugs (or can in the future), and suppresses unrelated +/// compiler warnings (e.g. "unused variable"). If the compiler thinks it +/// is uninitialized, either simply initialize the variable or make compiler +/// changes. Keep in mind that in most cases, if an initialization is +/// obviously redundant, the compiler's dead-store elimination pass will make +/// sure there are no needless variable writes. +/// +// Confidence: High +// Copyright: (C) 2020 Denis Efremov ISPRAS +// Options: --no-includes --include-headers +// + +virtual context +virtual report +virtual org + +@r@ +identifier var; +type T; +position p; +@@ + +( +* T var =@p var; +| +* T var =@p *(&(var)); +| +* var =@p var +| +* var =@p *(&(var)) +) + +@script:python depends on report@ +p << r.p; +@@ + +coccilib.report.print_report(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)") + +@script:python depends on org@ +p << r.p; +@@ + +coccilib.org.print_todo(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)") --2.26.2
Joe Perches
maintainercheckpatch? (was: Re: [PATCH v3] coccinelle: misc: add uninitialized_var.cocci script)
In reply to Denis EfremovQuoted 5 lines · Denis Efremov
uninitialized_var()macro was removed from the sources [1] and other warning-silencing tricks were deprecated [2]. The purpose of this cocci script is to prevent new occurrences ofuninitialized_var()open-coded variants.
Review
Quoted 9 lines
(quoted diff) +9
-0+( +* T var =@p var; +| +* T var =@p *(&(var)); +| +* var =@p var +| +* var =@p *(&(var)) +)
Adding a checkpatch test might be a good thing too.
--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)
scripts/checkpatch.pl +11 -0
@@ -3901,6 +3901,17 @@ sub process { #ignore lines not being added next if ($line =~ /^[^\+]/); +# check for self assigments used to avoid compiler warnings +# e.g.: int foo = foo, *bar = NULL; +# struct foo bar = *(&(bar)); + if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { + my $var = $1; + if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { + WARN("SELF_ASSIGNMENT", + "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); + } + } + # check for dereferences that span multiple lines if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
Re: checkpatch? (was: Re: [PATCH v3] coccinelle: misc: add uninitialized_var.cocci script)
Quoted 34 lines · Joe Perches
Quoted 5 lines · Denis Efremov
uninitialized_var()macro was removed from the sources [1] and other warning-silencing tricks were deprecated [2]. The purpose of this cocci script is to prevent new occurrences ofuninitialized_var()open-coded variants.Review
Quoted 9 lines
(quoted diff) +9
-0+( +* T var =@p var; +| +* T var =@p *(&(var)); +| +* var =@p var +| +* var =@p *(&(var)) +)Adding a checkpatch test might be a good thing too.
--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)scripts/checkpatch.pl +4
-0@@ -3901,6 +3901,17 @@ sub process { #ignore lines not being added next if ($line =~ /^[^\+]/); +# check for self assigments used to avoid compiler warnings +# e.g.: int foo = foo, *bar = NULL; +# struct foo bar = *(&(bar)); + if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
scripts/checkpatch.pl sub process { · line 3917
Quoted 10 lines
scripts/checkpatch.pl +7
-0+ my $var = $1; + if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { + WARN("SELF_ASSIGNMENT", + "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); + } + } + # check for dereferences that span multiple lines if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
Looks good. I also faced this kind of assignments after declarations.
https://lkml.org/lkml/2020/8/31/85
I'm not sure if they are used to suppress compiler warnings, through.
Denis
Quoted 11 lines · Denis Efremov
uninitialized_var()macro was removed from the sources [1] and other warning-silencing tricks were deprecated [2]. The purpose of this cocci script is to prevent new occurrences ofuninitialized_var()open-coded variants.[1] commit
63a0895d960a("compiler: Removeuninitialized_var()macro")
[2] commit4b19bec97c88("docs:deprecated.rst: Adduninitialized_var()")Cc Kees Cook <[email protected]>Cc Gustavo A. R. Silva <[email protected]>Signed-off-by Denis Efremov <[email protected]>
Applied.
julia
Quoted 74 lines
---
Changes in v2:
- Documentation cited in the script's description
- kernel.org link added to the diagnostics messages
- "T *var = &var;" pattern removed
- "var =@p var", "var =@p *(&(var))" patterns added
Changes in v3:
- commit's description changed.../coccinelle/misc/uninitialized_var.cocci | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 scripts/coccinelle/misc/uninitialized_var.cocciscripts/coccinelle/misc/uninitialized_var.cocci new file +51
-1@@ -0,0 +1,51 @@ +// SPDX-License-Identifier: GPL-2.0-only +/// +/// Please, don't reintroduce uninitialized_var(). +/// From Documentation/process/deprecated.rst: +/// For any compiler warnings about uninitialized variables, just add +/// an initializer. Using warning-silencing tricks is dangerous as it +/// papers over real bugs (or can in the future), and suppresses unrelated +/// compiler warnings (e.g. "unused variable"). If the compiler thinks it +/// is uninitialized, either simply initialize the variable or make compiler +/// changes. Keep in mind that in most cases, if an initialization is +/// obviously redundant, the compiler's dead-store elimination pass will make +/// sure there are no needless variable writes. +/// +// Confidence: High +// Copyright: (C) 2020 Denis Efremov ISPRAS +// Options: --no-includes --include-headers +// + +virtual context +virtual report +virtual org + +@r@ +identifier var; +type T; +position p; +@@ + +( +* T var =@p var; +| +* T var =@p *(&(var)); +| +* var =@p var +| +* var =@p *(&(var)) +) + +@script:python depends on report@ +p << r.p; +@@ + +coccilib.report.print_report(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)") + +@script:python depends on org@ +p << r.p; +@@ + +coccilib.org.print_todo(p[0], + "WARNING this kind of initialization is deprecated (https://www.kernel.org/doc/html/latest/process/deprecated.html#uninitialized-var)") --2.26.2
Joe Perches
maintainerPATCH 1/1 checkpatch: Warn on self-assignments
In reply to Denis EfremovThe uninitialized_var() macro was removed recently via commit 63a0895d960a ("compiler: Remove uninitialized_var() macro") as it's not a particularly useful warning and its use can "paper over real bugs".
Add a checkpatch test to warn on self-assignments as a means to avoid compiler warnings and as a back-door mechanism to reproduce the old uninitialized_var macro behavior.
--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)
scripts/checkpatch.pl +11 -0
@@ -3901,6 +3901,17 @@ sub process { #ignore lines not being added next if ($line =~ /^[^\+]/); +# check for self assigments used to avoid compiler warnings +# e.g.: int foo = foo, *bar = NULL; +# struct foo bar = *(&(bar)); + if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { + my $var = $1; + if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { + WARN("SELF_ASSIGNMENT", + "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); + } + } + # check for dereferences that span multiple lines if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
Re: [PATCH] checkpatch: Warn on self-assignments
Quoted 10 lines · Joe Perches
The
uninitialized_var()macro was removed recently via commit63a0895d960a("compiler: Removeuninitialized_var()macro") as it's not a particularly useful warning and its use can "paper over real bugs".Add a checkpatch test to warn on self-assignments as a means to avoid compiler warnings and as a back-door mechanism to reproduce the old
uninitialized_varmacro behavior.Signed-off-by Joe Perches <[email protected]>
I like it! :)
Can you add a section to code style and include a link in the checkpatch warning to it? (Feel free to just reuse the text removed from deprecated.rst)
Signature · 1 line
Kees Cook
Joe Perches
maintainerRe: [PATCH] checkpatch: Warn on self-assignments
Quoted 10 lines · Kees Cook
Quoted 9 lines · Joe Perches
The
uninitialized_var()macro was removed recently via commit63a0895d960a("compiler: Removeuninitialized_var()macro") as it's not a particularly useful warning and its use can "paper over real bugs".Add a checkpatch test to warn on self-assignments as a means to avoid compiler warnings and as a back-door mechanism to reproduce the old
uninitialized_varmacro behavior.
Quoted 7 lines
Quoted 1 line
Signed-off-by Joe Perches <[email protected]>I like it! :)
Can you add a section to code style and include a link in the checkpatch warning to it? (Feel free to just reuse the text removed from
deprecated.rst)
Hi Kees.
I believe coding style is already a bit bloated
and more rules and content really won't add much
for new developers.
You're welcome to try to add whatever you want
to it though.
cheers, Joe