diff mbox series

[v2] remoteproc: use %pe format string to print return error code

Message ID 20211102141535.28372-1-mark-pk.tsai@mediatek.com (mailing list archive)
State New, archived
Headers show
Series [v2] remoteproc: use %pe format string to print return error code | expand

Commit Message

Mark-PK Tsai (蔡沛剛) Nov. 2, 2021, 2:15 p.m. UTC
Use %pe format string to print return error code which
make the error message easier to understand.

Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
---
 drivers/remoteproc/remoteproc_core.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Mathieu Poirier Nov. 11, 2021, 6:18 p.m. UTC | #1
Hi Mark,

On Tue, 2 Nov 2021 at 08:15, Mark-PK Tsai <mark-pk.tsai@mediatek.com> wrote:
>
> Use %pe format string to print return error code which
> make the error message easier to understand.
>
> Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
> ---
>  drivers/remoteproc/remoteproc_core.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
> index 502b6604b757..2242da320368 100644
> --- a/drivers/remoteproc/remoteproc_core.c
> +++ b/drivers/remoteproc/remoteproc_core.c
> @@ -575,8 +575,8 @@ static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
>                                            dma_get_mask(rproc->dev.parent));
>         if (ret) {
>                 dev_warn(dev,
> -                        "Failed to set DMA mask %llx. Trying to continue... %x\n",
> -                        dma_get_mask(rproc->dev.parent), ret);
> +                        "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
> +                        dma_get_mask(rproc->dev.parent), ERR_PTR(ret));

Macro ERR_PTR() is used to convert error codes to pointer type when
returning from a function - I fail to see how doing so in a dev_warn()
context can make the message easier to understand.  Can you provide an
example?

Thanks,
Mathieu

>         }
>
>         /* parse the vrings */
> --
> 2.18.0
>
Mark-PK Tsai (蔡沛剛) Nov. 12, 2021, 2:13 a.m. UTC | #2
> Hi Mark,
>
>
> >
> > Use %pe format string to print return error code which
> > make the error message easier to understand.
> >
> > Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
> > ---
> >  drivers/remoteproc/remoteproc_core.c | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
> > index 502b6604b757..2242da320368 100644
> > --- a/drivers/remoteproc/remoteproc_core.c
> > +++ b/drivers/remoteproc/remoteproc_core.c
> > @@ -575,8 +575,8 @@ static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
> >                                            dma_get_mask(rproc->dev.parent));
> >         if (ret) {
> >                 dev_warn(dev,
> > -                        "Failed to set DMA mask %llx. Trying to continue... %x\n",
> > -                        dma_get_mask(rproc->dev.parent), ret);
> > +                        "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
> > +                        dma_get_mask(rproc->dev.parent), ERR_PTR(ret));
>
> Macro ERR_PTR() is used to convert error codes to pointer type when
> returning from a function - I fail to see how doing so in a dev_warn()
> context can make the message easier to understand.  Can you provide an
> example?

Hi,

When dma_coerce_mask_and_coherent() fail, the output log will be as following.

format		log
%x		Trying to continue... fffffffb
%d		Trying to continue... -5
%pe		Trying to continue... -5	(if CONFIG_SYMBOLIC_ERRNAME is not set)
%pe		Trying to continue... -EIO	(if CONFIG_SYMBOLIC_ERRNAME=y)
Mathieu Poirier Nov. 12, 2021, 4:25 p.m. UTC | #3
On Thu, 11 Nov 2021 at 19:13, Mark-PK Tsai <mark-pk.tsai@mediatek.com> wrote:
>
> > Hi Mark,
> >
> >
> > >
> > > Use %pe format string to print return error code which
> > > make the error message easier to understand.
> > >
> > > Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
> > > ---
> > >  drivers/remoteproc/remoteproc_core.c | 4 ++--
> > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > >
> > > diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
> > > index 502b6604b757..2242da320368 100644
> > > --- a/drivers/remoteproc/remoteproc_core.c
> > > +++ b/drivers/remoteproc/remoteproc_core.c
> > > @@ -575,8 +575,8 @@ static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
> > >                                            dma_get_mask(rproc->dev.parent));
> > >         if (ret) {
> > >                 dev_warn(dev,
> > > -                        "Failed to set DMA mask %llx. Trying to continue... %x\n",
> > > -                        dma_get_mask(rproc->dev.parent), ret);
> > > +                        "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
> > > +                        dma_get_mask(rproc->dev.parent), ERR_PTR(ret));
> >
> > Macro ERR_PTR() is used to convert error codes to pointer type when
> > returning from a function - I fail to see how doing so in a dev_warn()
> > context can make the message easier to understand.  Can you provide an
> > example?
>
> Hi,
>
> When dma_coerce_mask_and_coherent() fail, the output log will be as following.
>
> format          log
> %x              Trying to continue... fffffffb
> %d              Trying to continue... -5
> %pe             Trying to continue... -5        (if CONFIG_SYMBOLIC_ERRNAME is not set)
> %pe             Trying to continue... -EIO      (if CONFIG_SYMBOLIC_ERRNAME=y)

