All of lore.kernel.org
 help / color / mirror / Atom feed
From: Yangtao Li <frank.li@vivo.com>
To: miquel.raynal@bootlin.com, rafael@kernel.org,
	daniel.lezcano@linaro.org, amitk@kernel.org, rui.zhang@intel.com,
	mmayer@broadcom.com, bcm-kernel-feedback-list@broadcom.com,
	florian.fainelli@broadcom.com, tglx@linutronix.de,
	matthias.bgg@gmail.com, angelogioacchino.delregno@collabora.com,
	bchihi@baylibre.com, frank.li@vivo.com, wenst@chromium.org
Cc: linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	linux-mediatek@lists.infradead.org
Subject: [PATCH v3 2/5] thermal/drivers/armada: convert to use devm_request_threaded_irq_emsg()
Date: Mon,  3 Jul 2023 17:04:51 +0800	[thread overview]
Message-ID: <20230703090455.62101-3-frank.li@vivo.com> (raw)
In-Reply-To: <20230703090455.62101-1-frank.li@vivo.com>

There are more than 700 calls to the devm_request_threaded_irq method.
Most drivers only request one interrupt resource, and these error
messages are basically the same. If error messages are printed
everywhere, more than 1000 lines of code can be saved by removing the
msg in the driver.

And tglx point out that:

  If we actually look at the call sites of
  devm_request_threaded_irq() then the vast majority of them print more or
  less lousy error messages. A quick grep/sed/awk/sort/uniq revealed

     519 messages total (there are probably more)

     352 unique messages

     323 unique messages after lower casing

         Those 323 are mostly just variants of the same patterns with
         slight modifications in formatting and information provided.

     186 of these messages do not deliver any useful information,
         e.g. "no irq", "

     The most useful one of all is: "could request wakeup irq: %d"

  So there is certainly an argument to be made that this particular
  function should print a well formatted and informative error message.

  It's not a general allocator like kmalloc(). It's specialized and in the
  vast majority of cases failing to request the interrupt causes the
  device probe to fail. So having proper and consistent information why
  the device cannot be used _is_ useful.

Let's use devm_request_threaded_irq_emsg(), which ensure that all error
handling branches print error information. In this way, when this function
fails, the upper-layer functions can directly return an error code without
missing debugging information. Otherwise, the error message will be
printed redundantly or missing.

Cc: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Yangtao Li <frank.li@vivo.com>
---
 drivers/thermal/armada_thermal.c | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)

