[PATCH] scripts: coccinelle: add check for uncessary double unlikely() calls

[PATCH] scripts: coccinelle: add check for uncessary double unlikely() calls

[Enrico Weigelt, metux IT consult]

IS_ERR() and IS_ERR_OR_NULL()) already call unlikely(), therefore
expressions like "(unlikely(IS_ERR(foo))" or "(!likely(IS_ERR(foo))"
aren't needed.

This patch adds a coccinelle script that checks for that.

Signed-off-by: Enrico Weigelt <info@metux.net>
---
 scripts/coccinelle/api/double_unlikely.cocci | 35 ++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 scripts/coccinelle/api/double_unlikely.cocci

diff --git a/scripts/coccinelle/api/double_unlikely.cocci b/scripts/coccinelle/api/double_unlikely.cocci
new file mode 100644
index 0000000..0b9bb3b
--- /dev/null
+++ b/scripts/coccinelle/api/double_unlikely.cocci
@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: GPL-2.0
+//
+// find unncessary cases of unlikely(IS_ERR(foo))
+// IS_ERR() already calls unlikely() call
+//
+// Copyright (C) 2019 Enrico Weigelt, metux IT consult <info@metux.net>
+//
+virtual patch
+virtual context
+virtual org
+virtual report
+
+@@
+expression E;
+@@
+- unlikely(IS_ERR(E))
++ IS_ERR(E)
+
+@@
+expression E;
+@@
+- unlikely(IS_ERR_OR_NULL(E))
++ IS_ERR_OR_NULL(E)
+
+@@
+expression E;
+@@
+- likely(!IS_ERR(E))
++ !IS_ERR(E)
+
+@@
+expression E;
+@@
+- likely(!IS_ERR_OR_NULL(E))
++ !IS_ERR_OR_NULL(E)
-- 
1.9.1

Re: [PATCH] scripts: coccinelle: add check for uncessary double unlikely() calls

[Markus Elfring]

My software development attention was caught also by your proposal.

I would appreciate a message subject without a typo.


> +virtual patch
> +virtual context
> +virtual org
> +virtual report

These metavariables are not used in the subsequent code in this approach
for the semantic patch language.

Fine-tuning might become relevant also for the change specifications.
https://lore.kernel.org/lkml/1559767582-11081-1-git-send-email-info@metux.net/

Would you like to contribute an extended script version?

Regards,
Markus