When failing, functions dma_coerce_mask_and_coherent() returns -EIO.
Casting that to a (void *) with ERR_PTR() does not change that value.
Since variable @ret is already declared as "int" the real fix is to
change "%x" to "%d".
Mark-PK Tsai (蔡沛剛) Nov. 16, 2021, 1:57 p.m. UTC | #4
> > > > Use %pe format string to print return error code which
> > > > make the error message easier to understand.
> > > >
> > > > Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
> > > > ---
> > > >  drivers/remoteproc/remoteproc_core.c | 4 ++--
> > > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > > >
> > > > diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
> > > > index 502b6604b757..2242da320368 100644
> > > > --- a/drivers/remoteproc/remoteproc_core.c
> > > > +++ b/drivers/remoteproc/remoteproc_core.c
> > > > @@ -575,8 +575,8 @@ static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
> > > >                                            dma_get_mask(rproc->dev.parent));
> > > >         if (ret) {
> > > >                 dev_warn(dev,
> > > > -                        "Failed to set DMA mask %llx. Trying to continue... %x\n",
> > > > -                        dma_get_mask(rproc->dev.parent), ret);
> > > > +                        "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
> > > > +                        dma_get_mask(rproc->dev.parent), ERR_PTR(ret));
> > >
> > > Macro ERR_PTR() is used to convert error codes to pointer type when
> > > returning from a function - I fail to see how doing so in a dev_warn()
> > > context can make the message easier to understand.  Can you provide an
> > > example?
> >
> > Hi,
> >
> > When dma_coerce_mask_and_coherent() fail, the output log will be as following.
> >
> > format          log
> > %x              Trying to continue... fffffffb
> > %d              Trying to continue... -5
> > %pe             Trying to continue... -5        (if CONFIG_SYMBOLIC_ERRNAME is not set)
> > %pe             Trying to continue... -EIO      (if CONFIG_SYMBOLIC_ERRNAME=y)
>
> When failing, functions dma_coerce_mask_and_coherent() returns -EIO.
> Casting that to a (void *) with ERR_PTR() does not change that value.
> Since variable @ret is already declared as "int" the real fix is to
> change "%x" to "%d".

There're some other drivers do the same thing in the recent kernel, so I think
it's fine to casting the `ret` to a (void *) for more user friendly.
But I suppose it would depend on the maintainer's opinion.

So how about previous patch I sent, which also fix this issue by using %d.

https://lore.kernel.org/lkml/20211102120805.27137-1-mark-pk.tsai@mediatek.com/
Mathieu Poirier Nov. 16, 2021, 4:29 p.m. UTC | #5
Good day,

On Tue, Nov 16, 2021 at 09:57:03PM +0800, Mark-PK Tsai wrote:
> > > > > Use %pe format string to print return error code which
> > > > > make the error message easier to understand.
> > > > >
> > > > > Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
> > > > > ---
> > > > >  drivers/remoteproc/remoteproc_core.c | 4 ++--
> > > > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > > > >
> > > > > diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
> > > > > index 502b6604b757..2242da320368 100644
> > > > > --- a/drivers/remoteproc/remoteproc_core.c
> > > > > +++ b/drivers/remoteproc/remoteproc_core.c
> > > > > @@ -575,8 +575,8 @@ static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
> > > > >                                            dma_get_mask(rproc->dev.parent));
> > > > >         if (ret) {
> > > > >                 dev_warn(dev,
> > > > > -                        "Failed to set DMA mask %llx. Trying to continue... %x\n",
> > > > > -                        dma_get_mask(rproc->dev.parent), ret);
> > > > > +                        "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
> > > > > +                        dma_get_mask(rproc->dev.parent), ERR_PTR(ret));
> > > >
> > > > Macro ERR_PTR() is used to convert error codes to pointer type when
> > > > returning from a function - I fail to see how doing so in a dev_warn()
> > > > context can make the message easier to understand.  Can you provide an
> > > > example?
> > >
> > > Hi,
> > >
> > > When dma_coerce_mask_and_coherent() fail, the output log will be as following.
> > >
> > > format          log
> > > %x              Trying to continue... fffffffb
> > > %d              Trying to continue... -5
> > > %pe             Trying to continue... -5        (if CONFIG_SYMBOLIC_ERRNAME is not set)
> > > %pe             Trying to continue... -EIO      (if CONFIG_SYMBOLIC_ERRNAME=y)
> >
> > When failing, functions dma_coerce_mask_and_coherent() returns -EIO.
> > Casting that to a (void *) with ERR_PTR() does not change that value.
> > Since variable @ret is already declared as "int" the real fix is to
> > change "%x" to "%d".
> 
> There're some other drivers do the same thing in the recent kernel, so I think
> it's fine to casting the `ret` to a (void *) for more user friendly.
> But I suppose it would depend on the maintainer's opinion.
> 
> So how about previous patch I sent, which also fix this issue by using %d.
> 
> https://lore.kernel.org/lkml/20211102120805.27137-1-mark-pk.tsai@mediatek.com/

