1//===-- Utility class to test different flavors of fma --------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_LIBC_TEST_SRC_MATH_FMATEST_H
10#define LLVM_LIBC_TEST_SRC_MATH_FMATEST_H
11
12#include "src/stdlib/rand.h"
13#include "src/stdlib/srand.h"
14#include "test/UnitTest/FEnvSafeTest.h"
15#include "test/UnitTest/FPMatcher.h"
16#include "test/UnitTest/Test.h"
17#include "utils/MPFRWrapper/MPFRUtils.h"
18
19namespace mpfr = LIBC_NAMESPACE::testing::mpfr;
20
21template <typename OutType, typename InType = OutType>
22class FmaTestTemplate : public LIBC_NAMESPACE::testing::FEnvSafeTest {
23
24 struct OutConstants {
25 DECLARE_SPECIAL_CONSTANTS(OutType)
26 };
27
28 struct InConstants {
29 DECLARE_SPECIAL_CONSTANTS(InType)
30 };
31
32 using OutFPBits = typename OutConstants::FPBits;
33 using OutStorageType = typename OutConstants::StorageType;
34 using InFPBits = typename InConstants::FPBits;
35 using InStorageType = typename InConstants::StorageType;
36
37 static constexpr OutStorageType OUT_MIN_NORMAL_U =
38 OutFPBits::min_normal().uintval();
39 static constexpr InStorageType IN_MAX_NORMAL_U =
40 InFPBits::max_normal().uintval();
41 static constexpr InStorageType IN_MIN_NORMAL_U =
42 InFPBits::min_normal().uintval();
43 static constexpr InStorageType IN_MAX_SUBNORMAL_U =
44 InFPBits::max_subnormal().uintval();
45 static constexpr InStorageType IN_MIN_SUBNORMAL_U =
46 InFPBits::min_subnormal().uintval();
47
48 InStorageType get_random_bit_pattern() {
49 InStorageType bits{0};
50 for (InStorageType i = 0; i < sizeof(InStorageType) / 2; ++i) {
51 bits = (bits << 2) + static_cast<uint16_t>(LIBC_NAMESPACE::rand());
52 }
53 return bits;
54 }
55
56public:
57 using FmaFunc = OutType (*)(InType, InType, InType);
58
59 void test_subnormal_range(FmaFunc func) {
60 constexpr InStorageType COUNT = 100'001;
61 constexpr InStorageType RAW_STEP =
62 (IN_MAX_SUBNORMAL_U - IN_MIN_SUBNORMAL_U) / COUNT;
63 constexpr InStorageType STEP = (RAW_STEP == 0 ? 1 : RAW_STEP);
64 LIBC_NAMESPACE::srand(1);
65 for (InStorageType v = IN_MIN_SUBNORMAL_U, w = IN_MAX_SUBNORMAL_U;
66 v <= IN_MAX_SUBNORMAL_U && w >= IN_MIN_SUBNORMAL_U;
67 v += STEP, w -= STEP) {
68 InType x = InFPBits(get_random_bit_pattern()).get_val();
69 InType y = InFPBits(v).get_val();
70 InType z = InFPBits(w).get_val();
71 mpfr::TernaryInput<InType> input{x, y, z};
72 ASSERT_MPFR_MATCH_ALL_ROUNDING(mpfr::Operation::Fma, input, func(x, y, z),
73 0.5);
74 }
75 }
76
77 void test_normal_range(FmaFunc func) {
78 constexpr InStorageType COUNT = 100'001;
79 constexpr InStorageType RAW_STEP =
80 (IN_MAX_NORMAL_U - IN_MIN_NORMAL_U) / COUNT;
81 constexpr InStorageType STEP = (RAW_STEP == 0 ? 1 : RAW_STEP);
82 LIBC_NAMESPACE::srand(1);
83 for (InStorageType v = IN_MIN_NORMAL_U, w = IN_MAX_NORMAL_U;
84 v <= IN_MAX_NORMAL_U && w >= IN_MIN_NORMAL_U; v += STEP, w -= STEP) {
85 InType x = InFPBits(v).get_val();
86 InType y = InFPBits(w).get_val();
87 InType z = InFPBits(get_random_bit_pattern()).get_val();
88 mpfr::TernaryInput<InType> input{x, y, z};
89 ASSERT_MPFR_MATCH_ALL_ROUNDING(mpfr::Operation::Fma, input, func(x, y, z),
90 0.5);
91 }
92 }
93};
94
95#define LIST_FMA_TESTS(T, func) \
96 using LlvmLibcFmaTest = FmaTestTemplate<T>; \
97 TEST_F(LlvmLibcFmaTest, SubnormalRange) { test_subnormal_range(&func); } \
98 TEST_F(LlvmLibcFmaTest, NormalRange) { test_normal_range(&func); }
99
100#define LIST_NARROWING_FMA_TESTS(OutType, InType, func) \
101 using LlvmLibcFmaTest = FmaTestTemplate<OutType, InType>; \
102 TEST_F(LlvmLibcFmaTest, SubnormalRange) { test_subnormal_range(&func); } \
103 TEST_F(LlvmLibcFmaTest, NormalRange) { test_normal_range(&func); }
104
105#endif // LLVM_LIBC_TEST_SRC_MATH_FMATEST_H
106

source code of libc/test/src/math/FmaTest.h