Skip to contentSkip to conversation

test/common: fix log2 check

PATCH Superseded David Marchand 2 participants 8 messages Dec 4, 2019 – Dec 20, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 test/common: fix log2 check

We recently started to get random failures on the common_autotest ut with clang on Ubuntu 16.04.6.

Example: https://travis-ci.com/DPDK/dpdk/jobs/263177424

Wrong rte_log2_u64(0) val 0, expected ffffffff
Test Failed

The ut passes 0 to log2() to get an expected value.

Quoting log2 / log(3) manual:
If x is zero, then a pole error occurs, and the functions return -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL, respectively.

rte_log2_uXX helpers handle 0 as a special value and return 0. Let's have dedicated tests for this case.

Fixes 05c4345ef5c2 ("test: add unit test for integer log2 function")
---
 app/test/test_common.c | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)
app/test/test_common.c +13 -1
index 2b856f8ba5..12bd1cad90 100644
@@ -216,7 +216,19 @@ test_log2(void)
 	const uint32_t max = 0x10000;
 	const uint32_t step = 1;
 
-	for (i = 0; i < max; i = i + step) {
+	compare = rte_log2_u32(0);
+	if (compare != 0) {
+		printf("Wrong rte_log2_u32(0) val %x, expected 0\n", compare);
+		return TEST_FAILED;
+	}
+
+	compare = rte_log2_u64(0);
+	if (compare != 0) {
+		printf("Wrong rte_log2_u64(0) val %x, expected 0\n", compare);
+		return TEST_FAILED;
+	}
+
+	for (i = 1; i < max; i = i + step) {
 		uint64_t i64;
 
 		/* extend range for 64-bit */
Signature · 1 line
2.23.0
Acked-by on v1 1/1
#1 lore raw
Quoted 14 lines · David Marchand

We recently started to get random failures on the common_autotest ut with clang on Ubuntu 16.04.6.

Example: https://travis-ci.com/DPDK/dpdk/jobs/263177424

Wrong rte_log2_u64(0) val 0, expected ffffffff
Test Failed

The ut passes 0 to log2() to get an expected value.

Quoting log2 / log(3) manual:
If x is zero, then a pole error occurs, and the functions return -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL, respectively.

Quoted 8 lines

rte_log2_uXX helpers handle 0 as a special value and return 0. Let's have dedicated tests for this case.

Fixes 05c4345ef5c2 ("test: add unit test for integer log2 function")

---

Somethings that concern me:

1. A log2(0) should probably be an undetermined value, but this effectively makes log2(0) == log2(1) so that if anyone uses these for some mathematical work, it will have an exceptional behavior. I know it's documented from a programmer perspective, but I am all for documenting the mathematical side effect as well.

2. Why hasn't this been complaining for so long? Or has it and we just haven't noticed? Were some compiler flags changed recently? (maybe -funsafe-math was always set or something?)

-Aaron

#2 lore raw
Quoted 28 lines · Aaron Conole
Quoted 14 lines · David Marchand

We recently started to get random failures on the common_autotest ut with clang on Ubuntu 16.04.6.

Example: https://travis-ci.com/DPDK/dpdk/jobs/263177424

Wrong rte_log2_u64(0) val 0, expected ffffffff
Test Failed

The ut passes 0 to log2() to get an expected value.

Quoting log2 / log(3) manual:
If x is zero, then a pole error occurs, and the functions return -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL, respectively.

Quoted 8 lines

rte_log2_uXX helpers handle 0 as a special value and return 0. Let's have dedicated tests for this case.

Fixes 05c4345ef5c2 ("test: add unit test for integer log2 function")

---

Quoted 7 lines

Somethings that concern me:

1. A log2(0) should probably be an undetermined value, but this effectively makes log2(0) == log2(1) so that if anyone uses these for some mathematical work, it will have an exceptional behavior. I know it's documented from a programmer perspective, but I am all for documenting the mathematical side effect as well.

What do you have in mind, adding a big warning in the doxygen "THIS IS NOT REAL MATH STUFF" ? :-)

Quoted 4 lines

2. Why hasn't this been complaining for so long? Or has it and we just haven't noticed? Were some compiler flags changed recently? (maybe -funsafe-math was always set or something?)

Yes, I wondered too how we did not see this earlier. Even now, it happens randomly.

libc log2(0) is not undefined itself, it returns -infinity. Looking at the test code, ceilf (I would expect ceil) returns -infinity when getting it passed.
So I'd say the problem lies in the cast to uint32_t.

Both gcc and clang do not seem to bother with standard compilation flags, and the cast gives 0 on my RHEL.

#include <stdio.h>
#include <inttypes.h>
#include <math.h>

int main(int argc, char *argv[])

{
    printf("%lf %f %"PRIu32"\n", log2(0), (float)log2(0), (uint32_t)log2(0));
    return 0;
}
$ ./log2
-inf -inf 0

Now, if I use UBSAN with clang, I get a complaint at runtime:

$ ./log2
(/home/dmarchan/log2+0x41dfa5): runtime error: value -inf is outside
the range of representable values of type 'unsigned int'
-inf -inf 0

Not sure if it explains the random failures, but won't undefined behavior eat your babies?

Signature · 1 line
David Marchand
#3 lore raw
Quoted 31 lines · David Marchand
Quoted 30 lines · Aaron Conole
Quoted 14 lines · David Marchand

We recently started to get random failures on the common_autotest ut with clang on Ubuntu 16.04.6.

Example: https://travis-ci.com/DPDK/dpdk/jobs/263177424

Wrong rte_log2_u64(0) val 0, expected ffffffff
Test Failed

The ut passes 0 to log2() to get an expected value.

Quoting log2 / log(3) manual:
If x is zero, then a pole error occurs, and the functions return -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL, respectively.

Quoted 8 lines

rte_log2_uXX helpers handle 0 as a special value and return 0. Let's have dedicated tests for this case.

Fixes 05c4345ef5c2 ("test: add unit test for integer log2 function")

---

Somethings that concern me:

Quoted 8 lines
Quoted 5 lines

1. A log2(0) should probably be an undetermined value, but this effectively makes log2(0) == log2(1) so that if anyone uses these for some mathematical work, it will have an exceptional behavior. I know it's documented from a programmer perspective, but I am all for documenting the mathematical side effect as well.

What do you have in mind, adding a big warning in the doxygen "THIS IS NOT REAL MATH STUFF" ? :-)