I had not seen Russell's reply in the link you posted above.  I am not
completely sure about his solution but his insight and guidance in kernel
programming have precedence over mine.

I will take this patch.

Thanks,
Mathieu


>
Bjorn Andersson Nov. 17, 2021, 2:59 p.m. UTC | #6
On Tue 02 Nov 09:15 CDT 2021, Mark-PK Tsai wrote:

> Use %pe format string to print return error code which
> make the error message easier to understand.
> 

Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>

> Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
> ---
>  drivers/remoteproc/remoteproc_core.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
> index 502b6604b757..2242da320368 100644
> --- a/drivers/remoteproc/remoteproc_core.c
> +++ b/drivers/remoteproc/remoteproc_core.c
> @@ -575,8 +575,8 @@ static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
>  					   dma_get_mask(rproc->dev.parent));
>  	if (ret) {
>  		dev_warn(dev,
> -			 "Failed to set DMA mask %llx. Trying to continue... %x\n",
> -			 dma_get_mask(rproc->dev.parent), ret);
> +			 "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
> +			 dma_get_mask(rproc->dev.parent), ERR_PTR(ret));
>  	}
>  
>  	/* parse the vrings */
> -- 
> 2.18.0
>
Mark-PK Tsai (蔡沛剛) Dec. 13, 2021, 7:20 a.m. UTC | #7
> Good day,
> 
> On Tue, Nov 16, 2021 at 09:57:03PM +0800, Mark-PK Tsai wrote:
> > > > > > Use %pe format string to print return error code which
> > > > > > make the error message easier to understand.
> > > > > >
> > > > > > Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
> > > > > > ---
> > > > > >  drivers/remoteproc/remoteproc_core.c | 4 ++--
> > > > > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > > > > >
> > > > > > diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
> > > > > > index 502b6604b757..2242da320368 100644
> > > > > > --- a/drivers/remoteproc/remoteproc_core.c
> > > > > > +++ b/drivers/remoteproc/remoteproc_core.c
> > > > > > @@ -575,8 +575,8 @@ static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
> > > > > >                                            dma_get_mask(rproc->dev.parent));
> > > > > >         if (ret) {
> > > > > >                 dev_warn(dev,
> > > > > > -                        "Failed to set DMA mask %llx. Trying to continue... %x\n",
> > > > > > -                        dma_get_mask(rproc->dev.parent), ret);
> > > > > > +                        "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
> > > > > > +                        dma_get_mask(rproc->dev.parent), ERR_PTR(ret));
> > > > >
> > > > > Macro ERR_PTR() is used to convert error codes to pointer type when
> > > > > returning from a function - I fail to see how doing so in a dev_warn()
> > > > > context can make the message easier to understand.  Can you provide an
> > > > > example?
> > > >
> > > > Hi,
> > > >
> > > > When dma_coerce_mask_and_coherent() fail, the output log will be as following.
> > > >
> > > > format          log
> > > > %x              Trying to continue... fffffffb
> > > > %d              Trying to continue... -5
> > > > %pe             Trying to continue... -5        (if CONFIG_SYMBOLIC_ERRNAME is not set)
> > > > %pe             Trying to continue... -EIO      (if CONFIG_SYMBOLIC_ERRNAME=y)
> > >
> > > When failing, functions dma_coerce_mask_and_coherent() returns -EIO.
> > > Casting that to a (void *) with ERR_PTR() does not change that value.
> > > Since variable @ret is already declared as "int" the real fix is to
> > > change "%x" to "%d".
> > 
> > There're some other drivers do the same thing in the recent kernel, so I think
> > it's fine to casting the `ret` to a (void *) for more user friendly.
> > But I suppose it would depend on the maintainer's opinion.
> > 
> > So how about previous patch I sent, which also fix this issue by using %d.
> > 
> > https://lore.kernel.org/lkml/20211102120805.27137-1-mark-pk.tsai@mediatek.com/
> 
> I had not seen Russell's reply in the link you posted above.  I am not
> completely sure about his solution but his insight and guidance in kernel
> programming have precedence over mine.
> 
> I will take this patch.
> 
> Thanks,
> Mathieu
> 

