Skip to contentSkip to conversation

sound: fix uninit-value in sof_ipc4_pcm_dai_link_fixup_rate

PATCH In review Suraj Sonawane 3 participants 11 messages Oct 30, 2024 – Nov 6, 2024

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sound: fix uninit-value in sof_ipc4_pcm_dai_link_fixup_rate

Fix an issue detected by the Smatch tool:

sound/soc/sof/ipc4-pcm.c:615 sof_ipc4_pcm_dai_link_fixup_rate()
error: uninitialized symbol 'be_rate'. sound/soc/sof/ipc4-pcm.c:636 sof_ipc4_pcm_dai_link_fixup_rate()
error: uninitialized symbol 'be_rate'.

These errors occurred because the variable 'be_rate' is declared but may not be assigned a value before it is used. Specifically, if the loop that assigns values to 'be_rate' does not execute (for example, when 'num_input_formats' is zero), 'be_rate' remains uninitialized, leading to potential undefined behavior.

To resolve this issue, initialize 'be_rate' to 0 at the point of declaration. This ensures that 'be_rate' has a defined value before it is used in subsequent calculations, preventing any warnings or undefined behavior in cases where the loop does not run.

---
 sound/soc/sof/ipc4-pcm.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
sound/soc/sof/ipc4-pcm.c +1 -1
index 4df2be3d3..d08419859 100644
@@ -600,7 +600,7 @@ static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev,
 	unsigned int fe_rate = params_rate(params);
 	bool fe_be_rate_match = false;
 	bool single_be_rate = true;
-	unsigned int be_rate;
+	unsigned int be_rate = 0;
 	int i;
 
 	/*
Signature · 1 line
2.34.1
maintainer
#1 lore raw
Quoted 1 line · Suraj Sonawane

Fix an issue detected by the Smatch tool:

Please submit patches using subject lines reflecting the style for the subsystem, this makes it easier for people to identify relevant patches. Look at what existing commits in the area you're changing are doing and make sure your subject lines visually resemble what they're doing. There's no need to resubmit to fix this alone.

#2 lore raw
Quoted 5 lines · Mark Brown

Please submit patches using subject lines reflecting the style for the subsystem, this makes it easier for people to identify relevant patches. Look at what existing commits in the area you're changing are doing and make sure your subject lines visually resemble what they're doing. There's no need to resubmit to fix this alone.

Thank you for the guidance! I’ll make sure to follow the subsystem’s subject line style in future submissions.

maintainer
#3 lore raw
In reply to Suraj Sonawane
Quoted 10 lines · Suraj Sonawane

These errors occurred because the variable 'be_rate' is declared but may not be assigned a value before it is used. Specifically, if the loop that assigns values to 'be_rate' does not execute (for example, when 'num_input_formats' is zero), 'be_rate' remains uninitialized, leading to potential undefined behavior.

To resolve this issue, initialize 'be_rate' to 0 at the point of declaration. This ensures that 'be_rate' has a defined value before it is used in subsequent calculations, preventing any warnings or undefined behavior in cases where the loop does not run.

Again, this shuts the warning up but is this actually a good fix?

#4 lore raw

PATCH v2 1/1 sound: fix uninit-value in sof_ipc4_pcm_dai_link_fixup_rate

In reply to Suraj Sonawane

Fix an issue detected by the Smatch tool:

sound/soc/sof/ipc4-pcm.c: sof_ipc4_pcm_dai_link_fixup_rate()
error: uninitialized symbol 'be_rate'.

This issue occurred because the variable 'be_rate' could remain uninitialized if num_input_formats is zero. In such cases, the loop that assigns a value to 'be_rate' would not execute, potentially leading to undefined behavior when rate->min and rate->max are set with an uninitialized 'be_rate'.

To resolve this, an additional check for num_input_formats > 0 was added before setting rate->min and rate->max with 'be_rate'. This ensures that 'be_rate' is assigned only when there are valid input formats, preventing any use of uninitialized data.

This solution maintains defined behavior for rate->min and rate->max, ensuring they are only assigned when valid be_rate data is available.

---
V1: Initialize 'be_rate' to 0.
V2: Add conditional assignment based on num_input_formats to ensure be_rate is used only when assigned.

 sound/soc/sof/ipc4-pcm.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
sound/soc/sof/ipc4-pcm.c +5 -2
index 4df2be3d3..d5d7ffc69 100644
@@ -633,8 +633,11 @@ static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev,
 			return -EINVAL;
 		}
 
-		rate->min = be_rate;
-		rate->max = rate->min;
+		/* Set rate only if be_rate was assigned */
+		if (num_input_formats > 0) {
+			rate->min = be_rate;
+			rate->max = rate->min;
+		}
 	}
 
 	return 0;
Signature · 1 line
2.34.1
maintainer
#5 lore raw
Quoted 33 lines · Suraj Sonawane