Is such a warning not reasonable? :-)

Quoted 30 lines
Quoted 4 lines

2. Why hasn't this been complaining for so long? Or has it and we just haven't noticed? Were some compiler flags changed recently? (maybe -funsafe-math was always set or something?)

Yes, I wondered too how we did not see this earlier. Even now, it happens randomly.

libc log2(0) is not undefined itself, it returns -infinity. Looking at the test code, ceilf (I would expect ceil) returns -infinity when getting it passed.
So I'd say the problem lies in the cast to uint32_t.

Both gcc and clang do not seem to bother with standard compilation flags, and the cast gives 0 on my RHEL.

#include <stdio.h>
#include <inttypes.h>
#include <math.h>

int main(int argc, char *argv[])

{
    printf("%lf %f %"PRIu32"\n", log2(0), (float)log2(0), (uint32_t)log2(0));
    return 0;
}
$ ./log2
-inf -inf 0
Quoted 8 lines

Now, if I use UBSAN with clang, I get a complaint at runtime:

$ ./log2
(/home/dmarchan/log2+0x41dfa5): runtime error: value -inf is outside
the range of representable values of type 'unsigned int'
-inf -inf 0

Not sure if it explains the random failures, but won't undefined behavior eat your babies?

Possibly. I would still expect it to be consistent when it eats babies, but maybe it doesn't have to be.

#4 lore raw

PATCH v2 1/1 test/common: fix log2 check

In reply to David Marchand

We recently started to get random failures on the common_autotest ut with clang on Ubuntu 16.04.6.

Example: https://travis-ci.com/DPDK/dpdk/jobs/263177424

Wrong rte_log2_u64(0) val 0, expected ffffffff
Test Failed

The ut passes 0 to log2() to get an expected value.

Quoting log2 / log(3) manual:
If x is zero, then a pole error occurs, and the functions return -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL, respectively.

rte_log2_uXX helpers handle 0 as a special value and return 0. Let's have dedicated tests for this case.

Fixes 05c4345ef5c2 ("test: add unit test for integer log2 function")

---
Changelog since v1:
- added comment in rte_log2_uXX API descriptions,

---
 app/test/test_common.c                     | 14 +++++++++++++-
 lib/librte_eal/common/include/rte_common.h |  6 ++++++
 2 files changed, 19 insertions(+), 1 deletion(-)
