Skip to contentSkip to conversation

First try of coccinelle, needs advice

Cocci Andy Shevchenko 2 participants 2 messages Jun 17, 2017

Subsystems (25)
lore
Share & tools
lore
#0 lore raw

Hi!

I played first time with coccinelle.
What I have tried to do is to find all locations where pm_runtime_get() is not followed by pm_runtime_put() in case of error path.

cocci script roughly does what I need, though I have several questions:
- how to shrink it (I see few duplications there, no idea what is the best approach to eliminate them)?
- how handle goto:s properly? I mean how to clearly choose goto path over the rest?
- if you look at the result (see below) in almost all goto cases I need to avoid adding pm_runtime_put*() variants since it seems the error handling is broken (needs to shuffle error labels). How to achieve this?
- any other recommendations or links to some good examples or documentation would be much appreciated

Quoted 1 line

From 825dc60eaa42af81d935ad4b3cb995d533c17657 Mon Sep 17 00:00:00 2001

From: Andy Shevchenko <[email protected]>
Date: Sat, 17 Jun 2017 19:38:20 +0300
Subject: [PATCH 1/1] pm_runtime_put: First try coccinelle

pm_runtime_get() should followed by pm_runtime_put() in case of error.

---

?drivers/dma/tegra210-adma.c?????????????????????|??1 +
?drivers/gpu/drm/etnaviv/etnaviv_gpu.c???????????|??1 +
?drivers/gpu/drm/rockchip/rockchip_drm_vop.c?????|??2 +
?drivers/i2c/busses/i2c-omap.c???????????????????|??3 +-
?drivers/i2c/busses/i2c-tegra.c??????????????????|??2 +
?drivers/media/platform/mtk-jpeg/mtk_jpeg_core.c |??1 +
?drivers/media/platform/sti/delta/delta-v4l2.c???|??1 +
?drivers/net/can/xilinx_can.c????????????????????|??2 +
?drivers/pci/dwc/pci-dra7xx.c????????????????????|??5 +--
?drivers/pci/host/pcie-rcar.c????????????????????|??4 +-
?drivers/soc/ti/knav_dma.c???????????????????????|??1 +
?drivers/spi/spi-tegra114.c??????????????????????|??2 +
?drivers/spi/spi-tegra20-sflash.c????????????????|??1 +
?drivers/spi/spi-tegra20-slink.c?????????????????|??2 +
?drivers/spi/spi-ti-qspi.c???????????????????????|??1 +
?drivers/usb/core/hub.c??????????????????????????|??1 +
?scripts/coccinelle/api/pm_runtime_put.cocci?????| 57

+++++++++++++++++++++++++
?17 files changed, 78 insertions(+), 9 deletions(-) ?create mode 100644 scripts/coccinelle/api/pm_runtime_put.cocci

drivers/dma/tegra210-adma.c +0 -0
index b10cbaa82ff5..ad0473ab2360 100644
@@ -582,6 +582,7 @@ static int tegra_adma_alloc_chan_resources(struct

dma_chan *dc)
? ret = pm_runtime_get_sync(tdc2dev(tdc));
? if (ret < 0) {
? free_irq(tdc->irq, tdc);
+ pm_runtime_put(tdc2dev(tdc));
? return ret;
? }
?

(quoted diff) +0 -0

b/drivers/gpu/drm/etnaviv/etnaviv_gpu.c
index ada45fdd0eae..c77cade43de6 100644

drivers/gpu/drm/etnaviv/etnaviv_gpu.c +0 -0
@@ -659,6 +659,7 @@ int etnaviv_gpu_init(struct etnaviv_gpu *gpu)

