regmap: debugfs: Free debugfs_name buffer after usage
Subsystems (2)
PATCH v2 1/1 regmap: debugfs: Free debugfs_name buffer after usage
The following error message is seen when booting an imx6q-sabresd:
debugfs: Directory 'dummy-iomuxc-gpr@20e0000' with parent 'regmap' already present!
The reason for the duplicate name is that map->debugfs_name is never freed, which can cause a directory to be created with the same name used in the previous debugfs entry allocation.
Fix this problem by freeing map->debugfs_name and setting it to NULL after its usage.
---
Changes since v1:
- Avoid use after free (Mark).
drivers/base/regmap/regmap-debugfs.c | 3 +++ 1 file changed, 3 insertions(+)
drivers/base/regmap/regmap-debugfs.c +3 -0
@@ -605,6 +605,9 @@ void regmap_debugfs_init(struct regmap *map) map->debugfs =debugfs_create_dir (name, regmap_debugfs_root); +kfree (map->debugfs_name); + map->debugfs_name =NULL ; +debugfs_create_file ("name" ,0400 , map->debugfs, map, ®map_name_fops);
Signature · 1 line
2.25.1
Mark Brown
maintainerQuoted 6 lines · Fabio Estevam
The reason for the duplicate name is that
map->debugfs_nameis never freed, which can cause a directory to be created with the same name used in the previous debugfs entry allocation.Fix this problem by freeing
map->debugfs_nameand setting it to NULL after its usage.
OK, but what's the logic here? The name is getting thrown away here but clearly there is a file still so I'm not seeing how anything is going to clean that file up. That means that if the device gets freed we'll end up with the old debugfs file hanging around pointing at nothing. Like I said (originally in response to Matthias' patch but pasted in this thread as well):
| (we should probably clean up the one with no device but that's not what | your commit does). I think what you need to look at here is that we
The use after free extends beyond just the filename, we're also loosing track of the already created file, which does seem to be an existing bug. To be more explicit this means we need a call to regmap_debugfs_exit() which will clean up all the existing debugfs stuff before we loose references to it.
Hi Mark,
Quoted 1 line · Mark Brown
OK, but what's the logic here? The name is getting thrown away here but
I did more debugging and this is what I found:
The 'debugfs: Directory 'dummy-iomuxc-gpr@20e0000' with parent 'regmap' already present!' message
happens since commit cffa4b2122f5 ("regmap: debugfs: Fix a memory leak when calling regmap_attach_dev").
Prior to this commit map->debugfs_name would always be allocated via kasprintf().
After this commit, the allocation only happens when !map->debugfs_name.
This matches with my observations:
- The first allocation for dummy-iomuxc-gpr@20e0000 works as map->debugfs_name is NULL.
- The second time map->debugfs_name is not NULL, so there is no allocation via kasprintf(), and the map->debugfs_name uses the 'old' entry from the previous buffer.
This causes the directory name to be duplicated and fails to be created.
That's why clearing map->debugfs_name causes a new kasprintf() allocation and restores the correct behavior.
Prior to cffa4b2122f5 ("regmap: debugfs: Fix a memory leak when calling regmap_attach_dev"):
# mount -t debugfs none /sys/kernel/debug/ # cat /sys/kernel/debug/regmap/dummy-iomuxc-gpr@20e0000/registers 00: 00000000 04: 48611005 08: 0000000c 0c: 01e00000 10: f00000cf 14: 0000000e 18: 007f007f 1c: 007f007f 20: fffd4000 24: 00000000 28: 00003800 2c: 00000000 30: 0f004490 34: 0593e4a4 # cat /sys/kernel/debug/regmap/20e0000.pinctrl-gpr/registers 00: 00000000 04: 48611005 08: 0000000c 0c: 01e00000 10: f00000cf 14: 00000007 18: 007f007f 1c: 007f007f 20: fffd4000 24: 00000000 28: 00003800 2c: 00000000 30: 0f004490 34: 0593e4a4
After commit cffa4b2122f5 ("regmap: debugfs: Fix a memory leak when calling regmap_attach_dev):
The 'debugfs: Directory 'dummy-iomuxc-gpr@20e0000' with parent 'regmap' already present!' message is seen.
# cat /sys/kernel/debug/regmap/20e0000.pinctrl-gpr/registers cat: can't open '/sys/kernel/debug/regmap/20e0000.pinctrl-gpr/registers': No such file or directory
# cat /sys/kernel/debug/regmap/dummy-iomuxc-gpr@20e0000/registers 00: 00000000 04: 48611005 08: 0000000c 0c: 01e00000 10: f00000cf 14: 00000009 18: 007f007f 1c: 007f007f 20: fffd4000 24: 00000000 28: 00003800 2c: 00000000 30: 0f004490 34: 0593e4a4
Quoted 6 lines
clearly there is a file still so I'm not seeing how anything is going to clean that file up. That means that if the device gets freed we'll end up with the old debugfs file hanging around pointing at nothing. Like I said (originally in response to Matthias' patch but pasted in this thread as well):
Quoted 8 lines
| (we should probably clean up the one with no device but that's not what | your commit does). I think what you need to look at here is that we
The use after free extends beyond just the filename, we're also loosing track of the already created file, which does seem to be an existing bug. To be more explicit this means we need a call to
regmap_debugfs_exit()which will clean up all the existing debugfs stuff before we loose references to it.
As shown above, I don't see the ' /sys/kernel/debug/regmap/20e0000.pinctrl-gpr' directory being created, so there is nothing to clean.
Where exactly would you like me to call regmap_debugfs_exit()?
Thanks
Mark Brown
maintainerQuoted 9 lines · Fabio Estevam
Quoted 1 line · Mark Brown
OK, but what's the logic here? The name is getting thrown away here but
I did more debugging and this is what I found:
The 'debugfs: Directory 'dummy-iomuxc-gpr@20e0000' with parent 'regmap' already present!' message
happens since commitcffa4b2122f5("regmap: debugfs: Fix a memory leak when callingregmap_attach_dev").
Sure, but that just means that the bug with not cleaning up the directory predates that.
Quoted 4 lines
# mount -t debugfs none /sys/kernel/debug/ # cat /sys/kernel/debug/regmap/dummy-iomuxc-gpr@20e0000/registers 00: 00000000 04: 48611005
What happens if the underlying regmap gets freed for some reason? It now only remembers the new name, not this old one, so it'll only know to clean up the old name.
Quoted 3 lines
As shown above, I don't see the '
/sys/kernel/debug/regmap/20e0000.pinctrl-gpr' directory being created, so there is nothing to clean.
Creating that file is the behaviour you are demanding...
Quoted 1 line
Where exactly would you like me to call
regmap_debugfs_exit()?
Before we try to reinitialise debugfs for the new name seems like the obvious place.
Hi Mark,
Quoted 4 lines · Mark Brown
Quoted 1 line
Where exactly would you like me to call
regmap_debugfs_exit()?Before we try to reinitialise debugfs for the new name seems like the obvious place.
I am afraid I am not enough familiar with regmap to fix this problem.
If you could please submit a patch, I will be glad to test it.
Thanks
Hi Mark,
Quoted 5 lines · Fabio Estevam
Hi Mark,
On Thu, Jan 6, 2022 at 5:05 PM Mark Brown <[email protected]> wrote:
Quoted 8 lines
Quoted 4 lines
Quoted 1 line
Where exactly would you like me to call
regmap_debugfs_exit()?Before we try to reinitialise debugfs for the new name seems like the obvious place.
I am afraid I am not enough familiar with regmap to fix this problem.
If you could please submit a patch, I will be glad to test it.
I tried this change:
(quoted diff) +0 -0
b/drivers/base/regmap/regmap-debugfs.c
index ad684d37c2da..fa8821ecc06a 100644
drivers/base/regmap/regmap-debugfs.c +2 -0
@@ -581,6 +581,8 @@ void regmap_debugfs_init(struct regmap *map)if (map->dev) devname =dev_name (map->dev); +regmap_debugfs_exit (map); +if (name) {if (!map->debugfs_name) { map->debugfs_name = kasprintf(GFP_KERNEL, "%s-%s",
It does avoid the 'already present' error and I see that /sys/kernel/debug/regmap/20e0000.pinctrl-gpr
is present, but /sys/kernel/debug/regmap/20e0000.pinctrl-gpr is not. Not sure if this is the desired behavior.
Cheers
Mark Brown
maintainerQuoted 11 lines · Fabio Estevam
Quoted 6 lines · Fabio Estevam
Quoted 2 lines
Before we try to reinitialise debugfs for the new name seems like the obvious place.
I am afraid I am not enough familiar with regmap to fix this problem.
If you could please submit a patch, I will be glad to test it.
I tried this change:
drivers/base/regmap/regmap-debugfs.c void regmap_debugfs_init(struct regmap *map) · line 585
Quoted 5 lines
drivers/base/regmap/regmap-debugfs.c +2
-0@@ -581,6 +581,8 @@ void regmap_debugfs_init(struct regmap *map)if (map->dev) devname =dev_name (map->dev); +regmap_debugfs_exit (map); +
I would have expected this to be prior to the call to _init() rather than actually in the call to _init() but OTOH this should work fine so meh.
Quoted 4 lines
It does avoid the 'already present' error and I see that
/sys/kernel/debug/regmap/20e0000.pinctrl-gpr
is present, but/sys/kernel/debug/regmap/20e0000.pinctrl-gpris not. Not sure if this is the desired behavior.
Yes, that's what we're looking for (assuming the second of those names should be the dummy name) - that means that the old debugfs file is not hanging around and so won't be stuck there pointing at a deallocated regmap if the regmap gets freed for some reason.
Quoted 3 lines · Mark Brown
I would have expected this to be prior to the call to
_init()rather than actually in the call to_init()but OTOH this should work fine so meh.
Yes, I can call it prior to _init() as you suggested:
drivers/base/regmap/regmap.c +0 -0
@@ -647,6 +647,7 @@ int regmap_attach_dev(struct device *dev, struct
regmap *map,
if (ret)
return ret;
+ regmap_debugfs_exit(map);
regmap_debugfs_init(map);
/* Add a devres resource for dev_get_regmap() */
Will send a patch shortly.
Thanks
Mark Brown
maintainerQuoted 1 line · Fabio Estevam
Will send a patch shortly.
Great!