[llvm] [RFC][SPIR-V] Add intrinsics to convert to/from ap.float (PR #164252)
Dmitry Sidorov via llvm-commits
llvm-commits at lists.llvm.org
Mon Dec 8 17:53:26 PST 2025
================
@@ -21406,6 +21406,170 @@ environment <floatenv>` *except* for the rounding mode.
This intrinsic is not supported on all targets. Some targets may not support
all rounding modes.
+'``llvm.convert.to.arbitrary.fp``' Intrinsic
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Syntax:
+"""""""
+
+::
+
+ declare <iNxM> @llvm.convert.to.arbitrary.fp.<iNxM>.<fNxM>(
+ <fNxM> <value>, metadata <interpretation>,
+ metadata <rounding mode>, i1 <saturation>)
+
+Overview:
+"""""""""
+
+The ``llvm.convert.to.arbitrary.fp`` intrinsic converts a native LLVM
+floating-point value to an arbitrary FP format, returning the result as an integer
+containing the arbitrary FP bits. This intrinsic is overloaded on both its return
+type and first argument.
+
+Arguments:
+""""""""""
+
+``value``
+ The native LLVM floating-point value to convert (e.g., ``half``, ``float``, ``double``).
+
+``interpretation``
+ A metadata string describing the target arbitrary FP format. Supported format names include:
+
+ - FP8 formats: ``"Float8E5M2"``, ``"Float8E5M2FNUZ"``, ``"Float8E4M3"``,
+ ``"Float8E4M3FN"``, ``"Float8E4M3FNUZ"``, ``"Float8E4M3B11FNUZ"``, ``"Float8E3M4"``,
+ ``"Float8E8M0FNU"``
+ - FP6 formats: ``"Float6E3M2FN"``, ``"Float6E2M3FN"``
+ - FP4 formats: ``"Float4E2M1FN"``
+
+``rounding mode``
+ A metadata string specifying the rounding mode. The permitted strings match those
+ accepted by :ref:`llvm.fptrunc.round <int_fptrunc_round>` (for example,
+ ``"round.tonearest"`` or ``"round.towardzero"``).
+
+ The rounding mode is only consulted when ``value`` is not exactly representable in the target format.
+ If the value is exactly representable, all rounding modes produce the same result.
+
+``saturation``
+ A compile-time constant boolean value (``i1``). This parameter controls how overflow is handled
+ when values exceed the representable finite range of the target format:
+
+ - When ``true``: overflowing values are clamped to the minimum or maximum representable finite value
+ (saturating to the largest negative finite value or largest positive finite value).
+ - When ``false``: overflowing values are converted to infinity (preserving sign of the original value) if the
+ target format supports infinity, or return a poison value if infinity is not supported
+ by the target format.
+
+ This parameter must be an immediate constant.
+
+Semantics:
+""""""""""
+
+The intrinsic converts the native LLVM floating-point value to the arbitrary FP
+format specified by ``interpretation``, applying the requested rounding mode and
+saturation behavior. The conversion is performed in two steps: first, the value is
+rounded according to the specified rounding mode to fit the target format's precision;
+then, if the rounded result exceeds the target format's representable range, saturation
+is applied according to the ``saturation`` parameter. The result is returned as an
+integer (e.g., ``i8`` for FP8, ``i6`` for FP6) containing the encoded arbitrary FP bits.
+
+**Handling of special values:**
+
+- **NaN**: If the input is NaN and the target format supports NaN, it is converted to a NaN
+ representation in the target format. The exact NaN payload and quiet/signaling status are
+ implementation-defined; implementations may preserve them when the target supports it.
+ If the target format does not support NaN, the intrinsic returns a poison value.
+- **Infinity**: If the input is +/-Inf:
+
+ - When ``saturation`` is ``false`` and the target format supports infinity, +/-Inf is preserved.
+ - When ``saturation`` is ``false`` and the target format does not support infinity (e.g., formats
+ with "FN" suffix), the intrinsic returns a poison value.
+ - When ``saturation`` is ``true``, +/-Inf is clamped to the maximum/minimum representable finite value.
+
+- **Overflow**: When a finite value exceeds the representable range:
+
+ - When ``saturation`` is ``true``, the value is clamped to the maximum/minimum representable finite value.
+ - When ``saturation`` is ``false`` and the target format supports infinity, the value becomes +/-Inf.
+ - When ``saturation`` is ``false`` and the target format does not support infinity, the intrinsic
+ returns a poison value.
+
+For FP6/FP4 interpretations, producers are expected to use ``saturation`` = ``true``; using ``saturation`` = ``false`` and generating NaN/Inf/overflowing values is undefined (poison).
+
+Example:
+""""""""
+
+::
+
+ ; Convert half to FP8 E4M3 format
+ %fp8bits = call i8 @llvm.convert.to.arbitrary.fp.i8.f16(
+ half %value, metadata !"Float8E4M3",
+ metadata !"round.tonearest", i1 false)
+
+ ; Convert vector of float to FP8 E5M2 with saturation
+ %vec_fp8 = call <4 x i8> @llvm.convert.to.arbitrary.fp.v4i8.v4f32(
+ <4 x float> %values, metadata !"Float8E5M2",
+ metadata !"round.towardzero", i1 true)
+
+'``llvm.convert.from.arbitrary.fp``' Intrinsic
----------------
MrSidims wrote:
I removed saturation and rounding as they are not needed for 'mini-float' to float conversions. There can be one exception of E8M0 to half precision conversion, but if needed - it can be done without an intrinsic.
https://github.com/llvm/llvm-project/pull/164252
More information about the llvm-commits
mailing list