? ret = pm_runtime_get_sync(gpu->dev);
? if (ret < 0) {
? dev_err(gpu->dev, "Failed to enable GPU power
domain\n");
+ pm_runtime_put(gpu->dev);
? return ret;
? }
?

(quoted diff) +0 -0

b/drivers/gpu/drm/rockchip/rockchip_drm_vop.c
index 5d450332c2fd..f930ca75f615 100644

drivers/gpu/drm/rockchip/rockchip_drm_vop.c +0 -0
@@ -505,6 +505,7 @@ static int vop_enable(struct drm_crtc *crtc)

? ret = pm_runtime_get_sync(vop->dev);
? if (ret < 0) {
? dev_err(vop->dev, "failed to get pm runtime: %d\n",
ret);
+ pm_runtime_put(vop->dev);
? return ret;
? }
?
@@ -1418,6 +1419,7 @@ static int vop_initial(struct vop *vop)
? ret = pm_runtime_get_sync(vop->dev);
? if (ret < 0) {
? dev_err(vop->dev, "failed to get pm runtime: %d\n",
ret);
+ pm_runtime_put(vop->dev);
? return ret;
? }
?

drivers/i2c/busses/i2c- renamed from drivers/i2c/busses/i2c-omap.c +0 -0

omap.c
index 1ebb5e947e0b..b7ceefe44beb 100644

drivers/i2c/busses/i2c-omap.c +0 -0
@@ -1438,11 +1438,10 @@ omap_i2c_probe(struct platform_device *pdev)

?
?err_unuse_clocks:
? omap_i2c_write_reg(omap, OMAP_I2C_CON_REG, 0);
+err_free_mem:
? pm_runtime_dont_use_autosuspend(omap->dev);
? pm_runtime_put_sync(omap->dev);
? pm_runtime_disable(&pdev->dev);
-err_free_mem:
-
? return r;
?}
?

drivers/i2c/busses/i2c- renamed from drivers/i2c/busses/i2c-tegra.c +0 -0

tegra.c
index 4af9bbae20df..e6d40bef0475 100644

drivers/i2c/busses/i2c-tegra.c +0 -0
@@ -484,6 +484,7 @@ static int tegra_i2c_init(struct tegra_i2c_dev

*i2c_dev)
? err = pm_runtime_get_sync(i2c_dev->dev);
? if (err < 0) {
? dev_err(i2c_dev->dev, "runtime resume failed %d\n",
err);
+ pm_runtime_put(i2c_dev->dev);
? return err;
? }
?
@@ -740,6 +741,7 @@ static int tegra_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[],
? ret = pm_runtime_get_sync(i2c_dev->dev);
? if (ret < 0) {
? dev_err(i2c_dev->dev, "runtime resume failed %d\n",
ret);
+ pm_runtime_put(i2c_dev->dev);
? return ret;
? }
?

(quoted diff) +0 -0

b/drivers/media/platform/mtk-jpeg/mtk_jpeg_core.c
index 451a54039e65..f43298a4bf96 100644

drivers/media/platform/mtk-jpeg/mtk_jpeg_core.c +0 -0
@@ -725,6 +725,7 @@ static int mtk_jpeg_start_streaming(struct vb2_queue

*q, unsigned int count)
?err:
? while ((vb = mtk_jpeg_buf_remove(ctx, q->type)))
? v4l2_m2m_buf_done(to_vb2_v4l2_buffer(vb),
VB2_BUF_STATE_QUEUED);
+ pm_runtime_put(ctx->jpeg->dev);
? return ret;
?}
?

(quoted diff) +0 -0

b/drivers/media/platform/sti/delta/delta-v4l2.c
index c6f2e244b7a8..6bfed0636625 100644

drivers/media/platform/sti/delta/delta-v4l2.c +0 -0
@@ -1297,6 +1297,7 @@ int delta_get_sync(struct delta_ctx *ctx)

? if (ret < 0) {
? dev_err(delta->dev, "%s pm_runtime_get_sync failed
(%d)\n",
? __func__, ret);
+ pm_runtime_put(delta->dev);
? return ret;
? }
?

drivers/net/can/xilinx_can.c +0 -0
index 89aec07c225f..f59cb64e0d1d 100644
@@ -845,6 +845,7 @@ static int xcan_open(struct net_device *ndev)