Fix an issue detected by the Smatch tool:

sound/soc/sof/ipc4-pcm.c: sof_ipc4_pcm_dai_link_fixup_rate()
error: uninitialized symbol 'be_rate'.

This issue occurred because the variable 'be_rate' could remain uninitialized if num_input_formats is zero. In such cases, the loop that assigns a value to 'be_rate' would not execute, potentially leading to undefined behavior when rate->min and rate->max are set with an uninitialized 'be_rate'.

To resolve this, an additional check for num_input_formats > 0 was added before setting rate->min and rate->max with 'be_rate'. This ensures that 'be_rate' is assigned only when there are valid input formats, preventing any use of uninitialized data.

This solution maintains defined behavior for rate->min and rate->max, ensuring they are only assigned when valid be_rate data is available.

---
V1: Initialize 'be_rate' to 0.
V2: Add conditional assignment based on num_input_formats to ensure be_rate is used only when assigned.

 sound/soc/sof/ipc4-pcm.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
sound/soc/sof/ipc4-pcm.c +0 -0
index 4df2be3d3..d5d7ffc69 100644

sound/soc/sof/ipc4-pcm.c static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev, · line 637

Quoted 7 lines
sound/soc/sof/ipc4-pcm.c +2 -2
@@ -633,8 +633,11 @@ static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev,
 			return -EINVAL;
 		}
 
-		rate->min = be_rate;
-		rate->max = rate->min;
+		/* Set rate only if be_rate was assigned */
+		if (num_input_formats > 0) {

By definition the copier must have at least one input and one output format, this check is going to be always true.

Quoted 6 lines
sound/soc/sof/ipc4-pcm.c +3 -0
+			rate->min = be_rate;
+			rate->max = rate->min;
+		}
 	}
 
 	return 0;
Signature · 1 line
Péter
maintainer
#6 lore raw
Quoted 18 lines · Péter Ujfalusi
Quoted 15 lines · Suraj Sonawane

Fix an issue detected by the Smatch tool:

sound/soc/sof/ipc4-pcm.c: sof_ipc4_pcm_dai_link_fixup_rate()
error: uninitialized symbol 'be_rate'.

This issue occurred because the variable 'be_rate' could remain uninitialized if num_input_formats is zero. In such cases, the loop that assigns a value to 'be_rate' would not execute, potentially leading to undefined behavior when rate->min and rate->max are set with an uninitialized 'be_rate'.

To resolve this, an additional check for num_input_formats > 0 was added before setting rate->min and rate->max with 'be_rate'. This ensures that 'be_rate' is assigned only when there are valid input formats, preventing any use of uninitialized data.

Quoted 7 lines

sound/soc/sof/ipc4-pcm.c static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev, · line 637

