[llvm] f560e20 - [KnownFPClass] Add output/input denormal helpers (#225575)
via llvm-commits
llvm-commits at lists.llvm.org
Sun Oct 4 16:00:53 PDT 2026
Author: Eric Ross
Date: 2026-10-04T23:00:45Z
New Revision: f560e20a6f287187de7d75b7873e13eab3e818e8
URL: https://github.com/llvm/llvm-project/commit/f560e20a6f287187de7d75b7873e13eab3e818e8
DIFF: https://github.com/llvm/llvm-project/commit/f560e20a6f287187de7d75b7873e13eab3e818e8.diff
LOG: [KnownFPClass] Add output/input denormal helpers (#225575)
Added `applyInputDenormalMode(KnownSrc, Mode)` and
`applyOutputDenormalMode(KnownSrc, Mode)`. These helpers allow us to
correctly handle the output/input denormal mode correctly every single
time, while also being much easier to use.
Example usage:
```c++
KnownFPClass func(const KnownFPClass& KnownSrc_, DenormalMode Mode) {
KnownFPClass KnownSrc = applyInputDenormalMode(KnownSrc_, Mode);
KnownFPClass Known;
// We can treat everything here as if it were IEEE.
return applyOutputDenormalMode(Known, Mode);
}
```
These helpers also allow us to safely replace
`isKnownNeverLogicalZero(Mode)` with `isKnownNeverZero()` as long as we
use `applyInputDenormalMode` at the start of the function.
Added:
Modified:
llvm/include/llvm/Support/KnownFPClass.h
llvm/lib/Support/KnownFPClass.cpp
Removed:
################################################################################
diff --git a/llvm/include/llvm/Support/KnownFPClass.h b/llvm/include/llvm/Support/KnownFPClass.h
index 22097a70a361b..33a115b679ad0 100644
--- a/llvm/include/llvm/Support/KnownFPClass.h
+++ b/llvm/include/llvm/Support/KnownFPClass.h
@@ -160,6 +160,16 @@ struct KnownFPClass {
return isKnownNever(fcPositive) && isKnownNeverLogicalNegZero(Mode);
}
+ /// Return the known classes of \p Src after passing through an input that
+ /// may flush subnormals to zero according to \p Mode.
+ LLVM_ABI static KnownFPClass applyInputDenormalMode(const KnownFPClass &Src,
+ DenormalMode Mode);
+
+ /// Return the known classes of \p Src after producing an output that may
+ /// flush subnormals to zero according to \p Mode.
+ LLVM_ABI static KnownFPClass applyOutputDenormalMode(const KnownFPClass &Src,
+ DenormalMode Mode);
+
KnownFPClass intersectWith(const KnownFPClass &RHS) const {
return KnownFPClass(getKnownFPClasses() | RHS.getKnownFPClasses(),
getSignBit() == RHS.getSignBit() ? getSignBit()
diff --git a/llvm/lib/Support/KnownFPClass.cpp b/llvm/lib/Support/KnownFPClass.cpp
index 11130a6139f9e..96d6a9758b8f8 100644
--- a/llvm/lib/Support/KnownFPClass.cpp
+++ b/llvm/lib/Support/KnownFPClass.cpp
@@ -23,48 +23,82 @@ KnownFPClass::KnownFPClass(const APFloat &C)
setSignBit(C.isNegative());
}
-/// Return true if it's possible to assume IEEE treatment of input denormals in
-/// \p F for \p Val.
-static bool inputDenormalIsIEEE(DenormalMode Mode) {
- return Mode.Input == DenormalMode::IEEE;
+KnownFPClass KnownFPClass::applyInputDenormalMode(const KnownFPClass &KnownSrc,
+ DenormalMode Mode) {
+ KnownFPClass Known = KnownSrc;
+ switch (Mode.Input) {
+ case DenormalMode::IEEE:
+ return Known;
+ case DenormalMode::PreserveSign:
+ if (KnownSrc.getKnownFPClasses() & fcPosSubnormal)
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcPosZero);
+ if (KnownSrc.getKnownFPClasses() & fcNegSubnormal)
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcNegZero);
+ return Known;
+ case DenormalMode::PositiveZero:
+ if (KnownSrc.getKnownFPClasses() & fcSubnormal) {
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcPosZero);
+ if (KnownSrc.getKnownFPClasses() & fcNegSubnormal)
+ Known.setSignBit(std::nullopt);
+ }
+ return Known;
+ default:
+ if (KnownSrc.getKnownFPClasses() & fcSubnormal) {
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcPosZero);
+ if (KnownSrc.getKnownFPClasses() & fcNegSubnormal)
+ Known.setSignBit(std::nullopt);
+ }
+ if (KnownSrc.getKnownFPClasses() & fcNegSubnormal)
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcNegZero);
+ return Known;
+ }
+
+ llvm_unreachable("covered switch over denormal mode");
}
-static bool inputDenormalIsIEEEOrPosZero(DenormalMode Mode) {
- return Mode.Input == DenormalMode::IEEE ||
- Mode.Input == DenormalMode::PositiveZero;
+KnownFPClass KnownFPClass::applyOutputDenormalMode(const KnownFPClass &KnownSrc,
+ DenormalMode Mode) {
+ KnownFPClass Known = KnownSrc;
+ switch (Mode.Output) {
+ case DenormalMode::IEEE:
+ return Known;
+ case DenormalMode::PreserveSign:
+ if (KnownSrc.getKnownFPClasses() & fcPosSubnormal)
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcPosZero);
+ if (KnownSrc.getKnownFPClasses() & fcNegSubnormal)
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcNegZero);
+ return Known;
+ case DenormalMode::PositiveZero:
+ if (KnownSrc.getKnownFPClasses() & fcSubnormal) {
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcPosZero);
+ if (KnownSrc.getKnownFPClasses() & fcNegSubnormal)
+ Known.setSignBit(std::nullopt);
+ }
+ return Known;
+ default:
+ if (KnownSrc.getKnownFPClasses() & fcSubnormal) {
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcPosZero);
+ if (KnownSrc.getKnownFPClasses() & fcNegSubnormal)
+ Known.setSignBit(std::nullopt);
+ }
+ if (KnownSrc.getKnownFPClasses() & fcNegSubnormal)
+ Known.setKnownFPClasses(Known.getKnownFPClasses() | fcNegZero);
+ return Known;
+ }
+
+ llvm_unreachable("covered switch over denormal mode");
}
bool KnownFPClass::isKnownNeverLogicalZero(DenormalMode Mode) const {
- return isKnownNeverZero() &&
- (isKnownNeverSubnormal() || inputDenormalIsIEEE(Mode));
+ return applyInputDenormalMode(*this, Mode).isKnownNeverZero();
}
bool KnownFPClass::isKnownNeverLogicalNegZero(DenormalMode Mode) const {
- return isKnownNeverNegZero() &&
- (isKnownNeverNegSubnormal() || inputDenormalIsIEEEOrPosZero(Mode));
+ return applyInputDenormalMode(*this, Mode).isKnownNeverNegZero();
}
bool KnownFPClass::isKnownNeverLogicalPosZero(DenormalMode Mode) const {
- if (!isKnownNeverPosZero())
- return false;
-
- // If we know there are no denormals, nothing can be flushed to zero.
- if (isKnownNeverSubnormal())
- return true;
-
- switch (Mode.Input) {
- case DenormalMode::IEEE:
- return true;
- case DenormalMode::PreserveSign:
- // Negative subnormal won't flush to +0
- return isKnownNeverPosSubnormal();
- case DenormalMode::PositiveZero:
- default:
- // Both positive and negative subnormal could flush to +0
- return false;
- }
-
- llvm_unreachable("covered switch over denormal mode");
+ return applyInputDenormalMode(*this, Mode).isKnownNeverPosZero();
}
void KnownFPClass::propagateDenormal(const KnownFPClass &Src,
@@ -905,9 +939,11 @@ KnownFPClass KnownFPClass::atan(const KnownFPClass &KnownSrc) {
return Known;
}
-KnownFPClass KnownFPClass::atan2(const KnownFPClass &KnownY,
- const KnownFPClass &KnownX,
+KnownFPClass KnownFPClass::atan2(const KnownFPClass &KnownY_,
+ const KnownFPClass &KnownX_,
DenormalMode Mode) {
+ KnownFPClass KnownY = applyInputDenormalMode(KnownY_, Mode);
+ KnownFPClass KnownX = applyInputDenormalMode(KnownX_, Mode);
KnownFPClass Known;
// Even though these deductions are correct, we are ignoring the following
@@ -920,14 +956,8 @@ KnownFPClass KnownFPClass::atan2(const KnownFPClass &KnownY,
Known.propagateNonNaN(KnownY, KnownX);
- // Negative subnormals could be treated like positive zero.
- const bool XCannotHavePositiveInput = KnownX.isKnownNever(fcPositive) &&
- KnownX.isKnownNeverLogicalPosZero(Mode);
- const bool YCannotHavePositiveInput = KnownY.isKnownNever(fcPositive) &&
- KnownY.isKnownNeverLogicalPosZero(Mode);
-
// If x <= -0.0, then |atan2(y, x)| >= pi/2
- if (XCannotHavePositiveInput)
+ if (KnownX.isKnownNever(fcPositive))
Known.knownNot(fcZero | fcSubnormal);
// If y >= +0.0, then atan2(y, x) >= +0.0
@@ -935,16 +965,10 @@ KnownFPClass KnownFPClass::atan2(const KnownFPClass &KnownY,
Known.knownNot(fcNegative);
// If y <= -0.0, then atan2(y, x) <= -0.0
- // We do this deduction last in case we were able to rule out a negative
- // subnormal result earlier.
- if (YCannotHavePositiveInput) {
- Known.knownNot(fcPosSubnormal | fcPosNormal | fcPosInf);
- // Negative subnormal results can flush to +0.0.
- if (Known.isKnownNever(fcNegSubnormal) || !Mode.outputsMayBePositiveZero())
- Known.knownNot(fcPosZero);
- }
+ if (KnownY.isKnownNever(fcPositive))
+ Known.knownNot(fcPositive);
- return Known;
+ return applyOutputDenormalMode(Known, Mode);
}
KnownFPClass KnownFPClass::fpext(const KnownFPClass &KnownSrc,
More information about the llvm-commits
mailing list