nvmem: core: Fix race in nvmem_register()
PATCH 1/1 nvmem: core: Fix race in nvmem_register()
nvmem_register() currently registers the device before adding the nvmem cells, which creates a race window where consumers may find the nvmem device (and not get PROBE_DEFERred), but then fail to find the cells and error out.
Move device registration to the end of nvmem_register(), to close the race.
Observed when the stars line up on Apple Silicon machines with the (not yet upstream, but trivial) spmi nvmem driver and the macsmc-rtc client:
[ 0.487375] macsmc-rtc macsmc-rtc: error -ENOENT: Failed to get rtc_offset NVMEM cell
--- drivers/nvmem/core.c | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-)
drivers/nvmem/core.c +8 -10
@@ -837,20 +837,16 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config)dev_dbg (&nvmem->dev,"Registering nvmem device %s\n" , config->name); - rval =device_register (&nvmem->dev); -if (rval) - goto err_put_device; -if (nvmem->nkeepout) { rval =nvmem_validate_keepouts (nvmem);if (rval) - goto err_device_del; +return ERR_PTR (rval); }if (config->compat) { rval =nvmem_sysfs_setup_compat (nvmem, config);if (rval) - goto err_device_del; +return ERR_PTR (rval); }if (config->cells) {
@@ -867,19 +863,21 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config)if (rval) goto err_remove_cells; + rval =device_register (&nvmem->dev); +if (rval) + goto err_put_device; +blocking_notifier_call_chain (&nvmem_notifier,NVMEM_ADD , nvmem);return nvmem; +err_put_device: +put_device (&nvmem->dev); err_remove_cells:nvmem_device_remove_all_cells (nvmem); err_teardown_compat:if (config->compat)nvmem_sysfs_remove_compat (nvmem, config); -err_device_del: -device_del (&nvmem->dev); -err_put_device: -put_device (&nvmem->dev);return ERR_PTR (rval); }
--
2.35.1
Quoted 9 lines · Hector Martin
nvmem_register()currently registers the device before adding the nvmem cells, which creates a race window where consumers may find the nvmem device (and not getPROBE_DEFERred), but then fail to find the cells and error out.Move device registration to the end of
nvmem_register(), to close the race.
Quoted 7 lines
Observed when the stars line up on Apple Silicon machines with the (not yet upstream, but trivial) spmi nvmem driver and the macsmc-rtc client:
[ 0.487375] macsmc-rtc macsmc-rtc: error -ENOENT: Failed to get rtc_offset NVMEM cellFixes eace75cfdcf7 ("nvmem: Add a simple NVMEM framework for nvmem providers")Signed-off-by Hector Martin <[email protected]>
Quoted 61 lines
--- drivers/nvmem/core.c | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-)drivers/nvmem/core.c +8
-11@@ -837,20 +837,16 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config)dev_dbg (&nvmem->dev,"Registering nvmem device %s\n" , config->name); - rval =device_register (&nvmem->dev); -if (rval) - goto err_put_device; -if (nvmem->nkeepout) { rval =nvmem_validate_keepouts (nvmem);if (rval) - goto err_device_del; +return ERR_PTR (rval); }if (config->compat) { rval =nvmem_sysfs_setup_compat (nvmem, config);if (rval) - goto err_device_del; +return ERR_PTR (rval); }if (config->cells) {@@ -867,19 +863,21 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config)if (rval) goto err_remove_cells; + rval =device_register (&nvmem->dev); +if (rval) + goto err_put_device; +blocking_notifier_call_chain (&nvmem_notifier,NVMEM_ADD , nvmem);return nvmem; +err_put_device: +put_device (&nvmem->dev); err_remove_cells:nvmem_device_remove_all_cells (nvmem); err_teardown_compat:if (config->compat)nvmem_sysfs_remove_compat (nvmem, config); -err_device_del: -device_del (&nvmem->dev); -err_put_device: -put_device (&nvmem->dev);return ERR_PTR (rval); } --2.35.1
Thanks Hector for the patch,
Quoted 8 lines · Hector Martin
nvmem_register()currently registers the device before adding the nvmem cells, which creates a race window where consumers may find the nvmem device (and not getPROBE_DEFERred), but then fail to find the cells and error out.Move device registration to the end of
nvmem_register(), to close the race.
Quoted 7 lines
Observed when the stars line up on Apple Silicon machines with the (not yet upstream, but trivial) spmi nvmem driver and the macsmc-rtc client:
[ 0.487375] macsmc-rtc macsmc-rtc: error -ENOENT: Failed to get rtc_offset NVMEM cellFixes eace75cfdcf7 ("nvmem: Add a simple NVMEM framework for nvmem providers")Signed-off-by Hector Martin <[email protected]>
Missing Cc Stable
Quoted 11 lines
--- drivers/nvmem/core.c | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-)drivers/nvmem/core.c +0
-0@@ -837,20 +837,16 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config)dev_dbg (&nvmem->dev,"Registering nvmem device %s\n" , config->name);
drivers/nvmem/core.c struct nvmem_device *nvmem_register(const struct nvmem_config *config) · line 843
Quoted 10 lines
drivers/nvmem/core.c +1
-5- rval =device_register (&nvmem->dev); -if (rval) - goto err_put_device; -if (nvmem->nkeepout) { rval =nvmem_validate_keepouts (nvmem);if (rval) - goto err_device_del; +return ERR_PTR (rval);
you can not do this as this will leak ida and nvmem itself.
drivers/nvmem/core.c struct nvmem_device *nvmem_register(const struct nvmem_config *config) · line 849
Quoted 7 lines
drivers/nvmem/core.c +1
-1}if (config->compat) { rval =nvmem_sysfs_setup_compat (nvmem, config);if (rval) - goto err_device_del; +return ERR_PTR (rval);
same here.
Quoted 7 lines
drivers/nvmem/core.c +0
-0}if (config->cells) {@@ -867,19 +863,21 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config)if (rval) goto err_remove_cells;
drivers/nvmem/core.c struct nvmem_device *nvmem_register(const struct nvmem_config *config) · line 875
Quoted 10 lines
drivers/nvmem/core.c +6
-0+ rval =device_register (&nvmem->dev); +if (rval) + goto err_put_device; +blocking_notifier_call_chain (&nvmem_notifier,NVMEM_ADD , nvmem);return nvmem; +err_put_device: +put_device (&nvmem->dev);
this will free nvmem and further down you are going to de-reference the freed pointer.
--srini
Quoted 15 lines
drivers/nvmem/core.c +0
-5err_remove_cells:nvmem_device_remove_all_cells (nvmem); err_teardown_compat:if (config->compat)nvmem_sysfs_remove_compat (nvmem, config); -err_device_del: -device_del (&nvmem->dev); -err_put_device: -put_device (&nvmem->dev);return ERR_PTR (rval); } --2.35.1