diff --git a/drivers/thermal/armada_thermal.c b/drivers/thermal/armada_thermal.c
index 9f6dc4fc9112..a5e140643f00 100644
--- a/drivers/thermal/armada_thermal.c
+++ b/drivers/thermal/armada_thermal.c
@@ -913,15 +913,12 @@ static int armada_thermal_probe(struct platform_device *pdev)
 
 	/* The overheat interrupt feature is not mandatory */
 	if (irq > 0) {
-		ret = devm_request_threaded_irq(&pdev->dev, irq,
-						armada_overheat_isr,
-						armada_overheat_isr_thread,
-						0, NULL, priv);
-		if (ret) {
-			dev_err(&pdev->dev, "Cannot request threaded IRQ %d\n",
-				irq);
+		ret = devm_request_threaded_irq_emsg(&pdev->dev, irq,
+						     armada_overheat_isr,
+						     armada_overheat_isr_thread,
+						     0, NULL, priv, NULL);
+		if (ret)
 			return ret;
-		}
 	}
 
 	/*
-- 
2.39.0


WARNING: multiple messages have this Message-ID (diff)
From: Yangtao Li <frank.li@vivo.com>
To: miquel.raynal@bootlin.com, rafael@kernel.org,
	daniel.lezcano@linaro.org, amitk@kernel.org, rui.zhang@intel.com,
	mmayer@broadcom.com, bcm-kernel-feedback-list@broadcom.com,
	florian.fainelli@broadcom.com, tglx@linutronix.de,
	matthias.bgg@gmail.com, angelogioacchino.delregno@collabora.com,
	bchihi@baylibre.com, frank.li@vivo.com, wenst@chromium.org
Cc: linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	linux-mediatek@lists.infradead.org
Subject: [PATCH v3 2/5] thermal/drivers/armada: convert to use devm_request_threaded_irq_emsg()
Date: Mon,  3 Jul 2023 17:04:51 +0800	[thread overview]
Message-ID: <20230703090455.62101-3-frank.li@vivo.com> (raw)
In-Reply-To: <20230703090455.62101-1-frank.li@vivo.com>

There are more than 700 calls to the devm_request_threaded_irq method.
Most drivers only request one interrupt resource, and these error
messages are basically the same. If error messages are printed
everywhere, more than 1000 lines of code can be saved by removing the
msg in the driver.

And tglx point out that:

  If we actually look at the call sites of
  devm_request_threaded_irq() then the vast majority of them print more or
  less lousy error messages. A quick grep/sed/awk/sort/uniq revealed

     519 messages total (there are probably more)

     352 unique messages

     323 unique messages after lower casing

         Those 323 are mostly just variants of the same patterns with
         slight modifications in formatting and information provided.

     186 of these messages do not deliver any useful information,
         e.g. "no irq", "

     The most useful one of all is: "could request wakeup irq: %d"

  So there is certainly an argument to be made that this particular
  function should print a well formatted and informative error message.

  It's not a general allocator like kmalloc(). It's specialized and in the
  vast majority of cases failing to request the interrupt causes the
  device probe to fail. So having proper and consistent information why
  the device cannot be used _is_ useful.

Let's use devm_request_threaded_irq_emsg(), which ensure that all error
handling branches print error information. In this way, when this function
fails, the upper-layer functions can directly return an error code without
missing debugging information. Otherwise, the error message will be
printed redundantly or missing.

Cc: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Yangtao Li <frank.li@vivo.com>
---
 drivers/thermal/armada_thermal.c | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)

diff --git a/drivers/thermal/armada_thermal.c b/drivers/thermal/armada_thermal.c
index 9f6dc4fc9112..a5e140643f00 100644
--- a/drivers/thermal/armada_thermal.c
+++ b/drivers/thermal/armada_thermal.c
@@ -913,15 +913,12 @@ static int armada_thermal_probe(struct platform_device *pdev)
 
 	/* The overheat interrupt feature is not mandatory */
 	if (irq > 0) {
-		ret = devm_request_threaded_irq(&pdev->dev, irq,
-						armada_overheat_isr,
-						armada_overheat_isr_thread,
-						0, NULL, priv);
-		if (ret) {
-			dev_err(&pdev->dev, "Cannot request threaded IRQ %d\n",
-				irq);
+		ret = devm_request_threaded_irq_emsg(&pdev->dev, irq,
+						     armada_overheat_isr,
+						     armada_overheat_isr_thread,
+						     0, NULL, priv, NULL);
+		if (ret)
 			return ret;
-		}
 	}
 
 	/*
-- 
2.39.0


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2023-07-03  9:05 UTC|newest]

Thread overview: 44+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-03  9:04 [PATCH v3 0/5] introduce devm_request_threaded_irq_emsg() Yangtao Li
2023-07-03  9:04 ` Yangtao Li
2023-07-03  9:04 ` [PATCH v3 1/5] genirq/devres: Add devm_request_threaded_irq_emsg() Yangtao Li
2023-07-03  9:04   ` Yangtao Li
2023-07-03 12:31   ` Krzysztof Kozlowski
2023-07-03 12:31     ` Krzysztof Kozlowski
2023-07-03 13:24     ` Yangtao Li
2023-07-03 13:24       ` Yangtao Li
2023-07-03 13:37       ` Krzysztof Kozlowski
2023-07-03 13:37         ` Krzysztof Kozlowski
2023-07-03 17:43     ` Uwe Kleine-König
2023-07-03 17:43       ` Uwe Kleine-König
2023-07-04  8:48       ` Krzysztof Kozlowski
2023-07-04  8:48         ` Krzysztof Kozlowski
2023-07-04  9:06         ` Yangtao Li
2023-07-04  9:06           ` Yangtao Li
2023-07-04 14:19           ` Uwe Kleine-König
2023-07-04 14:19             ` Uwe Kleine-König
2023-07-05  2:15             ` Jonathan Cameron
2023-07-05  2:15               ` Jonathan Cameron
2023-07-05  7:30               ` Uwe Kleine-König
2023-07-05  7:30                 ` Uwe Kleine-König
2023-07-05  7:43                 ` Yangtao Li
2023-07-05  7:43                   ` Yangtao Li
2023-07-05  7:49                   ` Yangtao Li
2023-07-05  7:49                     ` Yangtao Li
2023-07-05 10:14                   ` AngeloGioacchino Del Regno
2023-07-05 10:14                     ` AngeloGioacchino Del Regno
2023-07-03  9:04 ` Yangtao Li [this message]
2023-07-03  9:04   ` [PATCH v3 2/5] thermal/drivers/armada: convert to use devm_request_threaded_irq_emsg() Yangtao Li
2023-07-04  8:46   ` Miquel Raynal
2023-07-04  8:46     ` Miquel Raynal
2023-07-04 14:22     ` Uwe Kleine-König
2023-07-04 14:22       ` Uwe Kleine-König
2023-07-04 14:29       ` Miquel Raynal
2023-07-04 14:29         ` Miquel Raynal
2023-07-03  9:04 ` [PATCH v3 3/5] thermal/drivers/brcmstb_thermal: " Yangtao Li
2023-07-03  9:04   ` Yangtao Li
2023-07-03  9:04 ` [PATCH v3 4/5] thermal/drivers/db8500: " Yangtao Li
2023-07-03  9:04   ` Yangtao Li
2023-07-03  9:04 ` [PATCH v3 5/5] thermal/drivers/mediatek/lvts_thermal: " Yangtao Li
2023-07-03  9:04   ` Yangtao Li
2023-07-03 11:47 ` [PATCH v3 0/5] introduce devm_request_threaded_irq_emsg() Yangtao Li
2023-07-03 11:47   ` Yangtao Li

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=20230703090455.62101-3-frank.li@vivo.com \
    --to=frank.li@vivo.com \
    --cc=amitk@kernel.org \
    --cc=angelogioacchino.delregno@collabora.com \
    --cc=bchihi@baylibre.com \
    --cc=bcm-kernel-feedback-list@broadcom.com \
    --cc=daniel.lezcano@linaro.org \
    --cc=florian.fainelli@broadcom.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mediatek@lists.infradead.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=matthias.bgg@gmail.com \
    --cc=miquel.raynal@bootlin.com \
    --cc=mmayer@broadcom.com \
    --cc=rafael@kernel.org \
    --cc=rui.zhang@intel.com \
    --cc=tglx@linutronix.de \
    --cc=wenst@chromium.org \
    /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 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.