? if (ret < 0) {
? netdev_err(ndev, "%s: pm_runtime_get failed(%d)\n",
? __func__, ret);
+ pm_runtime_put(priv->dev);
? return ret;
? }
?
@@ -929,6 +930,7 @@ static int xcan_get_berr_counter(const struct net_device *ndev,
? if (ret < 0) {
? netdev_err(ndev, "%s: pm_runtime_get failed(%d)\n",
? __func__, ret);
+ pm_runtime_put(priv->dev);
? return ret;
? }
?

drivers/pci/dwc/pci-dra7xx.c +0 -0
index 8decf46cf525..9c7819073eb9 100644
@@ -659,7 +659,7 @@ static int __init dra7xx_pcie_probe(struct

platform_device *pdev)
? ret = pm_runtime_get_sync(dev);
? if (ret < 0) {
? dev_err(dev, "pm_runtime_get_sync failed\n");
- goto err_get_sync;
+ goto err_gpio;
? }
?
? reset = devm_gpiod_get_optional(dev, NULL, GPIOD_OUT_HIGH);
@@ -713,11 +713,8 @@ static int __init dra7xx_pcie_probe(struct platform_device *pdev)
?
?err_gpio:
? pm_runtime_put(dev);
-
-err_get_sync:
? pm_runtime_disable(dev);
? dra7xx_pcie_disable_phy(dra7xx);
-
? return ret;
?}
?

drivers/pci/host/pcie-rcar.c +0 -0
index cb07c45c1858..b99ce8593f6f 100644
@@ -1152,7 +1152,7 @@ static int rcar_pcie_probe(struct platform_device

*pdev)
? err = pm_runtime_get_sync(dev);
? if (err < 0) {
? dev_err(dev, "pm_runtime_get_sync failed\n");
- goto err_pm_disable;
+ goto err_pm_put;
? }
?
? /* Failure to get a link might just be that no cards are
inserted */
@@ -1185,8 +1185,6 @@ static int rcar_pcie_probe(struct platform_device *pdev)
?
?err_pm_put:
? pm_runtime_put(dev);
-
-err_pm_disable:
? pm_runtime_disable(dev);
? return err;
?}

drivers/soc/ti/knav_dma.c +0 -0
index 026182d3b27c..779c9e672697 100644
@@ -753,6 +753,7 @@ static int knav_dma_probe(struct platform_device

*pdev)
? ret = pm_runtime_get_sync(kdev->dev);
? if (ret < 0) {
? dev_err(kdev->dev, "unable to enable pktdma, err %d\n",
ret);
+ pm_runtime_put(kdev->dev);
? return ret;
? }
?

drivers/spi/spi-tegra114.c +0 -0
index 08012ae5aa66..5d356bfd25c2 100644
@@ -771,6 +771,7 @@ static int tegra_spi_setup(struct spi_device *spi)

? ret = pm_runtime_get_sync(tspi->dev);
? if (ret < 0) {
? dev_err(tspi->dev, "pm runtime failed, e = %d\n", ret);
+ pm_runtime_put(tspi->dev);
? return ret;
? }
?
@@ -1180,6 +1181,7 @@ static int tegra_spi_resume(struct device *dev)
? ret = pm_runtime_get_sync(dev);
? if (ret < 0) {
? dev_err(dev, "pm runtime failed, e = %d\n", ret);
+ pm_runtime_put(dev);
? return ret;
? }
? tegra_spi_writel(tspi, tspi->command1_reg, SPI_COMMAND1);

drivers/spi/spi-tegra20- renamed from drivers/spi/spi-tegra20-sflash.c +0 -0

sflash.c
index 2c797ee2664d..97daac421819 100644

drivers/spi/spi-tegra20-sflash.c +0 -0
@@ -565,6 +565,7 @@ static int tegra_sflash_resume(struct device *dev)

? ret = pm_runtime_get_sync(dev);
? if (ret < 0) {
? dev_err(dev, "pm runtime failed, e = %d\n", ret);
+ pm_runtime_put(dev);
? return ret;
? }
? tegra_sflash_writel(tsd, tsd->command_reg, SPI_COMMAND);

drivers/spi/spi-tegra20- renamed from drivers/spi/spi-tegra20-slink.c +0 -0

slink.c
index 0c06ce424210..6f72c5e92a8b 100644

drivers/spi/spi-tegra20-slink.c +0 -0
@@ -762,6 +762,7 @@ static int tegra_slink_setup(struct spi_device *spi)

