platform: Fix race condition during DMA configure at IOMMU probe time
PATCH 1/1 platform: Fix race condition during DMA configure at IOMMU probe time
If devices are probed asynchronously, then there is a chance that during the IOMMU probe the driver is bound to the device in parallel. If this happens after getting the platform_driver pointer while in the function platform_dma_configure(), then the invalid drv pointer (drv==0xf...ffd8) will be de-referenced since dev->driver != NULL.
To avoid a kernel panic and eliminate the race condition, we should guard the usage of dev->driver by only reading it once at the beginning of the function.
--- drivers/base/platform.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
drivers/base/platform.c +4 -3
@@ -1440,7 +1440,8 @@ static void platform_shutdown(struct device *_dev)static int platform_dma_configure (struct device *dev) { -struct platform_driver *drv =to_platform_driver (dev->driver); +struct device_driver *drv =READ_ONCE (dev->driver); +struct platform_driver *pdrv =to_platform_driver (drv);struct fwnode_handle *fwnode =dev_fwnode (dev);enum dev_dma_attr attr;int ret =0 ;
@@ -1451,8 +1452,8 @@ static int platform_dma_configure(struct device *dev) attr =acpi_get_dma_attr (to_acpi_device_node (fwnode)); ret =acpi_dma_configure (dev, attr); } -/* @drv may not be valid when we're called from the IOMMU layer */ -if (ret || !dev->driver || drv->driver_managed_dma) +/* @dev->driver may not be valid when we're called from the IOMMU layer */ +if (ret || !drv || pdrv->driver_managed_dma)return ret; ret =iommu_device_use_default_domain (dev);
Signature · 1 line
2.49.0.805.g082f7c87e0-goog
Quoted 5 lines · Will McVicker
If devices are probed asynchronously, then there is a chance that during the IOMMU probe the driver is bound to the device in parallel. If this happens after getting the
platform_driverpointer while in the functionplatform_dma_configure(), then the invaliddrvpointer (drv==0xf...ffd8) will be de-referenced sincedev->driver != NULL.
I need a little more hand-holding to make sense out of this.
After digging out
https://lore.kernel.org/all/[email protected]/, I see that drv==0xf...ffd8 must be a result of applying to_platform_driver() to a NULL pointer. This patch still applies to_platform_driver(NULL), but avoids using the result by testing drv for NULL later, which seems prone to error.
I think this would all be clearer if we tested for the NULL pointer explicitly before applying to_platform_driver(). I don't like setting a pointer to an invalid value. I think it's better if the pointer is either valid or uninitialized because the compiler can help find uses of uninitialized pointers.
Quoted 38 lines
To avoid a kernel panic and eliminate the race condition, we should guard the usage of
dev->driverby only reading it once at the beginning of the function.Fixes bcb81ac6ae3c ("iommu: Get DT/ACPI parsing into the proper probe path")Signed-off-by Will McVicker <[email protected]>--- drivers/base/platform.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)drivers/base/platform.c +4
-3@@ -1440,7 +1440,8 @@ static void platform_shutdown(struct device *_dev)static int platform_dma_configure (struct device *dev) { -struct platform_driver *drv =to_platform_driver (dev->driver); +struct device_driver *drv =READ_ONCE (dev->driver); +struct platform_driver *pdrv =to_platform_driver (drv);struct fwnode_handle *fwnode =dev_fwnode (dev);enum dev_dma_attr attr;int ret =0 ;@@ -1451,8 +1452,8 @@ static int platform_dma_configure(struct device *dev) attr =acpi_get_dma_attr (to_acpi_device_node (fwnode)); ret =acpi_dma_configure (dev, attr); } -/* @drv may not be valid when we're called from the IOMMU layer */ -if (ret || !dev->driver || drv->driver_managed_dma) +/* @dev->driver may not be valid when we're called from the IOMMU layer */ +if (ret || !drv || pdrv->driver_managed_dma)return ret; ret =iommu_device_use_default_domain (dev);Signature · 1 line
2.49.0.805.g082f7c87e0-goog
Quoted 16 lines · Bjorn Helgaas
Quoted 5 lines · Will McVicker
If devices are probed asynchronously, then there is a chance that during the IOMMU probe the driver is bound to the device in parallel. If this happens after getting the
platform_driverpointer while in the functionplatform_dma_configure(), then the invaliddrvpointer (drv==0xf...ffd8) will be de-referenced sincedev->driver != NULL.I need a little more hand-holding to make sense out of this.
After digging out
https://lore.kernel.org/all/[email protected]/, I see that drv==0xf...ffd8 must be a result of applyingto_platform_driver()to a NULL pointer. This patch still appliesto_platform_driver(NULL), but avoids using the result by testing drv for NULL later, which seems prone to error.
Quoted 5 lines
I think this would all be clearer if we tested for the NULL pointer explicitly before applying
to_platform_driver(). I don't like setting a pointer to an invalid value. I think it's better if the pointer is either valid or uninitialized because the compiler can help find uses of uninitialized pointers.
Yeah, I was also in the middle of looking at this after managing to hit it playing with driver_async_probe at the end of last week. I guess when I originally wrote this pattern I was maybe thinking the compiler would defer the to_x_driver() computation to the point it's eventually dereferenced, but I suppose it can't since dev is passed to an external function in program order in between.
Indeed in my half-written version of this patch I was leaning towards removing the drv variable altogether (just doing to_x_driver(dev->driver)->driver_managed_dma inline), or at least doing the same as Will's previous diff. I figure the one-liner replacing "!dev->driver" with "!&drv->driver" would be too disgustingly non-obvious for anyone else's tastes...
For consistency we should really fix all the buses the same way - sorry for the bother (I can write up the other patches if you'd like). FWIW this part really was the most temporary stopgap, as my planned next step is to propose moving driver_managed_dma and the use_default_domain() call up into the driver core and so removing all this bus-level code anyway, hence trying to minimise the effort spent churning it. Oh well.
Quoted 16 lines
Quoted 16 lines
To avoid a kernel panic and eliminate the race condition, we should guard the usage of
dev->driverby only reading it once at the beginning of the function.Fixes bcb81ac6ae3c ("iommu: Get DT/ACPI parsing into the proper probe path")Signed-off-by Will McVicker <[email protected]>--- drivers/base/platform.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)drivers/base/platform.c +0
-0@@ -1440,7 +1440,8 @@ static void platform_shutdown(struct device *_dev)
Quoted 4 lines
drivers/base/platform.c static void platform_shutdown(struct device *_dev) · line 1443
Quoted 4 lines
drivers/base/platform.c +1
-1static int platform_dma_configure (struct device *dev) { -struct platform_driver *drv =to_platform_driver (dev->driver); +struct device_driver *drv =READ_ONCE (dev->driver);
Beware this might annoy a different set of people as it's not paired with a WRITE_ONCE(), but for now I guess using it is still arguably better than not. Really we should be under device_lock at this point and so have no race at all, but we can't do that without keeping track of which devices are IOMMUs themselves to avoid deadlock, and that's not something I fancy throwing out as an -rc fix in a hurry...
Thanks,
Robin.
Quoted 18 lines
Quoted 18 lines
drivers/base/platform.c +3
-2+struct platform_driver *pdrv =to_platform_driver (drv);struct fwnode_handle *fwnode =dev_fwnode (dev);enum dev_dma_attr attr;int ret =0 ;@@ -1451,8 +1452,8 @@ static int platform_dma_configure(struct device *dev) attr =acpi_get_dma_attr (to_acpi_device_node (fwnode)); ret =acpi_dma_configure (dev, attr); } -/* @drv may not be valid when we're called from the IOMMU layer */ -if (ret || !dev->driver || drv->driver_managed_dma) +/* @dev->driver may not be valid when we're called from the IOMMU layer */ +if (ret || !drv || pdrv->driver_managed_dma)return ret; ret =iommu_device_use_default_domain (dev);Signature · 1 line
2.49.0.805.g082f7c87e0-goog
Quoted 6 lines · Robin Murphy
Indeed in my half-written version of this patch I was leaning towards removing the drv variable altogether (just doing to_x_driver(dev->driver)->driver_managed_dma inline), or at least doing the same as Will's previous diff. I figure the one-liner replacing "!dev->driver" with "!&drv->driver" would be too disgustingly non-obvious for anyone else's tastes...
The READ_ONCE alerts the reader that something weird is going on here :\
Quoted 6 lines
For consistency we should really fix all the buses the same way - sorry for the bother (I can write up the other patches if you'd like). FWIW this part really was the most temporary stopgap, as my planned next step is to propose moving
driver_managed_dmaand theuse_default_domain()call up into the driver core and so removing all this bus-level code anyway, hence trying to minimise the effort spent churning it. Oh well.
It started out this way but Greg really didn't want it, so this was the compromise. Perhaps you can convince Greg of the merit.
Jason
Quoted 9 lines · Robin Murphy
Quoted 8 lines · Bjorn Helgaas
Quoted 5 lines · Will McVicker
If devices are probed asynchronously, then there is a chance that during the IOMMU probe the driver is bound to the device in parallel. If this happens after getting the
platform_driverpointer while in the functionplatform_dma_configure(), then the invaliddrvpointer (drv==0xf...ffd8) will be de-referenced sincedev->driver != NULL.I need a little more hand-holding to make sense out of this.
Sorry for not making it super clear :/ I was trying to find the right balance between being too verbose and not clear enough. I guess a threaded call flow might help visually demonstrate the race condition.
Quoted 14 lines
Quoted 8 lines
After digging out
https://lore.kernel.org/all/[email protected]/, I see that drv==0xf...ffd8 must be a result of applyingto_platform_driver()to a NULL pointer. This patch still appliesto_platform_driver(NULL), but avoids using the result by testing drv for NULL later, which seems prone to error.Quoted 5 lines
I think this would all be clearer if we tested for the NULL pointer explicitly before applying
to_platform_driver(). I don't like setting a pointer to an invalid value. I think it's better if the pointer is either valid or uninitialized because the compiler can help find uses of uninitialized pointers.
Quoted 6 lines
Yeah, I was also in the middle of looking at this after managing to hit it playing with
driver_async_probeat the end of last week. I guess when I originally wrote this pattern I was maybe thinking the compiler would defer theto_x_driver()computation to the point it's eventually dereferenced, but I suppose it can't since dev is passed to an external function in program order in between.
Glad to hear I'm not the only one hitting this. I agree we should test for the NULL pointer first before trying to get the platform driver. I'll send a v2 for this.
Quoted 10 lines
Indeed in my half-written version of this patch I was leaning towards removing the drv variable altogether (just doing to_x_driver(dev->driver)->driver_managed_dma inline), or at least doing the same as Will's previous diff. I figure the one-liner replacing "!dev->driver" with "!&drv->driver" would be too disgustingly non-obvious for anyone else's tastes...
For consistency we should really fix all the buses the same way - sorry for the bother (I can write up the other patches if you'd like). FWIW this part
Yes please. Thanks!
Quoted 32 lines
really was the most temporary stopgap, as my planned next step is to propose moving
driver_managed_dmaand theuse_default_domain()call up into the driver core and so removing all this bus-level code anyway, hence trying to minimise the effort spent churning it. Oh well.Quoted 10 lines
Quoted 10 lines
To avoid a kernel panic and eliminate the race condition, we should guard the usage of
dev->driverby only reading it once at the beginning of the function.Fixes bcb81ac6ae3c ("iommu: Get DT/ACPI parsing into the proper probe path")Signed-off-by Will McVicker <[email protected]>--- drivers/base/platform.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)Quoted 9 lines
drivers/base/platform.c static void platform_shutdown(struct device *_dev) · line 1442
Quoted 9 lines
drivers/base/platform.c +1
-1@@ -1440,7 +1440,8 @@ static void platform_shutdown(struct device *_dev)static int platform_dma_configure (struct device *dev) { -struct platform_driver *drv =to_platform_driver (dev->driver); +struct device_driver *drv =READ_ONCE (dev->driver);Beware this might annoy a different set of people as it's not paired with a
WRITE_ONCE(), but for now I guess using it is still arguably better than not. Really we should be underdevice_lockat this point and so have no race at all, but we can't do that without keeping track of which devices are IOMMUs themselves to avoid deadlock, and that's not something I fancy throwing out as an -rc fix in a hurry...
Quoted 2 lines
Thanks,
Robin.
Thanks again!
--Will
Quoted 19 lines
Quoted 18 lines
Quoted 18 lines
drivers/base/platform.c +3
-2+struct platform_driver *pdrv =to_platform_driver (drv);struct fwnode_handle *fwnode =dev_fwnode (dev);enum dev_dma_attr attr;int ret =0 ;@@ -1451,8 +1452,8 @@ static int platform_dma_configure(struct device *dev) attr =acpi_get_dma_attr (to_acpi_device_node (fwnode)); ret =acpi_dma_configure (dev, attr); } -/* @drv may not be valid when we're called from the IOMMU layer */ -if (ret || !dev->driver || drv->driver_managed_dma) +/* @dev->driver may not be valid when we're called from the IOMMU layer */ +if (ret || !drv || pdrv->driver_managed_dma)return ret; ret =iommu_device_use_default_domain (dev);Signature · 1 line
2.49.0.805.g082f7c87e0-goog
Quoted 5 lines · Bjorn Helgaas
I think this would all be clearer if we tested for the NULL pointer explicitly before applying
to_platform_driver(). I don't like setting a pointer to an invalid value. I think it's better if the pointer is either valid or uninitialized because the compiler can help find uses of uninitialized pointers.
+1
Jason