Quoted 4 lines
sound/soc/sof/ipc4-pcm.c +2 -2
-		rate->min = be_rate;
-		rate->max = rate->min;
+		/* Set rate only if be_rate was assigned */
+		if (num_input_formats > 0) {

By definition the copier must have at least one input and one output format, this check is going to be always true.

Static analysis of the code can't reasonably tell that, we need something that ensures that it doesn't detect a spuriously uninitialised variable here. Possibly a

	if (WARN_ON_ONCE(!num_input_formats))
		return -EINVAL;

or similar?

#7 lore raw
Quoted 27 lines · Mark Brown
Quoted 18 lines · Péter Ujfalusi
Quoted 15 lines · Suraj Sonawane

Fix an issue detected by the Smatch tool:

sound/soc/sof/ipc4-pcm.c: sof_ipc4_pcm_dai_link_fixup_rate()
error: uninitialized symbol 'be_rate'.

This issue occurred because the variable 'be_rate' could remain uninitialized if num_input_formats is zero. In such cases, the loop that assigns a value to 'be_rate' would not execute, potentially leading to undefined behavior when rate->min and rate->max are set with an uninitialized 'be_rate'.

To resolve this, an additional check for num_input_formats > 0 was added before setting rate->min and rate->max with 'be_rate'. This ensures that 'be_rate' is assigned only when there are valid input formats, preventing any use of uninitialized data.

Quoted 7 lines

sound/soc/sof/ipc4-pcm.c static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev, · line 637

Quoted 4 lines
sound/soc/sof/ipc4-pcm.c +2 -2
-		rate->min = be_rate;
-		rate->max = rate->min;
+		/* Set rate only if be_rate was assigned */
+		if (num_input_formats > 0) {

By definition the copier must have at least one input and one output format, this check is going to be always true.

Quoted 8 lines

Static analysis of the code can't reasonably tell that, we need something that ensures that it doesn't detect a spuriously uninitialised variable here. Possibly a

	if (WARN_ON_ONCE(!num_input_formats))
		return -EINVAL;

or similar?

Thank you, Mark and Péter, for the guidance. I understand now that, while the copier should always have at least one input format, static analysis tools can’t detect this. Based on your suggestions, I’ve considered the following possible solutions to address the issue:

1. Add a WARN_ON_ONCE(!num_input_formats) check: This would issue a warning and return an error if num_input_formats is unexpectedly zero, ensuring we handle any edge cases explicitly.

2. Return an error if no input formats are available: Implementing the following check could provide immediate feedback if num_input_formats is zero:

    if (num_input_formats <= 0) {
        dev_err(sdev->dev, "No input formats available\n");
        return -EINVAL; // Return an error if there are no formats
    }

Would it be preferable to proceed with the WARN_ON_ONCE(!num_input_formats) approach, or is there a preferred alternative from the options above?

Thank you again

maintainer
#8 lore raw
Quoted 12 lines · Suraj Sonawane

Thank you, Mark and Péter, for the guidance. I understand now that, while the copier should always have at least one input format, static analysis tools can’t detect this. Based on your suggestions, I’ve considered the following possible solutions to address the issue:

1. Add a WARN_ON_ONCE(!num_input_formats) check: This would issue a warning and return an error if num_input_formats is unexpectedly zero, ensuring we handle any edge cases explicitly.

2. Return an error if no input formats are available: Implementing the following check could provide immediate feedback if num_input_formats is zero:

Quoted 7 lines
    if (num_input_formats <= 0) {
        dev_err(sdev->dev, "No input formats available\n");
        return -EINVAL; // Return an error if there are no formats
    }

Would it be preferable to proceed with the WARN_ON_ONCE(!num_input_formats) approach, or is there a preferred alternative from the options above?

I don't have a super strong preference between the two options.

#9 lore raw
Quoted 19 lines · Mark Brown
Quoted 16 lines · Suraj Sonawane

Thank you, Mark and Péter, for the guidance. I understand now that, while the copier should always have at least one input format, static analysis tools can’t detect this. Based on your suggestions, I’ve considered the following possible solutions to address the issue:

1. Add a WARN_ON_ONCE(!num_input_formats) check: This would issue a warning and return an error if num_input_formats is unexpectedly zero, ensuring we handle any edge cases explicitly.

2. Return an error if no input formats are available: Implementing the following check could provide immediate feedback if num_input_formats is zero:

     if (num_input_formats <= 0) {
         dev_err(sdev->dev, "No input formats available\n");
         return -EINVAL; // Return an error if there are no formats
     }
Quoted 4 lines
Quoted 2 lines

Would it be preferable to proceed with the WARN_ON_ONCE(!num_input_formats) approach, or is there a preferred alternative from the options above?

I don't have a super strong preference between the two options.

Thank you for the clarification. I’ll study the best approach in more detail and will send the patch in a while.

Thanks again for your time and feedback!

#10 lore raw
In reply to Péter Ujfalusi
Quoted 47 lines · Péter Ujfalusi
Quoted 33 lines · Suraj Sonawane

Fix an issue detected by the Smatch tool:

sound/soc/sof/ipc4-pcm.c: sof_ipc4_pcm_dai_link_fixup_rate()
error: uninitialized symbol 'be_rate'.

This issue occurred because the variable 'be_rate' could remain uninitialized if num_input_formats is zero. In such cases, the loop that assigns a value to 'be_rate' would not execute, potentially leading to undefined behavior when rate->min and rate->max are set with an uninitialized 'be_rate'.

To resolve this, an additional check for num_input_formats > 0 was added before setting rate->min and rate->max with 'be_rate'. This ensures that 'be_rate' is assigned only when there are valid input formats, preventing any use of uninitialized data.

This solution maintains defined behavior for rate->min and rate->max, ensuring they are only assigned when valid be_rate data is available.

---
V1: Initialize 'be_rate' to 0.
V2: Add conditional assignment based on num_input_formats to ensure be_rate is used only when assigned.

  sound/soc/sof/ipc4-pcm.c | 7 +++++--
  1 file changed, 5 insertions(+), 2 deletions(-)
sound/soc/sof/ipc4-pcm.c +0 -0
index 4df2be3d3..d5d7ffc69 100644

sound/soc/sof/ipc4-pcm.c static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev, · line 637

Quoted 7 lines
sound/soc/sof/ipc4-pcm.c +2 -2
@@ -633,8 +633,11 @@ static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev,
  			return -EINVAL;
  		}
 
-		rate->min = be_rate;
-		rate->max = rate->min;
+		/* Set rate only if be_rate was assigned */
+		if (num_input_formats > 0) {

By definition the copier must have at least one input and one output format, this check is going to be always true.

Quoted 7 lines

sound/soc/sof/ipc4-pcm.c static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev, · line 643

Quoted 6 lines
sound/soc/sof/ipc4-pcm.c +3 -0
+			rate->min = be_rate;
+			rate->max = rate->min;
+		}
  	}
 
  	return 0;

Thank you for the clarification.