? ret = pm_runtime_get_sync(tspi->dev);
? if (ret < 0) {
? dev_err(tspi->dev, "pm runtime failed, e = %d\n", ret);
+ pm_runtime_put(tspi->dev);
? return ret;
? }
?
@@ -1180,6 +1181,7 @@ static int tegra_slink_resume(struct device *dev)
? ret = pm_runtime_get_sync(dev);
? if (ret < 0) {
? dev_err(dev, "pm runtime failed, e = %d\n", ret);
+ pm_runtime_put(dev);
? return ret;
? }
? tegra_slink_writel(tspi, tspi->command_reg, SLINK_COMMAND);

drivers/spi/spi-ti-qspi.c +0 -0
index c24d9b45a27c..97326a070b59 100644
@@ -181,6 +181,7 @@ static int ti_qspi_setup(struct spi_device *spi)

? ret = pm_runtime_get_sync(qspi->dev);
? if (ret < 0) {
? dev_err(qspi->dev, "pm_runtime_get_sync() failed\n");
+ pm_runtime_put(qspi->dev);
? return ret;
? }
?

drivers/usb/core/hub.c +0 -0
index b8bb20d7acdb..aada5214c3c7 100644
@@ -3408,6 +3408,7 @@ int usb_port_resume(struct usb_device *udev,

pm_message_t msg)
? if (status < 0) {
? dev_dbg(&udev->dev, "can't resume usb port,
status %d\n",
? status);
+ pm_runtime_put(&port_dev->dev);
? return status;
? }
? }

(quoted diff) +0 -0

b/scripts/coccinelle/api/pm_runtime_put.cocci
new file mode 100644
index 000000000000..8c9710c9abb4

scripts/coccinelle/api/pm_runtime_put.cocci new file +1 -0
@@ -0,0 +1,57 @@
+/// Make sure pm_runtime_get followed by pm_runtime_put in case of

error
+///
+// Keywords: pm_runtime
+// Confidence: Medium
+// URL: http://coccinelle.lip6.fr/
+// Options: --include-headers
+
+virtual context
+virtual patch
+virtual org
+virtual report
+
+@@
+struct device *dev;
+identifier ret;
+@@
+(
+ ret = \(pm_runtime_get\|pm_runtime_get_sync\)(dev);
+ if (ret < 0) {
+ ... when != pm_runtime_put(dev);
+ ????when != pm_runtime_put_sync(dev);
+ ????when != pm_runtime_put_autosuspend(dev);
+ ????when != pm_runtime_put_noidle(dev);
+ ????when != pm_runtime_put_sync_suspend(dev);
+ ????when != pm_runtime_put_sync_autosuspend(dev);
++ pm_runtime_put(dev);
+ return ret;
+ }
+)
+
+@@
+struct device *dev;
+identifier ret;
+identifier err;
+@@
+(
+ ret = \(pm_runtime_get\|pm_runtime_get_sync\)(dev);
+ if (ret < 0) {
+ ... when != pm_runtime_put(dev);
+ ????when != pm_runtime_put_sync(dev);
+ ????when != pm_runtime_put_autosuspend(dev);
+ ????when != pm_runtime_put_noidle(dev);
+ ????when != pm_runtime_put_sync_suspend(dev);
+ ????when != pm_runtime_put_sync_autosuspend(dev);
++ pm_runtime_put(dev);
+ goto err;
+ }
+ ...
+ return ...;
+ ... when != pm_runtime_put(dev);
+ ????when != pm_runtime_put_sync(dev);
+ ????when != pm_runtime_put_autosuspend(dev);
+ ????when != pm_runtime_put_noidle(dev);
+ ????when != pm_runtime_put_sync_suspend(dev);
+ ????when != pm_runtime_put_sync_autosuspend(dev);
+ return ret;
+)
--?
2.11.0

Signature · 2 lines
Andy Shevchenko <[email protected]>
Intel Finland Oy
#1 lore raw
Quoted 6 lines · Andy Shevchenko

Hi!

I played first time with coccinelle.
What I have tried to do is to find all locations where pm_runtime_get() is not followed by pm_runtime_put() in case of error path.

Quoted 10 lines

cocci script roughly does what I need, though I have several questions:
- how to shrink it (I see few duplications there, no idea what is the best approach to eliminate them)?
- how handle goto:s properly? I mean how to clearly choose goto path over the rest?
- if you look at the result (see below) in almost all goto cases I need to avoid adding pm_runtime_put*() variants since it seems the error handling is broken (needs to shuffle error labels). How to achieve this?
- any other recommendations or links to some good examples or documentation would be much appreciated

