Skip to contentSkip to conversation

iio: adc: Fix potential integer overflow

PATCH In review Gustavo A. R. Silva 4 participants 7 messages Sep 18, 2018 – Sep 24, 2018

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

PATCH 1/1 iio: adc: Fix potential integer overflow

Cast factor to s64 in order to give the compiler complete information about the proper arithmetic to use and avoid a potential integer overflow. Notice that such variable is being used in a context that expects an expression of type s64 (64 bits, signed).

Addresses-Coverity-ID: 1324146 ("Unintentional integer overflow")

Fixes e13d757279bb ("iio: adc: Add QCOM SPMI PMIC5 ADC driver")
---
 drivers/iio/adc/qcom-vadc-common.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/iio/adc/qcom-vadc-common.c +1 -1
index dcd7fb5..e360e27 100644
@@ -282,7 +282,7 @@ static int qcom_vadc_scale_code_voltage_factor(u16 adc_code,
 	voltage = div64_s64(voltage, data->full_scale_code_volt);
 	if (voltage > 0) {
 		voltage *= prescale->den;
-		temp = prescale->num * factor;
+		temp = prescale->num * (s64)factor;
 		voltage = div64_s64(voltage, temp);
 	} else {
 		voltage = 0;
Signature · 1 line
2.7.4
maintainer
#1 lore raw
Quoted 17 lines · On Tue, 18 Sep 2018 07:53:14 -0500 "Gustavo A. R. Silva"…

Cast factor to s64 in order to give the compiler complete information about the proper arithmetic to use and avoid a potential integer overflow. Notice that such variable is being used in a context that expects an expression of type s64 (64 bits, signed).

Addresses-Coverity-ID: 1324146 ("Unintentional integer overflow")

Fixes e13d757279bb ("iio: adc: Add QCOM SPMI PMIC5 ADC driver")
---
 drivers/iio/adc/qcom-vadc-common.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/iio/adc/qcom-vadc-common.c +0 -0
index dcd7fb5..e360e27 100644

drivers/iio/adc/qcom-vadc-common.c static int qcom_vadc_scale_code_voltage_factor(u16 adc_code, · line 285

Quoted 5 lines
drivers/iio/adc/qcom-vadc-common.c +1 -1
@@ -282,7 +282,7 @@ static int qcom_vadc_scale_code_voltage_factor(u16 adc_code,
 	voltage = div64_s64(voltage, data->full_scale_code_volt);
 	if (voltage > 0) {
 		voltage *= prescale->den;
-		temp = prescale->num * factor;
+		temp = prescale->num * (s64)factor;

So factor is an unsigned int so could be 32 bits. In reality it only takes a small set of values between 1 and 1000

Maximum numerator is 10 so a maximum of 10,000.

Hence this is a false positive, be it one that would be very hard for a static checker to identify.

So that moves it from a fix to a warning suppression change. I have no problem with those, but description needs to reflect that.

Let me know if I've missed something, if not I'm happy to apply this and will put some text in the message to explain the above reasoning.

Thanks,

Jonathan

Quoted 3 lines
drivers/iio/adc/qcom-vadc-common.c +0 -0
 		voltage = div64_s64(voltage, temp);
 	} else {
 		voltage = 0;
#2 lore raw
Quoted 33 lines · Jonathan Cameron
Quoted 17 lines · On Tue, 18 Sep 2018 07:53:14 -0500 "Gustavo A. R. Silva"…

Cast factor to s64 in order to give the compiler complete information about the proper arithmetic to use and avoid a potential integer overflow. Notice that such variable is being used in a context that expects an expression of type s64 (64 bits, signed).

Addresses-Coverity-ID: 1324146 ("Unintentional integer overflow")

Fixes e13d757279bb ("iio: adc: Add QCOM SPMI PMIC5 ADC driver")
---
 drivers/iio/adc/qcom-vadc-common.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/iio/adc/qcom-vadc-common.c +0 -0
index dcd7fb5..e360e27 100644

drivers/iio/adc/qcom-vadc-common.c static int qcom_vadc_scale_code_voltage_factor(u16 adc_code, · line 285

Quoted 5 lines
drivers/iio/adc/qcom-vadc-common.c +1 -1
@@ -282,7 +282,7 @@ static int qcom_vadc_scale_code_voltage_factor(u16 adc_code,
 	voltage = div64_s64(voltage, data->full_scale_code_volt);
 	if (voltage > 0) {
 		voltage *= prescale->den;
-		temp = prescale->num * factor;
+		temp = prescale->num * (s64)factor;

So factor is an unsigned int so could be 32 bits. In reality it only takes a small set of values between 1 and 1000

Maximum numerator is 10 so a maximum of 10,000.

Hence this is a false positive, be it one that would be very hard for a static checker to identify.

Quoted 7 lines

So that moves it from a fix to a warning suppression change. I have no problem with those, but description needs to reflect that.

Let me know if I've missed something, if not I'm happy to apply this and will put some text in the message to explain the above reasoning.

Hi Jonathan,

I think you are right. Plase, feel free to update the commit log.

Thanks
--
Gustavo

#3 lore raw
In reply to Jonathan Cameron
Quoted 28 lines · Jonathan Cameron
Quoted 17 lines · On Tue, 18 Sep 2018 07:53:14 -0500 "Gustavo A. R. Silva"…

Cast factor to s64 in order to give the compiler complete information about the proper arithmetic to use and avoid a potential integer overflow. Notice that such variable is being used in a context that expects an expression of type s64 (64 bits, signed).

Addresses-Coverity-ID: 1324146 ("Unintentional integer overflow")

Fixes e13d757279bb ("iio: adc: Add QCOM SPMI PMIC5 ADC driver")
---
 drivers/iio/adc/qcom-vadc-common.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/iio/adc/qcom-vadc-common.c +0 -0
index dcd7fb5..e360e27 100644

drivers/iio/adc/qcom-vadc-common.c static int qcom_vadc_scale_code_voltage_factor(u16 adc_code, · line 285

Quoted 5 lines
drivers/iio/adc/qcom-vadc-common.c +1 -1
@@ -282,7 +282,7 @@ static int qcom_vadc_scale_code_voltage_factor(u16 adc_code,
 	voltage = div64_s64(voltage, data->full_scale_code_volt);
 	if (voltage > 0) {
 		voltage *= prescale->den;
-		temp = prescale->num * factor;
+		temp = prescale->num * (s64)factor;

So factor is an unsigned int so could be 32 bits. In reality it only takes a small set of values between 1 and 1000

Quoted 4 lines

Maximum numerator is 10 so a maximum of 10,000.

Hence this is a false positive, be it one that would be very hard for a static checker to identify.

I think the reason why it complains is because temp is s64. So it infers that the idea was that the result of the multiplication can be larger than 64 bit. For 32bit * 32bit -> 32bit it should not complain.

Quoted 3 lines

So that moves it from a fix to a warning suppression change. I have no problem with those, but description needs to reflect that.

Maybe just change the type of temp to u32. There is also mul_u64_u32_div() which could be used here to further simplify things.

#4 lore raw
Quoted 29 lines · Lars-Peter Clausen
Quoted 28 lines · Jonathan Cameron
Quoted 17 lines · On Tue, 18 Sep 2018 07:53:14 -0500 "Gustavo A. R. Silva"…

Cast factor to s64 in order to give the compiler complete information about the proper arithmetic to use and avoid a potential integer overflow. Notice that such variable is being used in a context that expects an expression of type s64 (64 bits, signed).

Addresses-Coverity-ID: 1324146 ("Unintentional integer overflow")

Fixes e13d757279bb ("iio: adc: Add QCOM SPMI PMIC5 ADC driver")
---
 drivers/iio/adc/qcom-vadc-common.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/iio/adc/qcom-vadc-common.c +0 -0
index dcd7fb5..e360e27 100644

drivers/iio/adc/qcom-vadc-common.c static int qcom_vadc_scale_code_voltage_factor(u16 adc_code, · line 285

Quoted 5 lines
drivers/iio/adc/qcom-vadc-common.c +1 -1
@@ -282,7 +282,7 @@ static int qcom_vadc_scale_code_voltage_factor(u16 adc_code,
 	voltage = div64_s64(voltage, data->full_scale_code_volt);
 	if (voltage > 0) {
 		voltage *= prescale->den;
-		temp = prescale->num * factor;
+		temp = prescale->num * (s64)factor;

So factor is an unsigned int so could be 32 bits. In reality it only takes a small set of values between 1 and 1000

Quoted 8 lines
Quoted 4 lines

Maximum numerator is 10 so a maximum of 10,000.

Hence this is a false positive, be it one that would be very hard for a static checker to identify.

I think the reason why it complains is because temp is s64. So it infers that the idea was that the result of the multiplication can be larger than 64 bit. For 32bit * 32bit -> 32bit it should not complain.

"lager than 32 bit"

Quoted 8 lines
Quoted 4 lines

So that moves it from a fix to a warning suppression change. I have no problem with those, but description needs to reflect that.

Maybe just change the type of temp to u32. There is also mul_u64_u32_div() which could be used here to further simplify things.

maintainer
#5 lore raw
Quoted 32 lines · On Mon, 24 Sep 2018 19:19:34 +0200 Lars-Peter Clausen <[email protected]> wrote:
Quoted 31 lines · Lars-Peter Clausen
Quoted 30 lines · Jonathan Cameron
Quoted 17 lines · On Tue, 18 Sep 2018 07:53:14 -0500 "Gustavo A. R. Silva"…

Cast factor to s64 in order to give the compiler complete information about the proper arithmetic to use and avoid a potential integer overflow. Notice that such variable is being used in a context that expects an expression of type s64 (64 bits, signed).

Addresses-Coverity-ID: 1324146 ("Unintentional integer overflow")

Fixes e13d757279bb ("iio: adc: Add QCOM SPMI PMIC5 ADC driver")
---
 drivers/iio/adc/qcom-vadc-common.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/iio/adc/qcom-vadc-common.c +0 -0
index dcd7fb5..e360e27 100644

drivers/iio/adc/qcom-vadc-common.c static int qcom_vadc_scale_code_voltage_factor(u16 adc_code, · line 285

Quoted 5 lines
drivers/iio/adc/qcom-vadc-common.c +1 -1
@@ -282,7 +282,7 @@ static int qcom_vadc_scale_code_voltage_factor(u16 adc_code,
 	voltage = div64_s64(voltage, data->full_scale_code_volt);
 	if (voltage > 0) {
 		voltage *= prescale->den;
-		temp = prescale->num * factor;
+		temp = prescale->num * (s64)factor;  

So factor is an unsigned int so could be 32 bits. In reality it only takes a small set of values between 1 and 1000

Maximum numerator is 10 so a maximum of 10,000.

Quoted 17 lines
Quoted 6 lines
Quoted 2 lines

Hence this is a false positive, be it one that would be very hard for a static checker to identify.

I think the reason why it complains is because temp is s64. So it infers that the idea was that the result of the multiplication can be larger than 64 bit. For 32bit * 32bit -> 32bit it should not complain.

"lager than 32 bit"

Quoted 8 lines
Quoted 4 lines

So that moves it from a fix to a warning suppression change. I have no problem with those, but description needs to reflect that.

Maybe just change the type of temp to u32. There is also mul_u64_u32_div() which could be used here to further simplify things.

That would be a nice improvement to this patch. Gustavo, if you don't mind doing an updated version that would be great. If not I'll get to it sooner or later.

Thanks,

Jonathan

Quoted 1 line
#6 lore raw
In reply to Gustavo A. R. Silva

Hi Gustavo,

Quoted 17 lines · Gustavo A. R. Silva

Cast factor to s64 in order to give the compiler complete information about the proper arithmetic to use and avoid a potential integer overflow. Notice that such variable is being used in a context that expects an expression of type s64 (64 bits, signed).

Addresses-Coverity-ID: 1324146 ("Unintentional integer overflow")

Fixes e13d757279bb ("iio: adc: Add QCOM SPMI PMIC5 ADC driver")
---
 drivers/iio/adc/qcom-vadc-common.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/iio/adc/qcom-vadc-common.c +0 -0
index dcd7fb5..e360e27 100644

drivers/iio/adc/qcom-vadc-common.c static int qcom_vadc_scale_code_voltage_factor(u16 adc_code, · line 285

Quoted 5 lines
drivers/iio/adc/qcom-vadc-common.c +1 -1
@@ -282,7 +282,7 @@ static int qcom_vadc_scale_code_voltage_factor(u16 adc_code,
 	voltage = div64_s64(voltage, data->full_scale_code_volt);
 	if (voltage > 0) {
 		voltage *= prescale->den;
-		temp = prescale->num * factor;
+		temp = prescale->num * (s64)factor;

As Jonathan pointed it is a false positive, let me share some more insight on this particular set of warnings.

num is u32 and factor is unsigned int(u32 on most implementations).

So, if multiplication b/w them exceeds UNIT_MAX then that is perfectly defined behavior in C. And often called "wrapping".
https://port70.net/~nsz/c/c11/n1570.html#6.2.5p9

And *if* it exceeds UNIT_MAX, then it is certainly wrong arthimetic implementation by the author.

On the other hand, if it were the case signed int overflow then certainly it is undefined behavior and called "overflow".

And here temp is guaranteed to not overflow!

But I don't understand what issue are you trying to resolve here and I'm interested in this particular set of warnings because I too get coverity scan reports on the same although I only search for IIO drivers issues.

Thanks

Signature · 4 lines
Himanshu Jha
Undergraduate Student
Department of Electronics & Communication
Guru Tegh Bahadur Institute of Technology