From: Masahiro Yamada <yamada.masahiro@socionext.com>
To: Wen Yang <wen.yang99@zte.com.cn>
Cc: wang.yi59@zte.com.cn, Michal Marek <michal.lkml@markovi.net>,
Wen Yang <yellowriver2010@hotmail.com>,
Nicolas Palix <nicolas.palix@imag.fr>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Markus.Elfring@web.de, cheng.shengyu@zte.com.cn,
cocci@systeme.lip6.fr
Subject: Re: [Cocci] [PATCH v5] coccinelle: semantic code search for missing put_device()
Date: Sun, 17 Mar 2019 12:54:31 +0900 [thread overview]
Message-ID: <CAK7LNASzd=bL1H34w-E_UD9x6w2=ObyS+EPDZ_jrvfV+ncw-yA@mail.gmail.com> (raw)
In-Reply-To: <1550217319-40418-1-git-send-email-wen.yang99@zte.com.cn>
On Sat, Feb 16, 2019 at 12:35 AM Wen Yang <wen.yang99@zte.com.cn> wrote:
>
> The of_find_device_by_node() takes a reference to the underlying device
> structure, we should release that reference.
> The implementation of this semantic code search is:
> In a function, for a local variable returned by calling
> of_find_device_by_node(),
> a, if it is released by a function such as
> put_device()/of_dev_put()/platform_device_put() after the last use,
> it is considered that there is no reference leak;
> b, if it is passed back to the caller via
> dev_get_drvdata()/platform_get_drvdata()/get_device(), etc., the
> reference will be released in other functions, and the current function
> also considers that there is no reference leak;
> c, for the rest of the situation, the current function should release the
> reference by calling put_device, this code search will report the
> corresponding error message.
>
> By using this semantic code search, we have found some object reference leaks,
> such as:
> commit 11907e9d3533 ("ASoC: fsl-asoc-card: fix object reference leaks in
> fsl_asoc_card_probe")
> commit a12085d13997 ("mtd: rawnand: atmel: fix possible object reference leak")
> commit 11493f26856a ("mtd: rawnand: jz4780: fix possible object reference leak")
>
> There are still dozens of reference leaks in the current kernel code.
>
> Further, for the case of b, the object returned to other functions may also
> have a reference leak, we will continue to develop other cocci scripts to
> further check the reference leak.
>
> Signed-off-by: Wen Yang <wen.yang99@zte.com.cn>
> Reviewed-by: Julia Lawall <Julia.Lawall@lip6.fr>
> Reviewed-by: Markus Elfring <Markus.Elfring@web.de>
> Cc: Julia Lawall <Julia.Lawall@lip6.fr>
> Cc: Gilles Muller <Gilles.Muller@lip6.fr>
> Cc: Nicolas Palix <nicolas.palix@imag.fr>
> Cc: Michal Marek <michal.lkml@markovi.net>
> Cc: Markus Elfring <Markus.Elfring@web.de>
> Cc: Masahiro Yamada <yamada.masahiro@socionext.com>
> Cc: Wen Yang <yellowriver2010@hotmail.com>
> Cc: cheng.shengyu@zte.com.cn
> Cc: cocci@systeme.lip6.fr
> Cc: linux-kernel@vger.kernel.org
Applied to linux-kbuild. Thanks.
> ---
> v5->v4:
> - exchange the word “patch” by “code search”
> - add a SPDX identifierfix
> - a split string literal can be unwanted.
> - Change the content of the reported information.
> v4->v3:
> - add Masahiro Yamada
> - omit a blank line
> - split the long message parameter
> - reduce the number of metavariables
> - Describe the implementation of the semantic patch,
> explain the scenarios it can detect,
> and further software development considerations.
> v3->v2:
> - reduction of a bit of redundant C code within SmPL search specifications.
> - consider the message construction without using the extra Python variable “msg”
> v2->v1:
> - put exists after search, and then drop the when exists below.
> - should not use the same e as in the when's below.
> - Make a new type metavariable and use it to put a cast on the result of
> platform_get_drvdata.
>
> scripts/coccinelle/free/put_device.cocci | 56 ++++++++++++++++++++++++++++++++
> 1 file changed, 56 insertions(+)
> create mode 100644 scripts/coccinelle/free/put_device.cocci
>
> diff --git a/scripts/coccinelle/free/put_device.cocci b/scripts/coccinelle/free/put_device.cocci
> new file mode 100644
> index 0000000..7395697
> --- /dev/null
> +++ b/scripts/coccinelle/free/put_device.cocci
> @@ -0,0 +1,56 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/// Find missing put_device for every of_find_device_by_node.
> +///
> +// Confidence: Moderate
> +// Copyright: (C) 2018-2019 Wen Yang, ZTE.
> +// Comments:
> +// Options: --no-includes --include-headers
> +
> +virtual report
> +virtual org
> +
> +@search exists@
> +local idexpression id;
> +expression x,e,e1;
> +position p1,p2;
> +type T,T1,T2,T3;
> +@@
> +
> +id = of_find_device_by_node@p1(x)
> +... when != e = id
> +if (id == NULL || ...) { ... return ...; }
> +... when != put_device(&id->dev)
> + when != platform_device_put(id)
> + when != of_dev_put(id)
> + when != if (id) { ... put_device(&id->dev) ... }
> + when != e1 = (T)id
> + when != e1 = &id->dev
> + when != e1 = get_device(&id->dev)
> + when != e1 = (T1)platform_get_drvdata(id)
> +(
> + return
> +( id
> +| (T2)dev_get_drvdata(&id->dev)
> +| (T3)platform_get_drvdata(id)
> +);
> +| return@p2 ...;
> +)
> +
> +@script:python depends on report@
> +p1 << search.p1;
> +p2 << search.p2;
> +@@
> +
> +coccilib.report.print_report(p2[0], "ERROR: missing put_device; "
> + + "call of_find_device_by_node on line "
> + + p1[0].line
> + + ", but without a corresponding object release "
> + + "within this function.")
> +
> +@script:python depends on org@
> +p1 << search.p1;
> +p2 << search.p2;
> +@@
> +
> +cocci.print_main("of_find_device_by_node", p1)
> +cocci.print_secs("needed put_device", p2)
> --
> 2.9.5
>
--
Best Regards
Masahiro Yamada
_______________________________________________
Cocci mailing list
Cocci@systeme.lip6.fr
https://systeme.lip6.fr/mailman/listinfo/cocci
next prev parent reply other threads:[~2019-03-17 4:12 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <1550217319-40418-1-git-send-email-wen.yang99@zte.com.cn>
2019-02-15 9:10 ` [Cocci] [PATCH v5] coccinelle: semantic code search for missing put_device() Markus Elfring
2019-02-15 12:52 ` [Cocci] [PATCH v5] Coccinelle: " Markus Elfring
2019-02-15 13:02 ` Julia Lawall
2019-02-15 13:15 ` [Cocci] [v5] " Markus Elfring
2019-02-15 13:15 ` Markus Elfring
2019-02-15 13:24 ` Julia Lawall
2019-02-15 13:54 ` Markus Elfring
2019-03-17 3:54 ` Masahiro Yamada [this message]
2019-03-17 9:05 ` [Cocci] [v5] coccinelle: " Markus Elfring
2019-03-23 16:17 ` Markus Elfring
2019-03-26 6:54 ` Masahiro Yamada
2019-03-26 7:19 ` Julia Lawall
2019-03-26 9:14 ` Markus Elfring
2019-03-26 9:04 ` Markus Elfring
2019-03-26 9:52 ` Masahiro Yamada
2019-03-26 9:58 ` Julia Lawall
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='CAK7LNASzd=bL1H34w-E_UD9x6w2=ObyS+EPDZ_jrvfV+ncw-yA@mail.gmail.com' \
--to=yamada.masahiro@socionext.com \
--cc=Markus.Elfring@web.de \
--cc=cheng.shengyu@zte.com.cn \
--cc=cocci@systeme.lip6.fr \
--cc=linux-kernel@vger.kernel.org \
--cc=michal.lkml@markovi.net \
--cc=nicolas.palix@imag.fr \
--cc=wang.yi59@zte.com.cn \
--cc=wen.yang99@zte.com.cn \
--cc=yellowriver2010@hotmail.com \
/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: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).