Received-SPF: pass (google.com: domain of linux-kernel+bounces-121347-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Message-ID: <b1d4a52f-4dbb-48a3-be59-8e9915f21fa9@web.de>
Date: Wed, 27 Mar 2024 14:10:32 +0100
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Content-Language: en-GB
To: cocci@inria.fr, kernel-janitors@vger.kernel.org,
 Julia Lawall <Julia.Lawall@inria.fr>, Nicolas Palix <nicolas.palix@imag.fr>
Cc: LKML <linux-kernel@vger.kernel.org>
From: Markus Elfring <Markus.Elfring@web.de>
Subject: =?UTF-8?Q?=5BPATCH=5D_Coccinelle=3A_api=3A_Add_SmPL_script_?=
 =?UTF-8?B?4oCcdXNlX3JldHVybl9wdHIuY29jY2nigJ0=?=
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
UI-OutboundReport: notjunk:1;M01:P0:Y/bbGx8rh3w=;UXBewfoOnNthhQhTisIQ2qEfgqb
 tT6gbGXsn3szUoSIPIxhyztP7NEajaHuUf1X8KE7Kvz2FvzEcrPdy+iIprIZIIXY1/zLiHbKV
 BNIxTllP9bu1jZTh0DKXPkJVYGIb1P6AzDP6irHg2BzNqBfvODY1zrlDqkR0TROkElMmO0Bkg
 ZAses44mEj779kI7XDunee0tmkerXKJBcoOO0CMYWP/sBSeyhdaHosHjPjEPbgMPHubfbMBwo
 xqpY1n69ZZxayA7xM1rNpK3tPnhxKlt7GLjn1JOa7uRhroknUmcuCkVMstvUwXmYdnhiMJbd6
 ViUd+pvSRHRlsRewgT6HZY5sZxR0pEOO0PhGQijHjdvYjFdvPTKETwt1yKwNLQ3wKHx+BCmCL
 T6FpWMI4q5A55/toXjY7r27M2g73/GwoK1bJwvgaf+/WMZq7/AzbEmGnpj7DgJfskyDR/zuGk
 1R2ueSLDWmAdJ2nV9UacgIpLkhCZvOdAjqIMX1lUhcOhGzT7WN4N2f0w3OHr7VCAcyg1lhJbB
 PTsMFU4h2ss3EV5eAPXQBHRT+99IPQyLaxtxqcWWI3ET/bORItwCkgEhkwNJ8Q/g5IHQDLcMy
 evuB7YIltZnvzlrDK5XMdXJjWjCgzxr9G/c+H8rIFuKPgbYVQMIQblP87ocmTHUAz3z4qh4Q+
 4lP4K6V0JKBZpqd1JvdvJpKYa842HcReern/JhMKkWnxn6qgMrOBIMyqaJenWpECjU+wku26A
 g8SI4q/dkyl85ghlGkl7vkHrmTHjhRgUHutPrAerboglvw+F2m3aLLwGhC/8taggS5RzRaFAl
 CcvUDsQpkMsGaGqUt21rIABkIsvDwaedoY0h9JIdQxGg4=

From: Markus Elfring <elfring@users.sourceforge.net>
Date: Wed, 27 Mar 2024 13:56:03 +0100

A wrapper macro is available since the commit 54da6a0924311c7cf5015533991e=
44fb8eb12773
("locking: Introduce __cleanup() based infrastructure").
Provide design options for the adjustment of affected source code
by the means of the semantic patch language (Coccinelle software).

Signed-off-by: Markus Elfring <elfring@users.sourceforge.net>
=2D--
 scripts/coccinelle/api/use_return_ptr.cocci | 57 +++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 scripts/coccinelle/api/use_return_ptr.cocci

diff --git a/scripts/coccinelle/api/use_return_ptr.cocci b/scripts/coccine=
lle/api/use_return_ptr.cocci
new file mode 100644
index 000000000000..7b42a58cceb2
=2D-- /dev/null
+++ b/scripts/coccinelle/api/use_return_ptr.cocci
@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: GPL-2.0
+/// Simplify a return statement by using a known wrapper macro.
+//
+// Keywords: wrapper macro conversion returning objects
+// Confidence: High
+// Options: --no-includes --include-headers
+
+virtual context, patch, report, org
+
+@depends on context@
+expression e;
+@@
+ if (!e)
+    return NULL;
+ <+... when any
+*return \( e \| no_free_ptr(e) \)
+ ;
+ ...+>
+
+@depends on patch@
+expression e;
+@@
+ if (!e)
+    return NULL;
+ <+... when any
+(
+-return
++return_ptr(
+ e
++)
+ ;
+|
+-return no_free_ptr
++return_ptr
+ (e);
+)
+ ...+>
+
+@x depends on org || report@
+expression e;
+position p;
+@@
+ if (!e)
+    return NULL;
+ <+... when any
+ return@p \( e \| no_free_ptr(e) \) ;
+ ...+>
+
+@script:python depends on org@
+p << x.p;
+@@
+coccilib.org.print_todo(p[0], "WARNING: opportunity for return_ptr()")
+
+@script:python depends on report@
+p << x.p;
+@@
+coccilib.report.print_report(p[0], "WARNING: opportunity for return_ptr()=
")
=2D-
2.44.0