Hi,

Sorry to disturb you.
Is this patch queued?
Just want to make sure it has not been forgotten.
Mathieu Poirier Dec. 13, 2021, 4:55 p.m. UTC | #8
On Mon, Dec 13, 2021 at 03:20:15PM +0800, Mark-PK Tsai wrote:
> > Good day,
> > 
> > On Tue, Nov 16, 2021 at 09:57:03PM +0800, Mark-PK Tsai wrote:
> > > > > > > Use %pe format string to print return error code which
> > > > > > > make the error message easier to understand.
> > > > > > >
> > > > > > > Signed-off-by: Mark-PK Tsai <mark-pk.tsai@mediatek.com>
> > > > > > > ---
> > > > > > >  drivers/remoteproc/remoteproc_core.c | 4 ++--
> > > > > > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > > > > > >
> > > > > > > diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
> > > > > > > index 502b6604b757..2242da320368 100644
> > > > > > > --- a/drivers/remoteproc/remoteproc_core.c
> > > > > > > +++ b/drivers/remoteproc/remoteproc_core.c
> > > > > > > @@ -575,8 +575,8 @@ static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
> > > > > > >                                            dma_get_mask(rproc->dev.parent));
> > > > > > >         if (ret) {
> > > > > > >                 dev_warn(dev,
> > > > > > > -                        "Failed to set DMA mask %llx. Trying to continue... %x\n",
> > > > > > > -                        dma_get_mask(rproc->dev.parent), ret);
> > > > > > > +                        "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
> > > > > > > +                        dma_get_mask(rproc->dev.parent), ERR_PTR(ret));
> > > > > >
> > > > > > Macro ERR_PTR() is used to convert error codes to pointer type when
> > > > > > returning from a function - I fail to see how doing so in a dev_warn()
> > > > > > context can make the message easier to understand.  Can you provide an
> > > > > > example?
> > > > >
> > > > > Hi,
> > > > >
> > > > > When dma_coerce_mask_and_coherent() fail, the output log will be as following.
> > > > >
> > > > > format          log
> > > > > %x              Trying to continue... fffffffb
> > > > > %d              Trying to continue... -5
> > > > > %pe             Trying to continue... -5        (if CONFIG_SYMBOLIC_ERRNAME is not set)
> > > > > %pe             Trying to continue... -EIO      (if CONFIG_SYMBOLIC_ERRNAME=y)
> > > >
> > > > When failing, functions dma_coerce_mask_and_coherent() returns -EIO.
> > > > Casting that to a (void *) with ERR_PTR() does not change that value.
> > > > Since variable @ret is already declared as "int" the real fix is to
> > > > change "%x" to "%d".
> > > 
> > > There're some other drivers do the same thing in the recent kernel, so I think
> > > it's fine to casting the `ret` to a (void *) for more user friendly.
> > > But I suppose it would depend on the maintainer's opinion.
> > > 
> > > So how about previous patch I sent, which also fix this issue by using %d.
> > > 
> > > https://lore.kernel.org/lkml/20211102120805.27137-1-mark-pk.tsai@mediatek.com/
> > 
> > I had not seen Russell's reply in the link you posted above.  I am not
> > completely sure about his solution but his insight and guidance in kernel
> > programming have precedence over mine.
> > 
> > I will take this patch.
> > 
> > Thanks,
> > Mathieu
> > 
> 
> Hi,
> 
> Sorry to disturb you.
> Is this patch queued?
> Just want to make sure it has not been forgotten.

https://git.kernel.org/pub/scm/linux/kernel/git/remoteproc/linux.git/log/?h=for-next
Mark-PK Tsai (蔡沛剛) Dec. 14, 2021, 1:31 a.m. UTC | #9
> 
> https://git.kernel.org/pub/scm/linux/kernel/git/remoteproc/linux.git/log/?h=for-next
> 

Got it, thanks!
diff mbox series

Patch

diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c
index 502b6604b757..2242da320368 100644
--- a/drivers/remoteproc/remoteproc_core.c
+++ b/drivers/remoteproc/remoteproc_core.c
@@ -575,8 +575,8 @@  static int rproc_handle_vdev(struct rproc *rproc, void *ptr,
 					   dma_get_mask(rproc->dev.parent));
 	if (ret) {
 		dev_warn(dev,
-			 "Failed to set DMA mask %llx. Trying to continue... %x\n",
-			 dma_get_mask(rproc->dev.parent), ret);
+			 "Failed to set DMA mask %llx. Trying to continue... (%pe)\n",
+			 dma_get_mask(rproc->dev.parent), ERR_PTR(ret));
 	}
 
 	/* parse the vrings */