app/test/test_common.c +13 -1
index 2b856f8ba5..12bd1cad90 100644
@@ -216,7 +216,19 @@ test_log2(void)
 	const uint32_t max = 0x10000;
 	const uint32_t step = 1;
 
-	for (i = 0; i < max; i = i + step) {
+	compare = rte_log2_u32(0);
+	if (compare != 0) {
+		printf("Wrong rte_log2_u32(0) val %x, expected 0\n", compare);
+		return TEST_FAILED;
+	}
+
+	compare = rte_log2_u64(0);
+	if (compare != 0) {
+		printf("Wrong rte_log2_u64(0) val %x, expected 0\n", compare);
+		return TEST_FAILED;
+	}
+
+	for (i = 1; i < max; i = i + step) {
 		uint64_t i64;
 
 		/* extend range for 64-bit */
lib/librte_eal/common/include/rte_common.h +6 -0
index 459d082d14..7a98071ffe 100644
@@ -538,6 +538,9 @@ rte_bsf32_safe(uint64_t v, uint32_t *pos)
 /**
  * Return the rounded-up log2 of a integer.
  *
+ * @note Contrary to the logarithm mathematical operation,
+ * rte_log2_u32(0) == 0 and not -inf.
+ *
  * @param v
  *     The input parameter.
  * @return
@@ -632,6 +635,9 @@ rte_fls_u64(uint64_t x)
 /**
  * Return the rounded-up log2 of a 64-bit integer.
  *
+ * @note Contrary to the logarithm mathematical operation,
+ * rte_log2_u32(0) == 0 and not -inf.
+ *
  * @param v
  *     The input parameter.
  * @return
Signature · 1 line
2.23.0
#5 lore raw
Quoted 15 lines · David Marchand
lib/librte_eal/common/include/rte_common.h +3 -0
index 459d082d14..7a98071ffe 100644
@@ -538,6 +538,9 @@ rte_bsf32_safe(uint64_t v, uint32_t *pos)
 /**
  * Return the rounded-up log2 of a integer.
  *
+ * @note Contrary to the logarithm mathematical operation,
+ * rte_log2_u32(0) == 0 and not -inf.
+ *
  * @param v
  *     The input parameter.
  * @return

lib/librte_eal/common/include/rte_common.h rte_fls_u64(uint64_t x) · line 639

Quoted 5 lines
lib/librte_eal/common/include/rte_common.h +2 -0
@@ -632,6 +635,9 @@ rte_fls_u64(uint64_t x)
 /**
  * Return the rounded-up log2 of a 64-bit integer.
  *
+ * @note Contrary to the logarithm mathematical operation,
+ * rte_log2_u32(0) == 0 and not -inf.

_u64*
Will fix while applying.

Signature · 1 line
David Marchand
#6 lore raw
In reply to David Marchand
Quoted 15 lines · David Marchand

We recently started to get random failures on the common_autotest ut with clang on Ubuntu 16.04.6.

Example: https://travis-ci.com/DPDK/dpdk/jobs/263177424

Wrong rte_log2_u64(0) val 0, expected ffffffff
Test Failed

The ut passes 0 to log2() to get an expected value.

Quoting log2 / log(3) manual:
If x is zero, then a pole error occurs, and the functions return -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL, respectively.

Quoted 8 lines

rte_log2_uXX helpers handle 0 as a special value and return 0. Let's have dedicated tests for this case.

Fixes 05c4345ef5c2 ("test: add unit test for integer log2 function")

Applied with mentioned fix.

Signature · 1 line
David Marchand
#7 lore raw
Quoted 20 lines · David Marchand
Quoted 18 lines · David Marchand

We recently started to get random failures on the common_autotest ut with clang on Ubuntu 16.04.6.

Example: https://travis-ci.com/DPDK/dpdk/jobs/263177424

Wrong rte_log2_u64(0) val 0, expected ffffffff
Test Failed

The ut passes 0 to log2() to get an expected value.

Quoting log2 / log(3) manual:
If x is zero, then a pole error occurs, and the functions return -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL, respectively.

rte_log2_uXX helpers handle 0 as a special value and return 0. Let's have dedicated tests for this case.

Quoted 7 lines
Quoted 5 lines
Fixes 05c4345ef5c2 ("test: add unit test for integer log2 function")

Applied with mentioned fix.

Thanks!