To start with, what are you trying to do in the last rule with the return ...; followed by return ret;? Actually, Coccinelle is following the control flow, so nothing would ever follow a return.

If you wanted to just detect the problem, but not fix it automatically, then you could have the quite concise rule:

@@
expression ret,dev;
@@

*	ret = \(pm_runtime_get\|pm_runtime_get_sync\)(dev);
	if (ret < 0) {
		... when != pm_runtime_put(dev)
		    when != pm_runtime_put_sync(dev)
		    when != pm_runtime_put_autosuspend(dev)
		    when != pm_runtime_put_noidle(dev)
		    when != pm_runtime_put_sync_suspend(dev)
		    when != pm_runtime_put_sync_autosuspend(dev)
*		return ...;
	}

It could be good to run this to get an idea of what the possible cases are.

The ... will jump over gotos in this case.

The put functions seem to return values. Thus they might appear as eg ret = pm_runtime_put(dev). Thus, I dropped the ;s after these calls to allow them to appear as subexpressions.

ret can be any expression. It doesn't have to be an identifier (single variable name).

I assume that the argument to the get function has to have type struct device *. If that is the case, then it is better to leave out the type information. If it is not there, then Coccinelle won't have to check it. Checking the type could require information fron header files, which is expensive to collect.

Note that you don't need the outer parentheses that are in your rules. Those are only needed when there are multiple cases in a single rule (disjunction), but you have only one case in the rule.

You might want if ( \(ret < 0 \| ret != 0\) ) on the second line, in case people test for failure in multiple ways. ret != 0 will also match just ret.

For fixing, an idea for a goto rule could be the following, which exploits an existing label:

@@
expression dev,ret;
identifier l1,l2;
position p;
identifier f;
@@

f(...) { ... when any

        ret@p = \(pm_runtime_get\|pm_runtime_get_sync\)(dev);
        if (ret < 0) {
           ... when != pm_runtime_put(dev)

- goto l1;
+ goto l2;
}
... when any
when exists
l2: pm_runtime_put(dev);
l1:
... when any
}

@@
identifier r.f,r.l1;
statement S;
@@

f(...) { <... when != goto l1;
-l1:
S
...>
}

You would need to add in all the when's again, that I dropped to make the idea more apparent. Maybe there should be a big disjunction of freeing functions at l2 as well? There is also the possibility that the freeing function will be on the right hand side of an assignment.

The second rule drops the label l1 if it is now useless.

After that rule, you can also have:

@@
expression dev,ret;
identifier l1;
statement S;
@@

        ret = \(pm_runtime_get\|pm_runtime_get_sync\)(dev);
	if (ret < 0) {
           ... when != pm_runtime_put(dev)
           goto l1;
        }
        ... when any
            when exists
+l1:
       pm_runtime_put(dev);

-l1: S

This catches the case where there is no pre-existing label in the right place.

You could end with:

@r3@
expression dev,ret;
position p;
@@

        ret at p = \(pm_runtime_get\|pm_runtime_get_sync\)(dev);
        if (ret < 0) {
           ... when != pm_runtime_put(dev)
           return ...;
        }

@@
expression r3.dev,r3.ret;
position r3.p;
identifier l;
@@

        ret at p = \(pm_runtime_get\|pm_runtime_get_sync\)(dev);
(
        if (ret < 0) {
           ...
(
+          pm_runtime_put(dev);
           goto l;
|
+          pm_runtime_put(dev);
           return ...;
)
        }
|
        if (ret < 0)
+       {
+          pm_runtime_put(dev);
           goto l;
+       }
|
        if (ret < 0)
+       {
+          pm_runtime_put(dev);
           return ...;

+ }
)

The first rule checks that there is no put between the if and the return. The ... will skip over gotos, to ensure that there is no put all the way until the end of the function. Then the second rule adds the put just before the ending goto or return. In the goto case, it might be wanted to put the put@the goto label, instead of before the goto. That would require checking that no one else reaches that label. Perhaps that is better checked by hand. It would depend on how many cases are affected.

julia