2015-11-12 07:26:14

by Corentin Labbe

[permalink] [raw]
Subject: [PATCH] i2c: tegra: fix a possible NULL dereference

of_match_device could return NULL, and so cause a NULL pointer
dereference later at line 809:
i2c_dev->hw = match->data;

Signed-off-by: LABBE Corentin <[email protected]>
---
drivers/i2c/busses/i2c-tegra.c | 3 +++
1 file changed, 3 insertions(+)

diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c
index a0522fc..c803551 100644
--- a/drivers/i2c/busses/i2c-tegra.c
+++ b/drivers/i2c/busses/i2c-tegra.c
@@ -806,7 +806,10 @@ static int tegra_i2c_probe(struct platform_device *pdev)

if (pdev->dev.of_node) {
const struct of_device_id *match;
+
match = of_match_device(tegra_i2c_of_match, &pdev->dev);
+ if (!match)
+ return -ENODEV;
i2c_dev->hw = match->data;
i2c_dev->is_dvc = of_device_is_compatible(pdev->dev.of_node,
"nvidia,tegra20-i2c-dvc");
--
2.4.10


2015-11-12 12:29:28

by Thierry Reding

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference

On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
> of_match_device could return NULL, and so cause a NULL pointer

No. There is no way that of_match_device() can ever fail. The driver
core uses the same table to match the OF device to the driver, so the
only case where of_match_device() would return NULL is if no match was
found, in which case the tegra_i2c_probe() function would never have
been called in the first place.

Thierry

> dereference later at line 809:
> i2c_dev->hw = match->data;
>
> Signed-off-by: LABBE Corentin <[email protected]>
> ---
> drivers/i2c/busses/i2c-tegra.c | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c
> index a0522fc..c803551 100644
> --- a/drivers/i2c/busses/i2c-tegra.c
> +++ b/drivers/i2c/busses/i2c-tegra.c
> @@ -806,7 +806,10 @@ static int tegra_i2c_probe(struct platform_device *pdev)
>
> if (pdev->dev.of_node) {
> const struct of_device_id *match;
> +
> match = of_match_device(tegra_i2c_of_match, &pdev->dev);
> + if (!match)
> + return -ENODEV;
> i2c_dev->hw = match->data;
> i2c_dev->is_dvc = of_device_is_compatible(pdev->dev.of_node,
> "nvidia,tegra20-i2c-dvc");
> --
> 2.4.10
>


Attachments:
(No filename) (1.23 kB)
signature.asc (819.00 B)
Download all attachments

2015-11-12 12:54:29

by LABBE Corentin

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference

On Thu, Nov 12, 2015 at 01:29:23PM +0100, Thierry Reding wrote:
> On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
> > of_match_device could return NULL, and so cause a NULL pointer
>
> No. There is no way that of_match_device() can ever fail. The driver
> core uses the same table to match the OF device to the driver, so the
> only case where of_match_device() would return NULL is if no match was
> found, in which case the tegra_i2c_probe() function would never have
> been called in the first place.
>
> Thierry
>

In a parallel thread for i2c-rcar, the conclusion was different.
https://lkml.org/lkml/2015/11/12/83

Regards

2015-11-12 13:28:42

by Thierry Reding

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference

On Thu, Nov 12, 2015 at 01:54:22PM +0100, LABBE Corentin wrote:
> On Thu, Nov 12, 2015 at 01:29:23PM +0100, Thierry Reding wrote:
> > On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
> > > of_match_device could return NULL, and so cause a NULL pointer
> >
> > No. There is no way that of_match_device() can ever fail. The driver
> > core uses the same table to match the OF device to the driver, so the
> > only case where of_match_device() would return NULL is if no match was
> > found, in which case the tegra_i2c_probe() function would never have
> > been called in the first place.
> >
> > Thierry
> >
>
> In a parallel thread for i2c-rcar, the conclusion was different.
> https://lkml.org/lkml/2015/11/12/83

The conclusion was the same: there should be no case where this happens.
The example that Uwe gave is hypothetical and not valid DT in the first
place. So instead of chickening out I think it'd be better to just crash
to make sure people fix the DT.

On a side-note I think that platform_match() should be stricter and do
something like this instead:

if (dev->of_node) {
if (of_driver_match_device(dev, drv))
return 1;

return 0;
}

Thierry


Attachments:
(No filename) (1.16 kB)
signature.asc (819.00 B)
Download all attachments

2015-11-12 13:41:26

by Jon Hunter

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference


On 12/11/15 12:29, Thierry Reding wrote:
> * PGP Signed by an unknown key
>
> On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
>> of_match_device could return NULL, and so cause a NULL pointer
>
> No. There is no way that of_match_device() can ever fail. The driver
> core uses the same table to match the OF device to the driver, so the
> only case where of_match_device() would return NULL is if no match was
> found, in which case the tegra_i2c_probe() function would never have
> been called in the first place.

Right and so ...

>> dereference later at line 809:
>> i2c_dev->hw = match->data;
>>
>> Signed-off-by: LABBE Corentin <[email protected]>
>> ---
>> drivers/i2c/busses/i2c-tegra.c | 3 +++
>> 1 file changed, 3 insertions(+)
>>
>> diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c
>> index a0522fc..c803551 100644
>> --- a/drivers/i2c/busses/i2c-tegra.c
>> +++ b/drivers/i2c/busses/i2c-tegra.c
>> @@ -806,7 +806,10 @@ static int tegra_i2c_probe(struct platform_device *pdev)
>>
>> if (pdev->dev.of_node) {

Can we get rid of this if-statement?

Jon

2015-11-12 13:45:30

by Uwe Kleine-König

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference

On Thu, Nov 12, 2015 at 02:28:37PM +0100, Thierry Reding wrote:
> On Thu, Nov 12, 2015 at 01:54:22PM +0100, LABBE Corentin wrote:
> > On Thu, Nov 12, 2015 at 01:29:23PM +0100, Thierry Reding wrote:
> > > On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
> > > > of_match_device could return NULL, and so cause a NULL pointer
> > >
> > > No. There is no way that of_match_device() can ever fail. The driver
> > > core uses the same table to match the OF device to the driver, so the
> > > only case where of_match_device() would return NULL is if no match was
> > > found, in which case the tegra_i2c_probe() function would never have
> > > been called in the first place.
> > >
> > > Thierry
> > >
> >
> > In a parallel thread for i2c-rcar, the conclusion was different.
> > https://lkml.org/lkml/2015/11/12/83
>
> The conclusion was the same: there should be no case where this happens.
> The example that Uwe gave is hypothetical and not valid DT in the first
> place. So instead of chickening out I think it'd be better to just crash
> to make sure people fix the DT.

It depends in your trust in the DT. Just because it's not advisable to
do something that is not documented usually isn't a good excuse to not
handle broken input. That't the case for webserver requests, arguments
to system calls and several more. I admit DT is a bit special because
you have to assume it's trusted, but still handling errors in a sane way
is IMHO nice.

> On a side-note I think that platform_match() should be stricter and do
> something like this instead:
>
> if (dev->of_node) {
> if (of_driver_match_device(dev, drv))
> return 1;
>
> return 0;
> }
That's equivalent to

if (dev->of_node)
return of_driver_match_device(dev, drv);

and was already suggested in the thread referenced from my reply to
http://article.gmane.org/gmane.linux.kernel/2083641 :-)

Best regards
Uwe

--
Pengutronix e.K. | Uwe Kleine-K?nig |
Industrial Linux Solutions | http://www.pengutronix.de/ |

2015-11-12 13:55:07

by Thierry Reding

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference

On Thu, Nov 12, 2015 at 02:45:20PM +0100, Uwe Kleine-König wrote:
> On Thu, Nov 12, 2015 at 02:28:37PM +0100, Thierry Reding wrote:
> > On Thu, Nov 12, 2015 at 01:54:22PM +0100, LABBE Corentin wrote:
> > > On Thu, Nov 12, 2015 at 01:29:23PM +0100, Thierry Reding wrote:
> > > > On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
> > > > > of_match_device could return NULL, and so cause a NULL pointer
> > > >
> > > > No. There is no way that of_match_device() can ever fail. The driver
> > > > core uses the same table to match the OF device to the driver, so the
> > > > only case where of_match_device() would return NULL is if no match was
> > > > found, in which case the tegra_i2c_probe() function would never have
> > > > been called in the first place.
> > > >
> > > > Thierry
> > > >
> > >
> > > In a parallel thread for i2c-rcar, the conclusion was different.
> > > https://lkml.org/lkml/2015/11/12/83
> >
> > The conclusion was the same: there should be no case where this happens.
> > The example that Uwe gave is hypothetical and not valid DT in the first
> > place. So instead of chickening out I think it'd be better to just crash
> > to make sure people fix the DT.
>
> It depends in your trust in the DT. Just because it's not advisable to
> do something that is not documented usually isn't a good excuse to not
> handle broken input. That't the case for webserver requests, arguments
> to system calls and several more. I admit DT is a bit special because
> you have to assume it's trusted, but still handling errors in a sane way
> is IMHO nice.

Given that it's supposed to be provided by firmware and possibly from a
ROM, crashing might be a better motivation for fixing it than erroring
out, which people might just ignore or not notice until it's too late.

> > On a side-note I think that platform_match() should be stricter and do
> > something like this instead:
> >
> > if (dev->of_node) {
> > if (of_driver_match_device(dev, drv))
> > return 1;
> >
> > return 0;
> > }
> That's equivalent to
>
> if (dev->of_node)
> return of_driver_match_device(dev, drv);
>
> and was already suggested in the thread referenced from my reply to
> http://article.gmane.org/gmane.linux.kernel/2083641 :-)

Ah, too many cross-reference =) FWIW:

Acked-by: Thierry Reding <[email protected]>

If we want to gracefully handle this, then let's do it in the core by
making sure that drivers where it would return NULL are never probed,
rather than coding this check in every single driver.

Thierry


Attachments:
(No filename) (2.48 kB)
signature.asc (819.00 B)
Download all attachments

2015-11-12 13:55:54

by Thierry Reding

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference

On Thu, Nov 12, 2015 at 01:40:56PM +0000, Jon Hunter wrote:
>
> On 12/11/15 12:29, Thierry Reding wrote:
> > * PGP Signed by an unknown key
> >
> > On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
> >> of_match_device could return NULL, and so cause a NULL pointer
> >
> > No. There is no way that of_match_device() can ever fail. The driver
> > core uses the same table to match the OF device to the driver, so the
> > only case where of_match_device() would return NULL is if no match was
> > found, in which case the tegra_i2c_probe() function would never have
> > been called in the first place.
>
> Right and so ...
>
> >> dereference later at line 809:
> >> i2c_dev->hw = match->data;
> >>
> >> Signed-off-by: LABBE Corentin <[email protected]>
> >> ---
> >> drivers/i2c/busses/i2c-tegra.c | 3 +++
> >> 1 file changed, 3 insertions(+)
> >>
> >> diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c
> >> index a0522fc..c803551 100644
> >> --- a/drivers/i2c/busses/i2c-tegra.c
> >> +++ b/drivers/i2c/busses/i2c-tegra.c
> >> @@ -806,7 +806,10 @@ static int tegra_i2c_probe(struct platform_device *pdev)
> >>
> >> if (pdev->dev.of_node) {
>
> Can we get rid of this if-statement?

Yeah, I guess we can drop that, too. It's been a long time since Tegra
was converted to OF only.

Thierry


Attachments:
(No filename) (1.32 kB)
signature.asc (819.00 B)
Download all attachments

2015-11-12 14:55:06

by Corentin Labbe

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference

On Thu, Nov 12, 2015 at 02:55:00PM +0100, Thierry Reding wrote:
> On Thu, Nov 12, 2015 at 02:45:20PM +0100, Uwe Kleine-K?nig wrote:
> > On Thu, Nov 12, 2015 at 02:28:37PM +0100, Thierry Reding wrote:
> > > On Thu, Nov 12, 2015 at 01:54:22PM +0100, LABBE Corentin wrote:
> > > > On Thu, Nov 12, 2015 at 01:29:23PM +0100, Thierry Reding wrote:
> > > > > On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
> > > > > > of_match_device could return NULL, and so cause a NULL pointer
> > > > >
> > > > > No. There is no way that of_match_device() can ever fail. The driver
> > > > > core uses the same table to match the OF device to the driver, so the
> > > > > only case where of_match_device() would return NULL is if no match was
> > > > > found, in which case the tegra_i2c_probe() function would never have
> > > > > been called in the first place.
> > > > >
> > > > > Thierry
> > > > >
> > > >
> > > > In a parallel thread for i2c-rcar, the conclusion was different.
> > > > https://lkml.org/lkml/2015/11/12/83
> > >
> > > The conclusion was the same: there should be no case where this happens.
> > > The example that Uwe gave is hypothetical and not valid DT in the first
> > > place. So instead of chickening out I think it'd be better to just crash
> > > to make sure people fix the DT.
> >
> > It depends in your trust in the DT. Just because it's not advisable to
> > do something that is not documented usually isn't a good excuse to not
> > handle broken input. That't the case for webserver requests, arguments
> > to system calls and several more. I admit DT is a bit special because
> > you have to assume it's trusted, but still handling errors in a sane way
> > is IMHO nice.
>
> Given that it's supposed to be provided by firmware and possibly from a
> ROM, crashing might be a better motivation for fixing it than erroring
> out, which people might just ignore or not notice until it's too late.
>
> > > On a side-note I think that platform_match() should be stricter and do
> > > something like this instead:
> > >
> > > if (dev->of_node) {
> > > if (of_driver_match_device(dev, drv))
> > > return 1;
> > >
> > > return 0;
> > > }
> > That's equivalent to
> >
> > if (dev->of_node)
> > return of_driver_match_device(dev, drv);
> >
> > and was already suggested in the thread referenced from my reply to
> > http://article.gmane.org/gmane.linux.kernel/2083641 :-)
>
> Ah, too many cross-reference =) FWIW:
>
> Acked-by: Thierry Reding <[email protected]>
>

Just for be sure, since the thread goes in lot of direction, you ack my patch ?
Perhaps is it better that I resent a version which use of_device_get_match_data() ?

Regards

2015-11-12 16:14:19

by Thierry Reding

[permalink] [raw]
Subject: Re: [PATCH] i2c: tegra: fix a possible NULL dereference

On Thu, Nov 12, 2015 at 03:54:58PM +0100, LABBE Corentin wrote:
> On Thu, Nov 12, 2015 at 02:55:00PM +0100, Thierry Reding wrote:
> > On Thu, Nov 12, 2015 at 02:45:20PM +0100, Uwe Kleine-König wrote:
> > > On Thu, Nov 12, 2015 at 02:28:37PM +0100, Thierry Reding wrote:
> > > > On Thu, Nov 12, 2015 at 01:54:22PM +0100, LABBE Corentin wrote:
> > > > > On Thu, Nov 12, 2015 at 01:29:23PM +0100, Thierry Reding wrote:
> > > > > > On Thu, Nov 12, 2015 at 08:26:03AM +0100, LABBE Corentin wrote:
> > > > > > > of_match_device could return NULL, and so cause a NULL pointer
> > > > > >
> > > > > > No. There is no way that of_match_device() can ever fail. The driver
> > > > > > core uses the same table to match the OF device to the driver, so the
> > > > > > only case where of_match_device() would return NULL is if no match was
> > > > > > found, in which case the tegra_i2c_probe() function would never have
> > > > > > been called in the first place.
> > > > > >
> > > > > > Thierry
> > > > > >
> > > > >
> > > > > In a parallel thread for i2c-rcar, the conclusion was different.
> > > > > https://lkml.org/lkml/2015/11/12/83
> > > >
> > > > The conclusion was the same: there should be no case where this happens.
> > > > The example that Uwe gave is hypothetical and not valid DT in the first
> > > > place. So instead of chickening out I think it'd be better to just crash
> > > > to make sure people fix the DT.
> > >
> > > It depends in your trust in the DT. Just because it's not advisable to
> > > do something that is not documented usually isn't a good excuse to not
> > > handle broken input. That't the case for webserver requests, arguments
> > > to system calls and several more. I admit DT is a bit special because
> > > you have to assume it's trusted, but still handling errors in a sane way
> > > is IMHO nice.
> >
> > Given that it's supposed to be provided by firmware and possibly from a
> > ROM, crashing might be a better motivation for fixing it than erroring
> > out, which people might just ignore or not notice until it's too late.
> >
> > > > On a side-note I think that platform_match() should be stricter and do
> > > > something like this instead:
> > > >
> > > > if (dev->of_node) {
> > > > if (of_driver_match_device(dev, drv))
> > > > return 1;
> > > >
> > > > return 0;
> > > > }
> > > That's equivalent to
> > >
> > > if (dev->of_node)
> > > return of_driver_match_device(dev, drv);
> > >
> > > and was already suggested in the thread referenced from my reply to
> > > http://article.gmane.org/gmane.linux.kernel/2083641 :-)
> >
> > Ah, too many cross-reference =) FWIW:
> >
> > Acked-by: Thierry Reding <[email protected]>
> >
>
> Just for be sure, since the thread goes in lot of direction, you ack my patch ?
> Perhaps is it better that I resent a version which use of_device_get_match_data() ?

No, the Acked-by was for Uwe's proposal to modify platform_match(). I
think if we want to gracefully handle these cases, then the right way to
do so is by having the driver core not fallback to name matches for
devices instantiated from device tree.

Sorry for being unclear.

Thierry


Attachments:
(No filename) (3.08 kB)
signature.asc (819.00 B)
Download all attachments