From: Schspa Shi <schspa@gmail.com> To: linux-kernel@vger.kernel.org, cocci@inria.fr, peterz@infradead.org, mcgrof@kernel.org Cc: Schspa Shi <schspa@gmail.com>, Julia Lawall <Julia.Lawall@inria.fr>, Nicolas Palix <nicolas.palix@imag.fr>, Matthias Brugger <matthias.bgg@gmail.com>, AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>, Ingo Molnar <mingo@redhat.com>, Juri Lelli <juri.lelli@redhat.com>, Vincent Guittot <vincent.guittot@linaro.org>, Dietmar Eggemann <dietmar.eggemann@arm.com>, Steven Rostedt <rostedt@goodmis.org>, Ben Segall <bsegall@google.com>, Mel Gorman <mgorman@suse.de>, Daniel Bristot de Oliveira <bristot@redhat.com>, Valentin Schneider <vschneid@redhat.com> Subject: [RFC PATCH] cocci: cpi: add complete api check script Date: Mon, 27 Feb 2023 15:53:47 +0800 [thread overview] Message-ID: <20230227075346.69658-1-schspa@gmail.com> (raw) When DECLARE_COMPLETION_ONSTACK was used, the user must to ensure the other process won't reference the completion variable on stack. For a killable/interruptiable version, we need extra code(add locks/use xchg) to ensure this. This patch provide a SmPL script to detect bad DECLARE_COMPLETION_ONSTACK(_MAP) API usage, but far from perfect. This is a common problem, and a lot of drivers have simpler problem. The fellowing is a list of problems find by this SmPL patch, due to the complex use of wait_for_complete* API, there will still be some false negatives and false positives. This RFC patch is mainly used to discuss improvement methods. If we introduce the wait_for_complete*_onstack API, it will be easier to modify these problems, and the patch rules of SmPL will be very easy. In the process of trying to write SmPL scripts, I strongly recommend introducing two onstack APIs to complete this operation. file:/Users/schspa/work/src/linux/drivers/infiniband/ulp/srpt/ib_srpt.c::2962 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/misc/tifm_7xx1.c::268 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/firmware/arm_scmi/driver.c::1001 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dispc-compat.c::595 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dispc-compat.c::491 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dispc-compat.c::538 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dispc-compat.c::645 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dsi.c::3175 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dsi.c::2360 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dsi.c::2314 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dsi.c::2634 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/gpu/drm/omapdrm/dss/dsi.c::1804 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/gpu/drm/omapdrm/dss/dsi.c::1758 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/gpu/drm/omapdrm/dss/dsi.c::2034 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/net/wireless/marvell/mwl8k.c::2259 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/net/wireless/mediatek/mt7601u/mcu.c::317 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/net/wireless/ti/wlcore/main.c::6674 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/net/wwan/t7xx/t7xx_state_monitor.c::416 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/soc/apple/rtkit.c::647 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/soc/apple/rtkit.c::653 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/soc/qcom/rpmh.c::269 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/aic94xx/aic94xx_tmf.c::339 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_ctl.c::242 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_scsi.c::1811 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_scsi.c::2266 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_scsi.c::1603 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_scsi.c::2073 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/qla2xxx/qla_os.c::1807 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/qla2xxx/qla_os.c::1328 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/ibmvscsi/ibmvfc.c::2466 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/aic7xxx/aic79xx_osm.c::844 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/aic7xxx/aic79xx_osm.c::2334 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/aic7xxx/aic7xxx_osm.c::2297 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/lpfc/lpfc_nvmet.c::2119 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/ipr.c::5153 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/scsi_error.c::1157 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/hisi_sas/hisi_sas_main.c::1215 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/hisi_sas/hisi_sas_v2_hw.c::996 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/hisi_sas/hisi_sas_v3_hw.c::867 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/isci/task.c::317 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/fnic/fnic_scsi.c::1844 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/fnic/fnic_scsi.c::2310 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/fnic/fnic_scsi.c::2086 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/fnic/fnic_scsi.c::2579 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/ufs/core/ufshcd.c::6752 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/ufs/core/ufshcd.c::4074 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/thunderbolt/ctl.c::604 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i2c/busses/i2c-hisi.c::206 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/s390/cio/vfio_ccw_drv.c::71 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/slimbus/messaging.c::154 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/slimbus/qcom-ngd-ctrl.c::894 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/slimbus/qcom-ngd-ctrl.c::932 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/slimbus/qcom-ctrl.c::377 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/usb/core/devio.c::1142 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/usb/core/hcd.c::2229 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/spi/spi-hisi-sfc-v3xx.c::337 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/bluetooth/hci_bcm4377.c::955 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/cmd_v1.c::336 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/cmd_v2.c::278 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/core.c::360 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/core.c::312 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/core.c::238 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/ata/libata-core.c::1558 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/w1/masters/ds1wm.c::285 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/w1/masters/ds1wm.c::233 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/w1/masters/ds1wm.c::262 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/lib/kunit/try-catch.c::76 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/sound/aoa/soundbus/i2sbus/pcm.c::264 was suspected to return a variable on stack To fix this, we can add introducing two new API for this. + +void complete_on_stack(struct completion **x) +{ + struct completion *comp = xchg(*x, NULL); + + if (comp) + complete(comp); +} +EXPORT_SYMBOL(complete_on_stack); + +int __sched wait_for_completion_state_on_stack(struct completion **x, + unsigned int state) +{ + struct completion *comp = *x; + int retval; + + retval = wait_for_completion_state(comp, state); + if (retval) { + if (xchg(*x, NULL)) + return retval; + + /* + * complete_on_stack will call complete shortly. + */ + wait_for_completion(comp); + } + + return retval; +} +EXPORT_SYMBOL(wait_for_completion_state_on_stack); Link: https://lore.kernel.org/all/20221115140233.21981-1-schspa@gmail.com/T/#mf6a41a7009bb47af1b15adf2b7b355e495f609c4 Link: https://lore.kernel.org/all/7d1021f1-c88e-5a03-3b92-087f9be37491@I-love.SAKURA.ne.jp/ CC: Julia Lawall <Julia.Lawall@inria.fr> CC: Nicolas Palix <nicolas.palix@imag.fr> CC: Matthias Brugger <matthias.bgg@gmail.com> CC: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com> CC: Ingo Molnar <mingo@redhat.com> CC: Peter Zijlstra <peterz@infradead.org> CC: Juri Lelli <juri.lelli@redhat.com> CC: Vincent Guittot <vincent.guittot@linaro.org> CC: Dietmar Eggemann <dietmar.eggemann@arm.com> CC: Steven Rostedt <rostedt@goodmis.org> CC: Ben Segall <bsegall@google.com> CC: Mel Gorman <mgorman@suse.de> CC: Daniel Bristot de Oliveira <bristot@redhat.com> CC: Valentin Schneider <vschneid@redhat.com> Signed-off-by: Schspa Shi <schspa@gmail.com> --- scripts/coccinelle/api/complete.cocci | 160 ++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 scripts/coccinelle/api/complete.cocci diff --git a/scripts/coccinelle/api/complete.cocci b/scripts/coccinelle/api/complete.cocci new file mode 100644 index 000000000000..d4cf32187180 --- /dev/null +++ b/scripts/coccinelle/api/complete.cocci @@ -0,0 +1,160 @@ +// SPDX-License-Identifier: GPL-2.0 +/// +// Copyright: (C) 2023 Schspa Shi. +// Confidence: High +virtual report + +@r1 exists@ +declarer name DECLARE_COMPLETION_ONSTACK; +declarer name DECLARE_COMPLETION_ONSTACK_MAP; +position p; +identifier done; +identifier func; +@@ + +func(...) { +... +( +DECLARE_COMPLETION_ONSTACK(done@p); +| +DECLARE_COMPLETION_ONSTACK_MAP(done@p, ...); +) +... +} + +@locked exists@ +identifier func=r1.func; +identifier done=r1.done; +position p1,p; +@@ + +func(...) { +... +( +mutex_lock@p1 +| +mutex_trylock@p1 +) + (...) +... when != mutex_unlock(...) +done@p +... +} + + +@elocked exists@ +identifier func=r1.func; +identifier done=r1.done; +position p1,p; +expression e; +@@ + +func(...) { +... +e = &done; +... +( +mutex_lock@p1 +| +mutex_trylock@p1 +) + (...) +... when != mutex_unlock(...) +e@p +... +} + + +@has_wait_for_completion exists@ +position p; +identifier done; +identifier func=r1.func; +identifier fb = { wait_for_completion, wait_for_completion_io}; +expression e; +@@ + +func(...) { +... +( +... +fb(&done@p); +... +| +e = &done; +... +fb(e@p); +) +... +} + +@has_while_wait exists@ +position p; +identifier done, ret; +identifier func=r1.func; +identifier fb =~ "wait_for_completion.*"; +expression e; +@@ + +func(...) { +... +while (...) { + ... + ret = fb(&done@p, e); + ... +} +... +} + +@has_while_wait2 exists@ +position p; +identifier done; +identifier func=r1.func; +expression fb =~ "wait_for_completion.*"; +@@ + +func(...) { +... +while (fb(&done@p, ...) == 0) { + ... +} +... +} + + +@r2 depends on (!has_wait_for_completion && !has_while_wait && !has_while_wait2) exists@ +declarer name DECLARE_COMPLETION_ONSTACK; +position p!={locked.p, elocked.p}; +identifier done=r1.done; +identifier func=r1.func; +expression e; +@@ + +func(...) { +... +( +wait_for_completion_interruptible(&done@p) +| +wait_for_completion_killable(&done@p) +| +wait_for_completion_timeout(&done@p, ...) +| +wait_for_completion_io_timeout(&done@p, ...) +| +wait_for_completion_interruptible_timeout(&done@p, ...) +| +wait_for_completion_killable_timeout(&done@p, ...) +| +try_wait_for_completion(&done@p) +| +wait_for_completion_timeout(e@p, ...) +) +... +} + + +@script:python depends on report@ +fp << r2.p; +@@ + +print('file:{:s}::{:s} was suspected to return a variable on stack'.format(fp[0].file, fp[0].line)) + -- 2.37.3
WARNING: multiple messages have this Message-ID (diff)
From: Schspa Shi <schspa@gmail.com> To: linux-kernel@vger.kernel.org, cocci@inria.fr, peterz@infradead.org, mcgrof@kernel.org Cc: Schspa Shi <schspa@gmail.com>, Julia Lawall <Julia.Lawall@inria.fr>, Nicolas Palix <nicolas.palix@imag.fr>, Matthias Brugger <matthias.bgg@gmail.com>, AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>, Ingo Molnar <mingo@redhat.com>, Juri Lelli <juri.lelli@redhat.com>, Vincent Guittot <vincent.guittot@linaro.org>, Dietmar Eggemann <dietmar.eggemann@arm.com>, Steven Rostedt <rostedt@goodmis.org>, Ben Segall <bsegall@google.com>, Mel Gorman <mgorman@suse.de>, Daniel Bristot de Oliveira <bristot@redhat.com>, Valentin Schneider <vschneid@redhat.com> Subject: [cocci] [RFC PATCH] cocci: cpi: add complete api check script Date: Mon, 27 Feb 2023 15:53:47 +0800 [thread overview] Message-ID: <20230227075346.69658-1-schspa@gmail.com> (raw) When DECLARE_COMPLETION_ONSTACK was used, the user must to ensure the other process won't reference the completion variable on stack. For a killable/interruptiable version, we need extra code(add locks/use xchg) to ensure this. This patch provide a SmPL script to detect bad DECLARE_COMPLETION_ONSTACK(_MAP) API usage, but far from perfect. This is a common problem, and a lot of drivers have simpler problem. The fellowing is a list of problems find by this SmPL patch, due to the complex use of wait_for_complete* API, there will still be some false negatives and false positives. This RFC patch is mainly used to discuss improvement methods. If we introduce the wait_for_complete*_onstack API, it will be easier to modify these problems, and the patch rules of SmPL will be very easy. In the process of trying to write SmPL scripts, I strongly recommend introducing two onstack APIs to complete this operation. file:/Users/schspa/work/src/linux/drivers/infiniband/ulp/srpt/ib_srpt.c::2962 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/misc/tifm_7xx1.c::268 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/firmware/arm_scmi/driver.c::1001 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dispc-compat.c::595 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dispc-compat.c::491 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dispc-compat.c::538 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dispc-compat.c::645 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dsi.c::3175 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dsi.c::2360 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dsi.c::2314 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/video/fbdev/omap2/omapfb/dss/dsi.c::2634 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/gpu/drm/omapdrm/dss/dsi.c::1804 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/gpu/drm/omapdrm/dss/dsi.c::1758 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/gpu/drm/omapdrm/dss/dsi.c::2034 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/net/wireless/marvell/mwl8k.c::2259 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/net/wireless/mediatek/mt7601u/mcu.c::317 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/net/wireless/ti/wlcore/main.c::6674 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/net/wwan/t7xx/t7xx_state_monitor.c::416 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/soc/apple/rtkit.c::647 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/soc/apple/rtkit.c::653 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/soc/qcom/rpmh.c::269 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/aic94xx/aic94xx_tmf.c::339 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_ctl.c::242 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_scsi.c::1811 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_scsi.c::2266 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_scsi.c::1603 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/snic/snic_scsi.c::2073 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/qla2xxx/qla_os.c::1807 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/qla2xxx/qla_os.c::1328 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/ibmvscsi/ibmvfc.c::2466 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/aic7xxx/aic79xx_osm.c::844 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/aic7xxx/aic79xx_osm.c::2334 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/aic7xxx/aic7xxx_osm.c::2297 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/lpfc/lpfc_nvmet.c::2119 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/ipr.c::5153 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/scsi_error.c::1157 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/hisi_sas/hisi_sas_main.c::1215 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/hisi_sas/hisi_sas_v2_hw.c::996 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/hisi_sas/hisi_sas_v3_hw.c::867 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/isci/task.c::317 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/fnic/fnic_scsi.c::1844 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/fnic/fnic_scsi.c::2310 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/fnic/fnic_scsi.c::2086 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/scsi/fnic/fnic_scsi.c::2579 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/ufs/core/ufshcd.c::6752 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/ufs/core/ufshcd.c::4074 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/thunderbolt/ctl.c::604 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i2c/busses/i2c-hisi.c::206 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/s390/cio/vfio_ccw_drv.c::71 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/slimbus/messaging.c::154 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/slimbus/qcom-ngd-ctrl.c::894 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/slimbus/qcom-ngd-ctrl.c::932 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/slimbus/qcom-ctrl.c::377 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/usb/core/devio.c::1142 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/usb/core/hcd.c::2229 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/spi/spi-hisi-sfc-v3xx.c::337 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/bluetooth/hci_bcm4377.c::955 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/cmd_v1.c::336 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/cmd_v2.c::278 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/core.c::360 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/core.c::312 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/i3c/master/mipi-i3c-hci/core.c::238 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/ata/libata-core.c::1558 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/w1/masters/ds1wm.c::285 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/w1/masters/ds1wm.c::233 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/drivers/w1/masters/ds1wm.c::262 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/lib/kunit/try-catch.c::76 was suspected to return a variable on stack file:/Users/schspa/work/src/linux/sound/aoa/soundbus/i2sbus/pcm.c::264 was suspected to return a variable on stack To fix this, we can add introducing two new API for this. + +void complete_on_stack(struct completion **x) +{ + struct completion *comp = xchg(*x, NULL); + + if (comp) + complete(comp); +} +EXPORT_SYMBOL(complete_on_stack); + +int __sched wait_for_completion_state_on_stack(struct completion **x, + unsigned int state) +{ + struct completion *comp = *x; + int retval; + + retval = wait_for_completion_state(comp, state); + if (retval) { + if (xchg(*x, NULL)) + return retval; + + /* + * complete_on_stack will call complete shortly. + */ + wait_for_completion(comp); + } + + return retval; +} +EXPORT_SYMBOL(wait_for_completion_state_on_stack); Link: https://lore.kernel.org/all/20221115140233.21981-1-schspa@gmail.com/T/#mf6a41a7009bb47af1b15adf2b7b355e495f609c4 Link: https://lore.kernel.org/all/7d1021f1-c88e-5a03-3b92-087f9be37491@I-love.SAKURA.ne.jp/ CC: Julia Lawall <Julia.Lawall@inria.fr> CC: Nicolas Palix <nicolas.palix@imag.fr> CC: Matthias Brugger <matthias.bgg@gmail.com> CC: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com> CC: Ingo Molnar <mingo@redhat.com> CC: Peter Zijlstra <peterz@infradead.org> CC: Juri Lelli <juri.lelli@redhat.com> CC: Vincent Guittot <vincent.guittot@linaro.org> CC: Dietmar Eggemann <dietmar.eggemann@arm.com> CC: Steven Rostedt <rostedt@goodmis.org> CC: Ben Segall <bsegall@google.com> CC: Mel Gorman <mgorman@suse.de> CC: Daniel Bristot de Oliveira <bristot@redhat.com> CC: Valentin Schneider <vschneid@redhat.com> Signed-off-by: Schspa Shi <schspa@gmail.com> --- scripts/coccinelle/api/complete.cocci | 160 ++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 scripts/coccinelle/api/complete.cocci diff --git a/scripts/coccinelle/api/complete.cocci b/scripts/coccinelle/api/complete.cocci new file mode 100644 index 000000000000..d4cf32187180 --- /dev/null +++ b/scripts/coccinelle/api/complete.cocci @@ -0,0 +1,160 @@ +// SPDX-License-Identifier: GPL-2.0 +/// +// Copyright: (C) 2023 Schspa Shi. +// Confidence: High +virtual report + +@r1 exists@ +declarer name DECLARE_COMPLETION_ONSTACK; +declarer name DECLARE_COMPLETION_ONSTACK_MAP; +position p; +identifier done; +identifier func; +@@ + +func(...) { +... +( +DECLARE_COMPLETION_ONSTACK(done@p); +| +DECLARE_COMPLETION_ONSTACK_MAP(done@p, ...); +) +... +} + +@locked exists@ +identifier func=r1.func; +identifier done=r1.done; +position p1,p; +@@ + +func(...) { +... +( +mutex_lock@p1 +| +mutex_trylock@p1 +) + (...) +... when != mutex_unlock(...) +done@p +... +} + + +@elocked exists@ +identifier func=r1.func; +identifier done=r1.done; +position p1,p; +expression e; +@@ + +func(...) { +... +e = &done; +... +( +mutex_lock@p1 +| +mutex_trylock@p1 +) + (...) +... when != mutex_unlock(...) +e@p +... +} + + +@has_wait_for_completion exists@ +position p; +identifier done; +identifier func=r1.func; +identifier fb = { wait_for_completion, wait_for_completion_io}; +expression e; +@@ + +func(...) { +... +( +... +fb(&done@p); +... +| +e = &done; +... +fb(e@p); +) +... +} + +@has_while_wait exists@ +position p; +identifier done, ret; +identifier func=r1.func; +identifier fb =~ "wait_for_completion.*"; +expression e; +@@ + +func(...) { +... +while (...) { + ... + ret = fb(&done@p, e); + ... +} +... +} + +@has_while_wait2 exists@ +position p; +identifier done; +identifier func=r1.func; +expression fb =~ "wait_for_completion.*"; +@@ + +func(...) { +... +while (fb(&done@p, ...) == 0) { + ... +} +... +} + + +@r2 depends on (!has_wait_for_completion && !has_while_wait && !has_while_wait2) exists@ +declarer name DECLARE_COMPLETION_ONSTACK; +position p!={locked.p, elocked.p}; +identifier done=r1.done; +identifier func=r1.func; +expression e; +@@ + +func(...) { +... +( +wait_for_completion_interruptible(&done@p) +| +wait_for_completion_killable(&done@p) +| +wait_for_completion_timeout(&done@p, ...) +| +wait_for_completion_io_timeout(&done@p, ...) +| +wait_for_completion_interruptible_timeout(&done@p, ...) +| +wait_for_completion_killable_timeout(&done@p, ...) +| +try_wait_for_completion(&done@p) +| +wait_for_completion_timeout(e@p, ...) +) +... +} + + +@script:python depends on report@ +fp << r2.p; +@@ + +print('file:{:s}::{:s} was suspected to return a variable on stack'.format(fp[0].file, fp[0].line)) + -- 2.37.3
next reply other threads:[~2023-02-27 7:54 UTC|newest] Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top 2023-02-27 7:53 Schspa Shi [this message] 2023-02-27 7:53 ` [cocci] [RFC PATCH] cocci: cpi: add complete api check script Schspa Shi 2023-02-27 11:20 ` Peter Zijlstra 2023-02-27 11:20 ` [cocci] " Peter Zijlstra 2023-02-27 15:28 ` Steven Rostedt 2023-02-27 15:28 ` [cocci] " Steven Rostedt 2023-02-27 15:43 ` Peter Zijlstra 2023-02-27 15:43 ` [cocci] " Peter Zijlstra 2023-02-27 15:53 ` Steven Rostedt 2023-02-27 15:53 ` [cocci] " Steven Rostedt 2023-02-27 16:36 ` Schspa Shi 2023-02-27 16:36 ` [cocci] " Schspa Shi 2023-02-27 16:10 ` Schspa Shi 2023-02-27 16:10 ` [cocci] " Schspa Shi 2023-02-27 15:54 ` [cocci] [RFC PATCH] coccinelle: Add SmPL script for completion API check Markus Elfring
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=20230227075346.69658-1-schspa@gmail.com \ --to=schspa@gmail.com \ --cc=Julia.Lawall@inria.fr \ --cc=angelogioacchino.delregno@collabora.com \ --cc=bristot@redhat.com \ --cc=bsegall@google.com \ --cc=cocci@inria.fr \ --cc=dietmar.eggemann@arm.com \ --cc=juri.lelli@redhat.com \ --cc=linux-kernel@vger.kernel.org \ --cc=matthias.bgg@gmail.com \ --cc=mcgrof@kernel.org \ --cc=mgorman@suse.de \ --cc=mingo@redhat.com \ --cc=nicolas.palix@imag.fr \ --cc=peterz@infradead.org \ --cc=rostedt@goodmis.org \ --cc=vincent.guittot@linaro.org \ --cc=vschneid@redhat.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: 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.