diff --git a/clang/docs/LanguageExtensions.rst b/clang/docs/LanguageExtensions.rst --- a/clang/docs/LanguageExtensions.rst +++ b/clang/docs/LanguageExtensions.rst @@ -3246,7 +3246,7 @@ double __builtin_canonicalize(double); float __builtin_canonicalizef(float); - long double__builtin_canonicalizel(long double); + long double __builtin_canonicalizel(long double); Returns the platform specific canonical encoding of a floating point number. This canonicalization is useful for implementing certain @@ -3254,6 +3254,28 @@ `_ for more information on the semantics. +``__builtin_flt_rounds`` and ``__builtin_set_flt_rounds`` +--------------------------------------------------------- + +.. code-block:: c + + int __builtin_flt_rounds(); + void __builtin_set_flt_rounds(int); + +Returns and sets current floating point rounding mode. The encoding of returned +values and input parameters is same as the result of FLT_ROUNDS, specified by C +standard: +0 - toward zero +1 - to nearest, ties to even +2 - toward positive infinity +3 - toward negative infinity +4 - to nearest, ties away from zero +The effect of passing some other value to ``__builtin_flt_rounds`` is +implementation-defined. ``__builtin_set_flt_rounds`` is currently only supported +to work on x86, x86_64, Arm and AArch64 targets. These builtins read and modify +the floating-point environment, which is not always allowed and may have unexpected +behavior. Please see the section on `Accessing the floating point environment `_ for more information. + String builtins --------------- diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst --- a/clang/docs/UsersManual.rst +++ b/clang/docs/UsersManual.rst @@ -1368,6 +1368,24 @@ Controlling Floating Point Behavior ----------------------------------- +.. _floating-point-environment: + +Accessing the floating point environment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Many targets allow floating point operations to be configured to control things +such as how inexact results should be rounded and how exceptional conditions +should be handled. This configuration is called the floating point environment. +C and C++ restrict access to the floating point environment by default, and the +compiler is allowed to assume that all operations are performed in the default +environment. When code is compiled in this default mode, operations that depend +on the environment (such as floating-point arithmetic and `FLT_ROUNDS`) may have +undefined behavior if the dynamic environment is not the default environment; for +example, `FLT_ROUNDS` may or may not simply return its default value for the target +instead of reading the dynamic environment, and floating-point operations may be +optimized as if the dynamic environment were the default. Similarly, it is undefined +behavior to change the floating point environment in this default mode, for example +by calling the `fesetround` function. + Clang provides a number of ways to control floating point behavior, including with command line options and source pragmas. This section describes the various floating point semantic modes and the corresponding options.