2016-06-14 16:44:14 +00:00
|
|
|
/* Helper macros for type generic function implementations within libm.
|
2025-01-01 18:14:45 +00:00
|
|
|
Copyright (C) 2016-2025 Free Software Foundation, Inc.
|
2016-06-14 16:44:14 +00:00
|
|
|
This file is part of the GNU C Library.
|
|
|
|
|
|
|
|
|
|
The GNU C Library is free software; you can redistribute it and/or
|
|
|
|
|
modify it under the terms of the GNU Lesser General Public
|
|
|
|
|
License as published by the Free Software Foundation; either
|
|
|
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
|
|
|
|
|
|
The GNU C Library is distributed in the hope that it will be useful,
|
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
Lesser General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
|
|
|
License along with the GNU C Library; if not, see
|
Prefer https to http for gnu.org and fsf.org URLs
Also, change sources.redhat.com to sourceware.org.
This patch was automatically generated by running the following shell
script, which uses GNU sed, and which avoids modifying files imported
from upstream:
sed -ri '
s,(http|ftp)(://(.*\.)?(gnu|fsf|sourceware)\.org($|[^.]|\.[^a-z])),https\2,g
s,(http|ftp)(://(.*\.)?)sources\.redhat\.com($|[^.]|\.[^a-z]),https\2sourceware.org\4,g
' \
$(find $(git ls-files) -prune -type f \
! -name '*.po' \
! -name 'ChangeLog*' \
! -path COPYING ! -path COPYING.LIB \
! -path manual/fdl-1.3.texi ! -path manual/lgpl-2.1.texi \
! -path manual/texinfo.tex ! -path scripts/config.guess \
! -path scripts/config.sub ! -path scripts/install-sh \
! -path scripts/mkinstalldirs ! -path scripts/move-if-change \
! -path INSTALL ! -path locale/programs/charmap-kw.h \
! -path po/libc.pot ! -path sysdeps/gnu/errlist.c \
! '(' -name configure \
-execdir test -f configure.ac -o -f configure.in ';' ')' \
! '(' -name preconfigure \
-execdir test -f preconfigure.ac ';' ')' \
-print)
and then by running 'make dist-prepare' to regenerate files built
from the altered files, and then executing the following to cleanup:
chmod a+x sysdeps/unix/sysv/linux/riscv/configure
# Omit irrelevant whitespace and comment-only changes,
# perhaps from a slightly-different Autoconf version.
git checkout -f \
sysdeps/csky/configure \
sysdeps/hppa/configure \
sysdeps/riscv/configure \
sysdeps/unix/sysv/linux/csky/configure
# Omit changes that caused a pre-commit check to fail like this:
# remote: *** error: sysdeps/powerpc/powerpc64/ppc-mcount.S: trailing lines
git checkout -f \
sysdeps/powerpc/powerpc64/ppc-mcount.S \
sysdeps/unix/sysv/linux/s390/s390-64/syscall.S
# Omit change that caused a pre-commit check to fail like this:
# remote: *** error: sysdeps/sparc/sparc64/multiarch/memcpy-ultra3.S: last line does not end in newline
git checkout -f sysdeps/sparc/sparc64/multiarch/memcpy-ultra3.S
2019-09-07 05:40:42 +00:00
|
|
|
<https://www.gnu.org/licenses/>. */
|
2016-06-14 16:44:14 +00:00
|
|
|
|
|
|
|
|
#ifndef _MATH_TYPE_MACROS
|
|
|
|
|
#define _MATH_TYPE_MACROS
|
|
|
|
|
|
|
|
|
|
/* Each type imports a header which is expected to
|
|
|
|
|
define:
|
|
|
|
|
|
|
|
|
|
M_LIT(x) - Paste the type specific suffix onto the constant x.
|
|
|
|
|
M_MLIT(x) - Paste the type specific suffix used by the macro
|
|
|
|
|
constants in math.h, i.e M_PI or M_PIl.
|
|
|
|
|
M_PFX - The prefixed used by float.h macros like FLT_MANT_DIG.
|
|
|
|
|
M_SUF(x) - Paste the the type specific suffix used by functions
|
|
|
|
|
i.e expf expl exp.
|
|
|
|
|
FLOAT - Resolves to the C typename of M_TYPE.
|
|
|
|
|
CFLOAT - Resolves to the complex typename of M_TYPE.
|
2016-09-12 22:32:07 +00:00
|
|
|
M_STRTO_NAN - Resolves to the internal libc function which
|
|
|
|
|
converts a string into the appropriate FLOAT nan
|
|
|
|
|
value.
|
Implement C23 pown
C23 adds various <math.h> function families originally defined in TS
18661-4. Add the pown functions, which are like pow but with an
integer exponent. That exponent has type long long int in C23; it was
intmax_t in TS 18661-4, and as with other interfaces changed after
their initial appearance in the TS, I don't think we need to support
the original version of the interface. The test inputs are based on
the subset of test inputs for pow that use integer exponents that fit
in long long.
As the first such template implementation that saves and restores the
rounding mode internally (to avoid possible issues with directed
rounding and intermediate overflows or underflows in the wrong
rounding mode), support also needed to be added for using
SET_RESTORE_ROUND* in such template function implementations. This
required math-type-macros-float128.h to include <fenv_private.h>, so
it can tell whether SET_RESTORE_ROUNDF128 is defined. In turn, the
include order with <fenv_private.h> included before <math_private.h>
broke loongarch builds, showing up that
sysdeps/loongarch/math_private.h is really a fenv_private.h file
(maybe implemented internally before the consistent split of those
headers in 2018?) and needed to be renamed to fenv_private.h to avoid
errors with duplicate macro definitions if <math_private.h> is
included after <fenv_private.h>.
The underlying implementation uses __ieee754_pow functions (called
more than once in some cases, where the exponent does not fit in the
floating type). I expect a custom implementation for a given format,
that only handles integer exponents but handles larger exponents
directly, could be faster and more accurate in some cases.
I encourage searching for worst cases for ulps error for these
implementations (necessarily non-exhaustively, given the size of the
input space).
Tested for x86_64 and x86, and with build-many-glibcs.py.
2025-03-27 10:44:44 +00:00
|
|
|
M_SET_RESTORE_ROUND - Resolves to a SET_RESTORE_ROUND call for M_TYPE.
|
2016-06-14 16:44:14 +00:00
|
|
|
|
|
|
|
|
declare_mgen_alias(from,to)
|
|
|
|
|
This exposes the appropriate symbol(s) for a
|
2017-10-09 22:04:18 +00:00
|
|
|
function f of type FLOAT.
|
|
|
|
|
|
|
|
|
|
declare_mgen_alias_r(from,to)
|
|
|
|
|
This exposes the appropriate symbol(s) for a
|
2018-05-16 04:03:08 +00:00
|
|
|
function f_r of type FLOAT.
|
|
|
|
|
|
Add narrowing square root functions
This patch adds the narrowing square root functions from TS 18661-1 /
TS 18661-3 / C2X to glibc's libm: fsqrt, fsqrtl, dsqrtl, f32sqrtf64,
f32sqrtf32x, f32xsqrtf64 for all configurations; f32sqrtf64x,
f32sqrtf128, f64sqrtf64x, f64sqrtf128, f32xsqrtf64x, f32xsqrtf128,
f64xsqrtf128 for configurations with _Float64x and _Float128;
__f32sqrtieee128 and __f64sqrtieee128 aliases in the powerpc64le case
(for calls to fsqrtl and dsqrtl when long double is IEEE binary128).
Corresponding tgmath.h macro support is also added.
The changes are mostly similar to those for the other narrowing
functions previously added, so the description of those generally
applies to this patch as well. However, the not-actually-narrowing
cases (where the two types involved in the function have the same
floating-point format) are aliased to sqrt, sqrtl or sqrtf128 rather
than needing a separately built not-actually-narrowing function such
as was needed for add / sub / mul / div. Thus, there is no
__nldbl_dsqrtl name for ldbl-opt because no such name was needed
(whereas the other functions needed such a name since the only other
name for that entry point was e.g. f32xaddf64, not reserved by TS
18661-1); the headers are made to arrange for sqrt to be called in
that case instead.
The DIAG_* calls in sysdeps/ieee754/soft-fp/s_dsqrtl.c are because
they were observed to be needed in GCC 7 testing of
riscv32-linux-gnu-rv32imac-ilp32. The other sysdeps/ieee754/soft-fp/
files added didn't need such DIAG_* in any configuration I tested with
build-many-glibcs.py, but if they do turn out to be needed in more
files with some other configuration / GCC version, they can always be
added there.
I reused the same test inputs in auto-libm-test-in as for
non-narrowing sqrt rather than adding extra or separate inputs for
narrowing sqrt. The tests in libm-test-narrow-sqrt.inc also follow
those for non-narrowing sqrt.
Tested as followed: natively with the full glibc testsuite for x86_64
(GCC 11, 7, 6) and x86 (GCC 11); with build-many-glibcs.py with GCC
11, 7 and 6; cross testing of math/ tests for powerpc64le, powerpc32
hard float, mips64 (all three ABIs, both hard and soft float). The
different GCC versions are to cover the different cases in tgmath.h
and tgmath.h tests properly (GCC 6 has _Float* only as typedefs in
glibc headers, GCC 7 has proper _Float* support, GCC 8 adds
__builtin_tgmath).
2021-09-10 20:56:22 +00:00
|
|
|
declare_mgen_alias_narrow(from,to)
|
|
|
|
|
This exposes the appropriate symbol(s) for narrowing aliases of a
|
|
|
|
|
function f of type FLOAT.
|
|
|
|
|
|
2018-05-16 04:03:08 +00:00
|
|
|
SET_NAN_PAYLOAD(flt, mant)
|
|
|
|
|
Set the NaN payload bits of the variable FLT of type FLOAT to
|
|
|
|
|
the mantissa MANT. */
|
2016-06-14 16:44:14 +00:00
|
|
|
|
|
|
|
|
#ifndef M_PFX
|
|
|
|
|
# error "M_PFX must be defined."
|
|
|
|
|
#endif
|
|
|
|
|
#ifndef M_LIT
|
|
|
|
|
# error "M_LIT must be defined."
|
|
|
|
|
#endif
|
|
|
|
|
#ifndef M_MLIT
|
|
|
|
|
# error "M_MLIT must be defined."
|
|
|
|
|
#endif
|
|
|
|
|
#ifndef M_SUF
|
|
|
|
|
# error "M_SUF must be defined."
|
|
|
|
|
#endif
|
|
|
|
|
#ifndef FLOAT
|
|
|
|
|
# error "FLOAT must be defined."
|
|
|
|
|
#endif
|
|
|
|
|
#ifndef CFLOAT
|
|
|
|
|
# error "CFLOAT must be defined."
|
|
|
|
|
#endif
|
2017-10-09 22:04:18 +00:00
|
|
|
#ifndef declare_mgen_alias
|
|
|
|
|
# error "declare_mgen_alias must be defined."
|
|
|
|
|
#endif
|
|
|
|
|
#ifndef declare_mgen_alias_r
|
|
|
|
|
# error "declare_mgen_alias_r must be defined."
|
|
|
|
|
#endif
|
Add narrowing square root functions
This patch adds the narrowing square root functions from TS 18661-1 /
TS 18661-3 / C2X to glibc's libm: fsqrt, fsqrtl, dsqrtl, f32sqrtf64,
f32sqrtf32x, f32xsqrtf64 for all configurations; f32sqrtf64x,
f32sqrtf128, f64sqrtf64x, f64sqrtf128, f32xsqrtf64x, f32xsqrtf128,
f64xsqrtf128 for configurations with _Float64x and _Float128;
__f32sqrtieee128 and __f64sqrtieee128 aliases in the powerpc64le case
(for calls to fsqrtl and dsqrtl when long double is IEEE binary128).
Corresponding tgmath.h macro support is also added.
The changes are mostly similar to those for the other narrowing
functions previously added, so the description of those generally
applies to this patch as well. However, the not-actually-narrowing
cases (where the two types involved in the function have the same
floating-point format) are aliased to sqrt, sqrtl or sqrtf128 rather
than needing a separately built not-actually-narrowing function such
as was needed for add / sub / mul / div. Thus, there is no
__nldbl_dsqrtl name for ldbl-opt because no such name was needed
(whereas the other functions needed such a name since the only other
name for that entry point was e.g. f32xaddf64, not reserved by TS
18661-1); the headers are made to arrange for sqrt to be called in
that case instead.
The DIAG_* calls in sysdeps/ieee754/soft-fp/s_dsqrtl.c are because
they were observed to be needed in GCC 7 testing of
riscv32-linux-gnu-rv32imac-ilp32. The other sysdeps/ieee754/soft-fp/
files added didn't need such DIAG_* in any configuration I tested with
build-many-glibcs.py, but if they do turn out to be needed in more
files with some other configuration / GCC version, they can always be
added there.
I reused the same test inputs in auto-libm-test-in as for
non-narrowing sqrt rather than adding extra or separate inputs for
narrowing sqrt. The tests in libm-test-narrow-sqrt.inc also follow
those for non-narrowing sqrt.
Tested as followed: natively with the full glibc testsuite for x86_64
(GCC 11, 7, 6) and x86 (GCC 11); with build-many-glibcs.py with GCC
11, 7 and 6; cross testing of math/ tests for powerpc64le, powerpc32
hard float, mips64 (all three ABIs, both hard and soft float). The
different GCC versions are to cover the different cases in tgmath.h
and tgmath.h tests properly (GCC 6 has _Float* only as typedefs in
glibc headers, GCC 7 has proper _Float* support, GCC 8 adds
__builtin_tgmath).
2021-09-10 20:56:22 +00:00
|
|
|
#ifndef declare_mgen_alias_narrow
|
|
|
|
|
# error "declare_mgen_alias_narrow must be defined."
|
|
|
|
|
#endif
|
2018-05-16 04:03:08 +00:00
|
|
|
#ifndef SET_NAN_PAYLOAD
|
|
|
|
|
# error "SET_NAN_PAYLOAD must be defined."
|
|
|
|
|
#endif
|
2016-06-14 16:44:14 +00:00
|
|
|
|
2018-06-20 20:42:47 +00:00
|
|
|
#ifndef declare_mgen_finite_alias_x
|
2019-07-16 15:17:22 +00:00
|
|
|
#define declare_mgen_finite_alias_x(from, to) \
|
|
|
|
|
libm_alias_finite (from, to)
|
2018-06-20 20:42:47 +00:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifndef declare_mgen_finite_alias_s
|
|
|
|
|
# define declare_mgen_finite_alias_s(from,to) \
|
|
|
|
|
declare_mgen_finite_alias_x (from, to)
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#ifndef declare_mgen_finite_alias
|
|
|
|
|
# define declare_mgen_finite_alias(from, to) \
|
|
|
|
|
declare_mgen_finite_alias_s (M_SUF (from), M_SUF (to))
|
|
|
|
|
#endif
|
|
|
|
|
|
2016-06-14 16:44:14 +00:00
|
|
|
#define __M_CONCAT(a,b) a ## b
|
|
|
|
|
#define __M_CONCATX(a,b) __M_CONCAT(a,b)
|
|
|
|
|
|
2016-09-12 22:11:45 +00:00
|
|
|
#define M_NAN M_SUF (__builtin_nan) ("")
|
2017-05-16 16:34:34 +00:00
|
|
|
#define M_MIN_EXP __M_CONCATX (M_PFX, _MIN_EXP)
|
2016-06-14 16:44:14 +00:00
|
|
|
#define M_MAX_EXP __M_CONCATX (M_PFX, _MAX_EXP)
|
|
|
|
|
#define M_MIN __M_CONCATX (M_PFX, _MIN)
|
|
|
|
|
#define M_MAX __M_CONCATX (M_PFX, _MAX)
|
|
|
|
|
#define M_MANT_DIG __M_CONCATX (M_PFX, _MANT_DIG)
|
|
|
|
|
#define M_HUGE_VAL (M_SUF (__builtin_huge_val) ())
|
|
|
|
|
|
|
|
|
|
/* Helper macros for commonly used functions. */
|
2018-09-27 20:04:48 +00:00
|
|
|
#define M_COPYSIGN M_SUF (copysign)
|
2016-06-14 16:44:14 +00:00
|
|
|
#define M_FABS M_SUF (fabs)
|
|
|
|
|
#define M_SINCOS M_SUF (__sincos)
|
|
|
|
|
#define M_SCALBN M_SUF (__scalbn)
|
|
|
|
|
#define M_LOG1P M_SUF (__log1p)
|
|
|
|
|
|
|
|
|
|
#define M_ATAN2 M_SUF (__ieee754_atan2)
|
|
|
|
|
#define M_COSH M_SUF (__ieee754_cosh)
|
|
|
|
|
#define M_EXP M_SUF (__ieee754_exp)
|
|
|
|
|
#define M_HYPOT M_SUF (__ieee754_hypot)
|
|
|
|
|
#define M_LOG M_SUF (__ieee754_log)
|
|
|
|
|
#define M_SINH M_SUF (__ieee754_sinh)
|
2018-03-15 18:21:58 +00:00
|
|
|
#define M_SQRT M_SUF (sqrt)
|
2016-06-14 16:44:14 +00:00
|
|
|
|
|
|
|
|
/* Needed to evaluate M_MANT_DIG below. */
|
|
|
|
|
#include <float.h>
|
2019-07-16 15:17:22 +00:00
|
|
|
#include <libm-alias-finite.h>
|
2016-06-14 16:44:14 +00:00
|
|
|
|
|
|
|
|
/* Use a special epsilon value for IBM long double
|
|
|
|
|
to avoid spurious overflows/underflows. */
|
|
|
|
|
#if M_MANT_DIG != 106
|
|
|
|
|
# define M_EPSILON __M_CONCATX (M_PFX, _EPSILON)
|
|
|
|
|
#else
|
|
|
|
|
# define M_EPSILON M_LIT (0x1p-106)
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/* Enable overloading of function name to assist reuse. */
|
|
|
|
|
#ifndef M_DECL_FUNC
|
|
|
|
|
# define M_DECL_FUNC(f) M_SUF (f)
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#endif /* _MATH_TYPE_MACROS */
|
