Skip to contentSkip to conversation

ASoc: PCM6240: Fix a null pointer dereference in pcmdevice_i2c_probe

PATCH In review Hao Ge 3 participants 6 messages Jun 14, 2024 – Jun 23, 2024

Subsystems (2)
lore
Share & tools
lore

Hao Ge

author
#0 lore raw

PATCH 1/1 ASoc: PCM6240: Fix a null pointer dereference in pcmdevice_i2c_probe

From: Hao Ge <[email protected]>

When devm_kzalloc return NULL,we return -ENOMEM directly to avoid a null pointer that call pcmdevice_remove which will perform some operations on the members of the pcm_dev;

Fixes 1324eafd37aa ("ASoc: PCM6240: Create PCM6240 Family driver code")
---
 sound/soc/codecs/pcm6240.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
sound/soc/codecs/pcm6240.c +1 -2
index 86e126783a1d..d3adcea457a2 100644
@@ -2088,8 +2088,7 @@ static int pcmdevice_i2c_probe(struct i2c_client *i2c)
 
 	pcm_dev = devm_kzalloc(&i2c->dev, sizeof(*pcm_dev), GFP_KERNEL);
 	if (!pcm_dev) {
-		ret = -ENOMEM;
-		goto out;
+		return -ENOMEM;
 	}
 
 	pcm_dev->chip_id = (id != NULL) ? id->driver_data : 0;
Signature · 1 line
2.25.1
#1 lore raw
Quoted 1 line

When devm_kzalloc return NULL,we return -ENOMEM directly to

This information fits to a coding style advice.
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/coding-style.rst?h=v6.10-rc3#n532

Quoted 2 lines

avoid a null pointer that call pcmdevice_remove which will perform some operations on the members of the pcm_dev;

You pointed in an improvable way out that the label “out” was questionable after the assignment of a well-known error code at the beginning.
https://elixir.bootlin.com/linux/v6.10-rc3/source/sound/soc/codecs/pcm6240.c#L2077

Can a wording approach (like the following) be a better change description?

The value “-ENOMEM” was assigned to the local variable “ret” in one if branch after a devm_kzalloc() call failed at the beginning. This error code will trigger then a pcmdevice_remove() call with a passed null pointer so that an undesirable dereference will be performed.
Thus return the appropriate error code directly.

Can a summary phrase like “Return directly after a failed devm_kzalloc() in pcmdevice_i2c_probe()” be also helpful?

Regards,
Markus

#3 lore raw
In reply to Hao Ge

…

sound/soc/codecs/pcm6240.c static int pcmdevice_i2c_probe(struct i2c_client *i2c) · line 2092

Quoted 9 lines

+++ b/sound/soc/codecs/pcm6240.c

sound/soc/codecs/pcm6240.c +1 -2
@@ -2088,8 +2088,7 @@ static int pcmdevice_i2c_probe(struct i2c_client *i2c)
 
 	pcm_dev = devm_kzalloc(&i2c->dev, sizeof(*pcm_dev), GFP_KERNEL);
 	if (!pcm_dev) {
-		ret = -ENOMEM;
-		goto out;
+		return -ENOMEM;
 	}

…

Would you like to omit curly brackets from a single if branch?
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/coding-style.rst?h=v6.10-rc3#n197

Regards,
Markus

author
#4 lore raw

PATCH v2 1/1 ASoc: PCM6240: Return directly after a failed devm_kzalloc() in pcmdevice_i2c_probe()

From: Hao Ge <[email protected]>

The value “-ENOMEM” was assigned to the local variable “ret” in one if branch after a devm_kzalloc() call failed at the beginning. This error code will trigger then a pcmdevice_remove() call with a passed null pointer so that an undesirable dereference will be performed. Thus return the appropriate error code directly.

Fixes 1324eafd37aa ("ASoc: PCM6240: Create PCM6240 Family driver code")

---
v2:
- adjust title and commit message
- omit curly brackets

---
 sound/soc/codecs/pcm6240.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)
sound/soc/codecs/pcm6240.c +2 -4
index 86e126783a1d..8f7057e689fb 100644
@@ -2087,10 +2087,8 @@ static int pcmdevice_i2c_probe(struct i2c_client *i2c)
 #endif
 
 	pcm_dev = devm_kzalloc(&i2c->dev, sizeof(*pcm_dev), GFP_KERNEL);
-	if (!pcm_dev) {
-		ret = -ENOMEM;
-		goto out;
-	}
+	if (!pcm_dev)
+		return -ENOMEM;
 
 	pcm_dev->chip_id = (id != NULL) ? id->driver_data : 0;
 
Signature · 1 line
2.25.1
maintainer
#5 lore raw

Re: [PATCH v2] ASoc: PCM6240: Return directly after a failed devm_kzalloc() in pcmdevice_i2c_probe()

Quoted 8 lines · Hao Ge

The value “-ENOMEM” was assigned to the local variable “ret” in one if branch after a devm_kzalloc() call failed at the beginning. This error code will trigger then a pcmdevice_remove() call with a passed null pointer so that an undesirable dereference will be performed. Thus return the appropriate error code directly.

[...]

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/1] ASoc: PCM6240: Return directly after a failed devm_kzalloc() in pcmdevice_i2c_probe()

      commit: 3722873d49a1788d5420894d4f6f63e35f5c1f13

All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying to this mail.

Thanks,
Mark