| Message ID | 20230703090455.62101-2-frank.li@vivo.com (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Headers | show |
| Series | introduce devm_request_threaded_irq_emsg() | expand |
On 03/07/2023 11:04, Yangtao Li wrote: > 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. ... > +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, > + irq_handler_t handler, irq_handler_t thread_fn, > + unsigned long irqflags, const char *devname, > + void *dev_id, const char *emsg) > +{ > + int rc; > + > + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, > + devname, dev_id); > + if (rc && rc != -EPROBE_DEFER) { > + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", > + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), > + emsg ? : "", ERR_PTR(rc)); It is open-coding dev_err_probe(). Just use dev_err_probe instead. Best regards, Krzysztof
On 2023/7/3 20:31, Krzysztof Kozlowski wrote: > [你通常不会收到来自 krzk@kernel.org 的电子邮件。请访问 https://aka.ms/LearnAboutSenderIdentification，以了解这一点为什么很重要] > > On 03/07/2023 11:04, Yangtao Li wrote: >> 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. > > ... > >> +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, >> + irq_handler_t handler, irq_handler_t thread_fn, >> + unsigned long irqflags, const char *devname, >> + void *dev_id, const char *emsg) >> +{ >> + int rc; >> + >> + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, >> + devname, dev_id); >> + if (rc && rc != -EPROBE_DEFER) { >> + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", >> + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), >> + emsg ? : "", ERR_PTR(rc)); > It is open-coding dev_err_probe(). Just use dev_err_probe instead. How about the following? If possible, I would like to start modifying more drivers in the next version. int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, irq_handler_t handler, irq_handler_t thread_fn, unsigned long irqflags, const char *devname, void *dev_id, const char *emsg) { int rc; rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, devname, dev_id); if (rc) { dev_err_probe(dev, rc, "Failed to request %sinterrupt %u %s %s\n", thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), emsg ? : ""); } return rc; } EXPORT_SYMBOL(devm_request_threaded_irq_emsg); Thx, Yangtao > > Best regards, > Krzysztof >
On 03/07/2023 15:24, Yangtao Li wrote: > > On 2023/7/3 20:31, Krzysztof Kozlowski wrote: >> [你通常不会收到来自 krzk@kernel.org 的电子邮件。请访问 https://aka.ms/LearnAboutSenderIdentification，以了解这一点为什么很重要] >> >> On 03/07/2023 11:04, Yangtao Li wrote: >>> 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. >> >> ... >> >>> +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, >>> + irq_handler_t handler, irq_handler_t thread_fn, >>> + unsigned long irqflags, const char *devname, >>> + void *dev_id, const char *emsg) >>> +{ >>> + int rc; >>> + >>> + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, >>> + devname, dev_id); >>> + if (rc && rc != -EPROBE_DEFER) { >>> + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", >>> + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), >>> + emsg ? : "", ERR_PTR(rc)); >> It is open-coding dev_err_probe(). Just use dev_err_probe instead. > > > How about the following? If possible, I would like to start modifying > more drivers in the next version. > > > int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, > irq_handler_t handler, irq_handler_t > thread_fn, > unsigned long irqflags, const char > *devname, > void *dev_id, const char *emsg) > { > int rc; > > rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, > devname, dev_id); > if (rc) { > dev_err_probe(dev, rc, "Failed to request %sinterrupt > %u %s %s\n", > thread_fn ? "threaded " : "", irq, > devname ? : dev_name(dev), > emsg ? : ""); That's not the syntax already used - see existing code with `git grep`. Instead - return dev_err_probe(). Best regards, Krzysztof
Hello Krzysztof, On Mon, Jul 03, 2023 at 02:31:59PM +0200, Krzysztof Kozlowski wrote: > On 03/07/2023 11:04, Yangtao Li wrote: > > 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. > > > ... > > > +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, > > + irq_handler_t handler, irq_handler_t thread_fn, > > + unsigned long irqflags, const char *devname, > > + void *dev_id, const char *emsg) > > +{ > > + int rc; > > + > > + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, > > + devname, dev_id); > > + if (rc && rc != -EPROBE_DEFER) { > > + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", > > + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), > > + emsg ? : "", ERR_PTR(rc)); > > It is open-coding dev_err_probe(). Just use dev_err_probe instead. dev_err_probe is supposed to be only called in probe functions, while devm_request_threaded_irq might be called in other contexts (e.g. when a device is opened). That's why I asked to not use dev_err_probe() in v2 (IIRC). Best regards Uwe
On 03/07/2023 19:43, Uwe Kleine-König wrote: > Hello Krzysztof, > > On Mon, Jul 03, 2023 at 02:31:59PM +0200, Krzysztof Kozlowski wrote: >> On 03/07/2023 11:04, Yangtao Li wrote: >>> 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. >> >> >> ... >> >>> +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, >>> + irq_handler_t handler, irq_handler_t thread_fn, >>> + unsigned long irqflags, const char *devname, >>> + void *dev_id, const char *emsg) >>> +{ >>> + int rc; >>> + >>> + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, >>> + devname, dev_id); >>> + if (rc && rc != -EPROBE_DEFER) { >>> + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", >>> + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), >>> + emsg ? : "", ERR_PTR(rc)); >> >> It is open-coding dev_err_probe(). Just use dev_err_probe instead. > > dev_err_probe is supposed to be only called in probe functions, while > devm_request_threaded_irq might be called in other contexts (e.g. when a > device is opened). That's why I asked to not use dev_err_probe() in v2 True, but then all the callers of this function will forget to set deferred probe reason. Best regards, Krzysztof
On 2023/7/4 16:48, Krzysztof Kozlowski wrote: > [你通常不会收到来自 krzk@kernel.org 的电子邮件。请访问 https://aka.ms/LearnAboutSenderIdentification，以了解这一点为什么很重要] > > On 03/07/2023 19:43, Uwe Kleine-König wrote: >> Hello Krzysztof, >> >> On Mon, Jul 03, 2023 at 02:31:59PM +0200, Krzysztof Kozlowski wrote: >>> On 03/07/2023 11:04, Yangtao Li wrote: >>>> 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. >>> >>> ... >>> >>>> +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, >>>> + irq_handler_t handler, irq_handler_t thread_fn, >>>> + unsigned long irqflags, const char *devname, >>>> + void *dev_id, const char *emsg) >>>> +{ >>>> + int rc; >>>> + >>>> + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, >>>> + devname, dev_id); >>>> + if (rc && rc != -EPROBE_DEFER) { >>>> + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", >>>> + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), >>>> + emsg ? : "", ERR_PTR(rc)); >>> It is open-coding dev_err_probe(). Just use dev_err_probe instead. >> dev_err_probe is supposed to be only called in probe functions, while >> devm_request_threaded_irq might be called in other contexts (e.g. when a >> device is opened). That's why I asked to not use dev_err_probe() in v2 > True, but then all the callers of this function will forget to set > deferred probe reason. So let's use dev_err_probe? BTW, any suggestions for names here, keep using devm_request_threaded_irq_emsg or change to a new name? I am afraid that after more drivers are changed in the follow-up series, the name will need to be changed again. Thx, Yangtao > > Best regards, > Krzysztof >
Hello, On Tue, Jul 04, 2023 at 05:06:12PM +0800, Yangtao Li wrote: > On 2023/7/4 16:48, Krzysztof Kozlowski wrote: > > > [你通常不会收到来自 krzk@kernel.org 的电子邮件。请访问 https://aka.ms/LearnAboutSenderIdentification，以了解这一点为什么很重要] > > > > On 03/07/2023 19:43, Uwe Kleine-König wrote: > > > Hello Krzysztof, > > > > > > On Mon, Jul 03, 2023 at 02:31:59PM +0200, Krzysztof Kozlowski wrote: > > > > On 03/07/2023 11:04, Yangtao Li wrote: > > > > > 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. > > > > > > > > ... > > > > > > > > > +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, > > > > > + irq_handler_t handler, irq_handler_t thread_fn, > > > > > + unsigned long irqflags, const char *devname, > > > > > + void *dev_id, const char *emsg) > > > > > +{ > > > > > + int rc; > > > > > + > > > > > + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, > > > > > + devname, dev_id); > > > > > + if (rc && rc != -EPROBE_DEFER) { > > > > > + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", > > > > > + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), > > > > > + emsg ? : "", ERR_PTR(rc)); > > > > It is open-coding dev_err_probe(). Just use dev_err_probe instead. > > > dev_err_probe is supposed to be only called in probe functions, while > > > devm_request_threaded_irq might be called in other contexts (e.g. when a > > > device is opened). That's why I asked to not use dev_err_probe() in v2 > > True, but then all the callers of this function will forget to set > > deferred probe reason. That's another reason for letting the driver issue the error message and not the request_irq function. > So let's use dev_err_probe? > > BTW, any suggestions for names here, keep using > devm_request_threaded_irq_emsg or change to a new name? I would have called it devm_request_threaded_irq_verbose() which I consider easier to understand. But maybe that is just my (green) bikeshed. Best regards Uwe
On Tue, 4 Jul 2023 16:19:54 +0200 Uwe Kleine-König <u.kleine-koenig@pengutronix.de> wrote: > Hello, > > On Tue, Jul 04, 2023 at 05:06:12PM +0800, Yangtao Li wrote: > > On 2023/7/4 16:48, Krzysztof Kozlowski wrote: > > > > > [你通常不会收到来自 krzk@kernel.org 的电子邮件。请访问 https://aka.ms/LearnAboutSenderIdentification，以了解这一点为什么很重要] > > > > > > On 03/07/2023 19:43, Uwe Kleine-König wrote: > > > > Hello Krzysztof, > > > > > > > > On Mon, Jul 03, 2023 at 02:31:59PM +0200, Krzysztof Kozlowski wrote: > > > > > On 03/07/2023 11:04, Yangtao Li wrote: > > > > > > 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. > > > > > > > > > > ... > > > > > > > > > > > +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, > > > > > > + irq_handler_t handler, irq_handler_t thread_fn, > > > > > > + unsigned long irqflags, const char *devname, > > > > > > + void *dev_id, const char *emsg) > > > > > > +{ > > > > > > + int rc; > > > > > > + > > > > > > + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, > > > > > > + devname, dev_id); > > > > > > + if (rc && rc != -EPROBE_DEFER) { > > > > > > + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", > > > > > > + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), > > > > > > + emsg ? : "", ERR_PTR(rc)); > > > > > It is open-coding dev_err_probe(). Just use dev_err_probe instead. > > > > dev_err_probe is supposed to be only called in probe functions, while > > > > devm_request_threaded_irq might be called in other contexts (e.g. when a > > > > device is opened). That's why I asked to not use dev_err_probe() in v2 > > > True, but then all the callers of this function will forget to set > > > deferred probe reason. > > That's another reason for letting the driver issue the error message and > not the request_irq function. > > > So let's use dev_err_probe? > > > > BTW, any suggestions for names here, keep using > > devm_request_threaded_irq_emsg or change to a new name? > > I would have called it devm_request_threaded_irq_verbose() which I > consider easier to understand. But maybe is just my (green) > bikeshed. If going to use dev_err_probe() internally maybe can just use devm_request_threaded_irq_probe() thus reflecting that and making it different to the devm_request_threaded_irq()? I'm not sure we need to call out the fact it prints an error message in the naming. Maybe the fact it should probably only be used in probe() is the more relevant information? Bikesheds should all be red! Jonathan > > Best regards > Uwe >
Hello, On Wed, Jul 05, 2023 at 10:15:37AM +0800, Jonathan Cameron wrote: > On Tue, 4 Jul 2023 16:19:54 +0200 > Uwe Kleine-König <u.kleine-koenig@pengutronix.de> wrote: > > > Hello, > > > > On Tue, Jul 04, 2023 at 05:06:12PM +0800, Yangtao Li wrote: > > > On 2023/7/4 16:48, Krzysztof Kozlowski wrote: > > > > > > > [你通常不会收到来自 krzk@kernel.org 的电子邮件。请访问 https://aka.ms/LearnAboutSenderIdentification，以了解这一点为什么很重要] > > > > > > > > On 03/07/2023 19:43, Uwe Kleine-König wrote: > > > > > Hello Krzysztof, > > > > > > > > > > On Mon, Jul 03, 2023 at 02:31:59PM +0200, Krzysztof Kozlowski wrote: > > > > > > On 03/07/2023 11:04, Yangtao Li wrote: > > > > > > > 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. > > > > > > > > > > > > ... > > > > > > > > > > > > > +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, > > > > > > > + irq_handler_t handler, irq_handler_t thread_fn, > > > > > > > + unsigned long irqflags, const char *devname, > > > > > > > + void *dev_id, const char *emsg) > > > > > > > +{ > > > > > > > + int rc; > > > > > > > + > > > > > > > + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, > > > > > > > + devname, dev_id); > > > > > > > + if (rc && rc != -EPROBE_DEFER) { > > > > > > > + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", > > > > > > > + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), > > > > > > > + emsg ? : "", ERR_PTR(rc)); > > > > > > It is open-coding dev_err_probe(). Just use dev_err_probe instead. > > > > > dev_err_probe is supposed to be only called in probe functions, while > > > > > devm_request_threaded_irq might be called in other contexts (e.g. when a > > > > > device is opened). That's why I asked to not use dev_err_probe() in v2 > > > > True, but then all the callers of this function will forget to set > > > > deferred probe reason. > > > > That's another reason for letting the driver issue the error message and > > not the request_irq function. > > > > > So let's use dev_err_probe? > > > > > > BTW, any suggestions for names here, keep using > > > devm_request_threaded_irq_emsg or change to a new name? > > > > I would have called it devm_request_threaded_irq_verbose() which I > > consider easier to understand. But maybe is just my (green) > > bikeshed. > > If going to use dev_err_probe() internally maybe can just use > devm_request_threaded_irq_probe() thus reflecting that and making > it different to the devm_request_threaded_irq()? I like devm_request_threaded_irq_probe(), thanks for that suggestion (even though it's red :-) Best regards Uwe
On 2023/7/5 15:30, Uwe Kleine-König wrote: > Hello, > > On Wed, Jul 05, 2023 at 10:15:37AM +0800, Jonathan Cameron wrote: >> On Tue, 4 Jul 2023 16:19:54 +0200 >> Uwe Kleine-König <u.kleine-koenig@pengutronix.de> wrote: >> >>> Hello, >>> >>> On Tue, Jul 04, 2023 at 05:06:12PM +0800, Yangtao Li wrote: >>>> On 2023/7/4 16:48, Krzysztof Kozlowski wrote: >>>> >>>>> [你通常不会收到来自 krzk@kernel.org 的电子邮件。请访问 https://aka.ms/LearnAboutSenderIdentification，以了解这一点为什么很重要] >>>>> >>>>> On 03/07/2023 19:43, Uwe Kleine-König wrote: >>>>>> Hello Krzysztof, >>>>>> >>>>>> On Mon, Jul 03, 2023 at 02:31:59PM +0200, Krzysztof Kozlowski wrote: >>>>>>> On 03/07/2023 11:04, Yangtao Li wrote: >>>>>>>> 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. >>>>>>> ... >>>>>>> >>>>>>>> +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, >>>>>>>> + irq_handler_t handler, irq_handler_t thread_fn, >>>>>>>> + unsigned long irqflags, const char *devname, >>>>>>>> + void *dev_id, const char *emsg) >>>>>>>> +{ >>>>>>>> + int rc; >>>>>>>> + >>>>>>>> + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, >>>>>>>> + devname, dev_id); >>>>>>>> + if (rc && rc != -EPROBE_DEFER) { >>>>>>>> + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", >>>>>>>> + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), >>>>>>>> + emsg ? : "", ERR_PTR(rc)); >>>>>>> It is open-coding dev_err_probe(). Just use dev_err_probe instead. >>>>>> dev_err_probe is supposed to be only called in probe functions, while >>>>>> devm_request_threaded_irq might be called in other contexts (e.g. when a >>>>>> device is opened). That's why I asked to not use dev_err_probe() in v2 >>>>> True, but then all the callers of this function will forget to set >>>>> deferred probe reason. >>> That's another reason for letting the driver issue the error message and >>> not the request_irq function. >>> >>>> So let's use dev_err_probe? >>>> >>>> BTW, any suggestions for names here, keep using >>>> devm_request_threaded_irq_emsg or change to a new name? >>> I would have called it devm_request_threaded_irq_verbose() which I >>> consider easier to understand. But maybe is just my (green) >>> bikeshed. >> If going to use dev_err_probe() internally maybe can just use >> devm_request_threaded_irq_probe() thus reflecting that and making >> it different to the devm_request_threaded_irq()? > I like devm_request_threaded_irq_probe(), thanks for that suggestion > (even though it's red :-) devm_request_threaded_irq_probe() also sounds good to me, :-) If there is no objection, I think it's time to start working on switching the api. int devm_request_threaded_irq_probe(struct device *dev, unsigned int irq, irq_handler_t handler, irq_handler_t thread_fn, unsigned long irqflags, const char *devname, void *dev_id, const char *info) { int rc; rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, devname, dev_id); if (rc) return dev_err_probe(dev, rc, "Failed to request %sinterrupt %u %s %s\n", thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), info ? : ""); return 0; } EXPORT_SYMBOL(devm_request_threaded_irq_probe); MBR, Yangtao > > Best regards > Uwe >
I don't know what's wrong with the email client that caused the line break to be abnormal.
I used git send-email to resend this.
int devm_request_threaded_irq_probe(struct device *dev, unsigned int irq,
irq_handler_t handler, irq_handler_t thread_fn,
unsigned long irqflags, const char *devname,
void *dev_id, const char *info)
{
int rc;
rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, devname, dev_id);
if (rc)
return dev_err_probe(dev, rc, "Failed to request %sinterrupt %u %s %s\n",
thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev),
info ? : "");
return 0;
}
EXPORT_SYMBOL(devm_request_threaded_irq_probe);
Thx,
Yangtao
Il 05/07/23 09:43, Yangtao Li ha scritto: > On 2023/7/5 15:30, Uwe Kleine-König wrote: > >> Hello, >> >> On Wed, Jul 05, 2023 at 10:15:37AM +0800, Jonathan Cameron wrote: >>> On Tue, 4 Jul 2023 16:19:54 +0200 >>> Uwe Kleine-König <u.kleine-koenig@pengutronix.de> wrote: >>> >>>> Hello, >>>> >>>> On Tue, Jul 04, 2023 at 05:06:12PM +0800, Yangtao Li wrote: >>>>> On 2023/7/4 16:48, Krzysztof Kozlowski wrote: >>>>>> [你通常不会收到来自 krzk@kernel.org 的电子邮件。请访问 https://aka.ms >>>>>> /LearnAboutSenderIdentification，以了解这一点为什么很重要] >>>>>> >>>>>> On 03/07/2023 19:43, Uwe Kleine-König wrote: >>>>>>> Hello Krzysztof, >>>>>>> >>>>>>> On Mon, Jul 03, 2023 at 02:31:59PM +0200, Krzysztof Kozlowski wrote: >>>>>>>> On 03/07/2023 11:04, Yangtao Li wrote: >>>>>>>>> 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. >>>>>>>> ... >>>>>>>>> +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, >>>>>>>>> + irq_handler_t handler, irq_handler_t >>>>>>>>> thread_fn, >>>>>>>>> + unsigned long irqflags, const char *devname, >>>>>>>>> + void *dev_id, const char *emsg) >>>>>>>>> +{ >>>>>>>>> + int rc; >>>>>>>>> + >>>>>>>>> + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, >>>>>>>>> + devname, dev_id); >>>>>>>>> + if (rc && rc != -EPROBE_DEFER) { >>>>>>>>> + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", >>>>>>>>> + thread_fn ? "threaded " : "", irq, devname ? : >>>>>>>>> dev_name(dev), >>>>>>>>> + emsg ? : "", ERR_PTR(rc)); >>>>>>>> It is open-coding dev_err_probe(). Just use dev_err_probe instead. >>>>>>> dev_err_probe is supposed to be only called in probe functions, while >>>>>>> devm_request_threaded_irq might be called in other contexts (e.g. when a >>>>>>> device is opened). That's why I asked to not use dev_err_probe() in v2 >>>>>> True, but then all the callers of this function will forget to set >>>>>> deferred probe reason. >>>> That's another reason for letting the driver issue the error message and >>>> not the request_irq function. >>>>> So let's use dev_err_probe? >>>>> >>>>> BTW, any suggestions for names here, keep using >>>>> devm_request_threaded_irq_emsg or change to a new name? >>>> I would have called it devm_request_threaded_irq_verbose() which I >>>> consider easier to understand. But maybe is just my (green) >>>> bikeshed. >>> If going to use dev_err_probe() internally maybe can just use >>> devm_request_threaded_irq_probe() thus reflecting that and making >>> it different to the devm_request_threaded_irq()? >> I like devm_request_threaded_irq_probe(), thanks for that suggestion >> (even though it's red :-) > > > devm_request_threaded_irq_probe() also sounds good to me, :-) If there is no > objection, I think it's time to start working on switching the api. > +1 on devm_request_threaded_irq_probe() name, makes sense to me, as it'd be using the same error logic as dev_err_probe() (no prints if -EPROBE_DEFER), and also.. this is a function that's anyway used in .probe() callbacks at least in the *vast* majority of the cases. Cheers, Angelo > int devm_request_threaded_irq_probe(struct device *dev, unsigned int irq, > irq_handler_t handler, irq_handler_t thread_fn, unsigned long irqflags, const char > *devname, void *dev_id, const char *info) { int rc; rc = > devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, devname, dev_id); if > (rc) return dev_err_probe(dev, rc, "Failed to request %sinterrupt %u %s %s\n", > thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), info ? : ""); return > 0; } EXPORT_SYMBOL(devm_request_threaded_irq_probe); MBR, Yangtao > > >> >> Best regards >> Uwe >>
diff --git a/include/linux/interrupt.h b/include/linux/interrupt.h index a92bce40b04b..cde034006e3e 100644 --- a/include/linux/interrupt.h +++ b/include/linux/interrupt.h @@ -201,6 +201,12 @@ extern void free_percpu_nmi(unsigned int irq, void __percpu *percpu_dev_id); struct device; +extern int __must_check +devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, + irq_handler_t handler, irq_handler_t thread_fn, + unsigned long irqflags, const char *devname, + void *dev_id, const char *emsg); + extern int __must_check devm_request_threaded_irq(struct device *dev, unsigned int irq, irq_handler_t handler, irq_handler_t thread_fn, diff --git a/kernel/irq/devres.c b/kernel/irq/devres.c index f6e5515ee077..f2e669ccd5d4 100644 --- a/kernel/irq/devres.c +++ b/kernel/irq/devres.c @@ -79,6 +79,48 @@ int devm_request_threaded_irq(struct device *dev, unsigned int irq, } EXPORT_SYMBOL(devm_request_threaded_irq); +/** + * devm_request_threaded_irq_emsg - allocate an interrupt line for a managed device + * @dev: device to request interrupt for + * @irq: Interrupt line to allocate + * @handler: Function to be called when the IRQ occurs + * @thread_fn: function to be called in a threaded interrupt context. NULL + * for devices which handle everything in @handler + * @irqflags: Interrupt type flags + * @devname: An ascii name for the claiming device, dev_name(dev) if NULL + * @dev_id: A cookie passed back to the handler function + * @emsg: Optional additional error log + * + * This is a variant of the devm_request_threaded_irq function. + * It will print an error message by default when the request fails, + * and the consumer can add a special error msg. + * + * Except for the extra @dev argument, this function takes the + * same arguments and performs the same function as + * request_threaded_irq(). IRQs requested with this function will be + * automatically freed on driver detach. + * + * If an IRQ allocated with this function needs to be freed + * separately, devm_free_irq() must be used. + */ +int devm_request_threaded_irq_emsg(struct device *dev, unsigned int irq, + irq_handler_t handler, irq_handler_t thread_fn, + unsigned long irqflags, const char *devname, + void *dev_id, const char *emsg) +{ + int rc; + + rc = devm_request_threaded_irq(dev, irq, handler, NULL, irqflags, + devname, dev_id); + if (rc && rc != -EPROBE_DEFER) { + dev_err(dev, "Failed to request %sinterrupt %u %s %s: %pe\n", + thread_fn ? "threaded " : "", irq, devname ? : dev_name(dev), + emsg ? : "", ERR_PTR(rc)); + } + return rc; +} +EXPORT_SYMBOL(devm_request_threaded_irq_emsg); + /** * devm_request_any_context_irq - allocate an interrupt line for a managed device * @dev: device to request interrupt for
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. So add 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> --- include/linux/interrupt.h | 6 ++++++ kernel/irq/devres.c | 42 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+)