From: Denis Efremov <efremov@linux.com> To: julia.lawall@inria.fr Cc: Denis Efremov <efremov@linux.com>, cocci@systeme.lip6.fr, linux-kernel@vger.kernel.org, Kees Cook <keescook@chromium.org>, "Gustavo A . R . Silva" <gustavoars@kernel.org> Subject: [PATCH v2] coccinelle: misc: add uninitialized_var.cocci script Date: Tue, 1 Sep 2020 10:15:33 +0300 [thread overview] Message-ID: <20200901071533.2725-1-efremov@linux.com> (raw) In-Reply-To: <20200811210127.11889-1-efremov@linux.com> 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(). Cc: Kees Cook <keescook@chromium.org> Cc: Gustavo A. R. Silva <gustavoars@kernel.org> Signed-off-by: Denis Efremov <efremov@linux.com> --- 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 diff --git a/scripts/coccinelle/misc/uninitialized_var.cocci b/scripts/coccinelle/misc/uninitialized_var.cocci new file mode 100644 index 000000000000..8fa845cefe11 --- /dev/null +++ b/scripts/coccinelle/misc/uninitialized_var.cocci @@ -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
WARNING: multiple messages have this Message-ID (diff)
From: Denis Efremov <efremov@linux.com> To: julia.lawall@inria.fr Cc: Kees Cook <keescook@chromium.org>, "Gustavo A . R . Silva" <gustavoars@kernel.org>, cocci@systeme.lip6.fr, linux-kernel@vger.kernel.org Subject: [Cocci] [PATCH v2] coccinelle: misc: add uninitialized_var.cocci script Date: Tue, 1 Sep 2020 10:15:33 +0300 [thread overview] Message-ID: <20200901071533.2725-1-efremov@linux.com> (raw) In-Reply-To: <20200811210127.11889-1-efremov@linux.com> 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(). Cc: Kees Cook <keescook@chromium.org> Cc: Gustavo A. R. Silva <gustavoars@kernel.org> Signed-off-by: Denis Efremov <efremov@linux.com> --- 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 diff --git a/scripts/coccinelle/misc/uninitialized_var.cocci b/scripts/coccinelle/misc/uninitialized_var.cocci new file mode 100644 index 000000000000..8fa845cefe11 --- /dev/null +++ b/scripts/coccinelle/misc/uninitialized_var.cocci @@ -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 _______________________________________________ Cocci mailing list Cocci@systeme.lip6.fr https://systeme.lip6.fr/mailman/listinfo/cocci
next prev parent reply other threads:[~2020-09-01 7:15 UTC|newest] Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-08-11 21:01 [RFC PATCH] coccinelle: misc: add uninitialized_var.cocci script Denis Efremov 2020-08-11 21:01 ` [Cocci] " Denis Efremov 2020-08-29 19:36 ` Julia Lawall 2020-08-29 19:36 ` [Cocci] " Julia Lawall 2020-08-29 19:38 ` Joe Perches 2020-08-29 19:38 ` [Cocci] " Joe Perches 2020-08-29 19:48 ` Julia Lawall 2020-08-29 19:48 ` [Cocci] " Julia Lawall 2020-08-29 20:13 ` Denis Efremov 2020-08-29 20:13 ` [Cocci] " Denis Efremov 2020-08-29 20:26 ` Julia Lawall 2020-08-29 20:26 ` [Cocci] " Julia Lawall 2020-09-01 7:15 ` Denis Efremov [this message] 2020-09-01 7:15 ` [Cocci] [PATCH v2] " Denis Efremov 2020-09-01 9:06 ` Julia Lawall 2020-09-01 9:06 ` [Cocci] " Julia Lawall 2020-09-01 9:48 ` [PATCH v3] " Denis Efremov 2020-09-01 9:48 ` [Cocci] " Denis Efremov 2020-09-01 10:08 ` Julia Lawall 2020-09-01 10:08 ` [Cocci] " Julia Lawall 2020-09-01 14:37 ` checkpatch? (was: Re: [PATCH v3] coccinelle: misc: add uninitialized_var.cocci script) Joe Perches 2020-09-01 14:37 ` [Cocci] " Joe Perches 2020-09-02 5:17 ` Denis Efremov 2020-09-02 5:17 ` [Cocci] " Denis Efremov 2020-09-05 17:18 ` [PATCH v3] coccinelle: misc: add uninitialized_var.cocci script Julia Lawall 2020-09-05 17:18 ` [Cocci] " Julia Lawall 2020-09-05 17:58 ` [PATCH] checkpatch: Warn on self-assignments Joe Perches 2020-09-05 17:58 ` [Cocci] " Joe Perches 2020-09-10 19:51 ` Kees Cook 2020-09-10 19:51 ` [Cocci] " Kees Cook 2020-09-10 21:35 ` Joe Perches 2020-09-10 21:35 ` [Cocci] " Joe Perches
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20200901071533.2725-1-efremov@linux.com \ --to=efremov@linux.com \ --cc=cocci@systeme.lip6.fr \ --cc=gustavoars@kernel.org \ --cc=julia.lawall@inria.fr \ --cc=keescook@chromium.org \ --cc=linux-kernel@vger.kernel.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.