Skip to content

Fix incorrect rounding with subnormal/zero results of float multiplication #637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions src/float/mul.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,18 +149,13 @@ where
}

// Otherwise, shift the significand of the result so that the round
// bit is the high bit of productLo.
if shift < bits {
let sticky = product_low << (bits - shift);
product_low = product_high << (bits - shift) | product_low >> shift | sticky;
product_high >>= shift;
} else if shift < (2 * bits) {
let sticky = product_high << (2 * bits - shift) | product_low;
product_low = product_high >> (shift - bits) | sticky;
product_high = zero;
} else {
product_high = zero;
}
// bit is the high bit of `product_low`.
// Ensure one of the non-highest bits in `product_low` is set if the shifted out bit are
// not all zero so that the result is correctly rounded below.
let sticky = product_low << (bits - shift) != zero;
product_low =
product_high << (bits - shift) | product_low >> shift | (sticky as u32).cast();
product_high >>= shift;
} else {
// Result is normal before rounding; insert the exponent.
product_high &= significand_mask;
Expand Down
4 changes: 4 additions & 0 deletions src/probestack.rs
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,10 @@ macro_rules! define_rust_probestack {
};
}

// FIXME(rust-lang/rust#126984): Remove allow once lint is fixed
#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
use define_rust_probestack;

// Our goal here is to touch each page between %rsp+8 and %rsp+8-%rax,
// ensuring that if any pages are unmapped we'll make a page fault.
//
Expand Down
17 changes: 14 additions & 3 deletions testcrate/src/bench.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ pub fn skip_sys_checks(test_name: &str) -> bool {
"extend_f16_f32",
"trunc_f32_f16",
"trunc_f64_f16",
// FIXME(f16_f128): rounding error
// FIXME(#616): re-enable once fix is in nightly
// <https://github.com/rust-lang/compiler-builtins/issues/616>
"mul_f128",
"mul_f32",
"mul_f64",
Comment on lines -20 to +23
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why will these be fixed with the nightly bump? I guess if __mul[sd]f3 don't exist since they are expected to lower to assembly, then linking the extern "C" symbols is linking to the weak ones from this library?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your guess is correct.

];

// FIXME(f16_f128): error on LE ppc64. There are more tests that are cfg-ed out completely
Expand All @@ -29,7 +30,13 @@ pub fn skip_sys_checks(test_name: &str) -> bool {

// FIXME(f16_f128): system symbols have incorrect results
// <https://github.com/rust-lang/compiler-builtins/issues/617#issuecomment-2125914639>
const X86_NO_SSE_SKIPPED: &[&str] = &["add_f128", "sub_f128", "powi_f32", "powi_f64"];
const X86_NO_SSE_SKIPPED: &[&str] =
&["add_f128", "sub_f128", "mul_f128", "powi_f32", "powi_f64"];

// FIXME(f16_f128): Wide multiply carry bug in `compiler-rt`, re-enable when nightly no longer
// uses `compiler-rt` version.
// <https://github.com/llvm/llvm-project/issues/91840>
const AARCH64_SKIPPED: &[&str] = &["mul_f128"];

// FIXME(llvm): system symbols have incorrect results on Windows
// <https://github.com/rust-lang/compiler-builtins/issues/617#issuecomment-2121359807>
Expand Down Expand Up @@ -61,6 +68,10 @@ pub fn skip_sys_checks(test_name: &str) -> bool {
return true;
}

if cfg!(target_arch = "aarch64") && AARCH64_SKIPPED.contains(&test_name) {
return true;
}

if cfg!(target_family = "windows") && WINDOWS_SKIPPED.contains(&test_name) {
return true;
}
Expand Down
19 changes: 9 additions & 10 deletions testcrate/tests/mul.rs
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,11 @@ macro_rules! float_mul {
fuzz_float_2(N, |x: $f, y: $f| {
let mul0 = apfloat_fallback!($f, $apfloat_ty, $sys_available, Mul::mul, x, y);
let mul1: $f = $fn(x, y);
// multiplication of subnormals is not currently handled
if !(Float::is_subnormal(mul0) || Float::is_subnormal(mul1)) {
if !Float::eq_repr(mul0, mul1) {
panic!(
"{}({:?}, {:?}): std: {:?}, builtins: {:?}",
stringify!($fn), x, y, mul0, mul1
);
}
if !Float::eq_repr(mul0, mul1) {
panic!(
"{}({:?}, {:?}): std: {:?}, builtins: {:?}",
stringify!($fn), x, y, mul0, mul1
);
}
});
}
Expand All @@ -126,9 +123,11 @@ macro_rules! float_mul {
mod float_mul {
use super::*;

// FIXME(#616): Stop ignoring arches that don't have native support once fix for builtins is in
// nightly.
float_mul! {
f32, __mulsf3, Single, all();
f64, __muldf3, Double, all();
f32, __mulsf3, Single, not(target_arch = "arm");
f64, __muldf3, Double, not(target_arch = "arm");
}
}

Expand Down
Loading