172 lines · c
1//===-- Utility class to test different flavors of float sub ----*- C++ -*-===//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-exception6//7//===----------------------------------------------------------------------===//8 9#ifndef LLVM_LIBC_TEST_SRC_MATH_SMOKE_SUBTEST_H10#define LLVM_LIBC_TEST_SRC_MATH_SMOKE_SUBTEST_H11 12#include "hdr/errno_macros.h"13#include "hdr/fenv_macros.h"14#include "src/__support/macros/properties/os.h"15#include "test/UnitTest/FEnvSafeTest.h"16#include "test/UnitTest/FPMatcher.h"17#include "test/UnitTest/Test.h"18 19using LIBC_NAMESPACE::Sign;20 21template <typename OutType, typename InType>22class SubTest : public LIBC_NAMESPACE::testing::FEnvSafeTest {23 24 DECLARE_SPECIAL_CONSTANTS(OutType)25 26 struct InConstants {27 DECLARE_SPECIAL_CONSTANTS(InType)28 };29 30 using InFPBits = typename InConstants::FPBits;31 using InStorageType = typename InConstants::StorageType;32 33 InConstants in;34 35public:36 using SubFunc = OutType (*)(InType, InType);37 38 void test_special_numbers(SubFunc func) {39 EXPECT_FP_IS_NAN(func(in.aNaN, in.aNaN));40 EXPECT_FP_IS_NAN_WITH_EXCEPTION(func(in.sNaN, in.sNaN), FE_INVALID);41 42 InType qnan_42 = InFPBits::quiet_nan(Sign::POS, 0x42).get_val();43 EXPECT_FP_IS_NAN(func(qnan_42, in.zero));44 EXPECT_FP_IS_NAN(func(in.zero, qnan_42));45 46 EXPECT_FP_EQ(inf, func(in.inf, in.zero));47 EXPECT_FP_EQ(neg_inf, func(in.neg_inf, in.zero));48 EXPECT_FP_EQ(inf, func(in.inf, in.neg_zero));49 EXPECT_FP_EQ(neg_inf, func(in.neg_inf, in.neg_zero));50 EXPECT_FP_EQ(neg_inf, func(in.zero, in.inf));51 EXPECT_FP_EQ(neg_inf, func(in.neg_zero, in.inf));52 EXPECT_FP_EQ(inf, func(in.zero, in.neg_inf));53 EXPECT_FP_EQ(inf, func(in.neg_zero, in.neg_inf));54 }55 56 void test_invalid_operations(SubFunc func) {57 EXPECT_FP_IS_NAN_WITH_EXCEPTION(func(in.inf, in.inf), FE_INVALID);58 EXPECT_FP_IS_NAN_WITH_EXCEPTION(func(in.neg_inf, in.neg_inf), FE_INVALID);59 }60 61 void test_range_errors(SubFunc func) {62#ifndef LIBC_TARGET_OS_IS_WINDOWS63 using namespace LIBC_NAMESPACE::fputil::testing;64 65 if (LIBC_NAMESPACE::fputil::get_fp_type<OutType>() ==66 LIBC_NAMESPACE::fputil::get_fp_type<InType>())67 return;68 69 if (ForceRoundingMode r(RoundingMode::Nearest); r.success) {70 EXPECT_FP_EQ_WITH_EXCEPTION(inf, func(in.max_normal, in.neg_max_normal),71 FE_OVERFLOW | FE_INEXACT);72 EXPECT_MATH_ERRNO(ERANGE);73 EXPECT_FP_EQ_WITH_EXCEPTION(-inf, func(in.neg_max_normal, in.max_normal),74 FE_OVERFLOW | FE_INEXACT);75 EXPECT_MATH_ERRNO(ERANGE);76 77 EXPECT_FP_EQ_WITH_EXCEPTION(zero,78 func(in.min_denormal, in.neg_min_denormal),79 FE_UNDERFLOW | FE_INEXACT);80 EXPECT_MATH_ERRNO(ERANGE);81 EXPECT_FP_EQ_WITH_EXCEPTION(neg_zero,82 func(in.neg_min_denormal, in.min_denormal),83 FE_UNDERFLOW | FE_INEXACT);84 EXPECT_MATH_ERRNO(ERANGE);85 }86 87 if (ForceRoundingMode r(RoundingMode::TowardZero); r.success) {88 EXPECT_FP_EQ_WITH_EXCEPTION(max_normal,89 func(in.max_normal, in.neg_max_normal),90 FE_OVERFLOW | FE_INEXACT);91 EXPECT_FP_EQ_WITH_EXCEPTION(neg_max_normal,92 func(in.neg_max_normal, in.max_normal),93 FE_OVERFLOW | FE_INEXACT);94 95 EXPECT_FP_EQ_WITH_EXCEPTION(zero,96 func(in.min_denormal, in.neg_min_denormal),97 FE_UNDERFLOW | FE_INEXACT);98 EXPECT_MATH_ERRNO(ERANGE);99 EXPECT_FP_EQ_WITH_EXCEPTION(neg_zero,100 func(in.neg_min_denormal, in.min_denormal),101 FE_UNDERFLOW | FE_INEXACT);102 EXPECT_MATH_ERRNO(ERANGE);103 }104 105 if (ForceRoundingMode r(RoundingMode::Downward); r.success) {106 EXPECT_FP_EQ_WITH_EXCEPTION(max_normal,107 func(in.max_normal, in.neg_max_normal),108 FE_OVERFLOW | FE_INEXACT);109 EXPECT_FP_EQ_WITH_EXCEPTION(-inf, func(in.neg_max_normal, in.max_normal),110 FE_OVERFLOW | FE_INEXACT);111 EXPECT_MATH_ERRNO(ERANGE);112 113 EXPECT_FP_EQ_WITH_EXCEPTION(zero,114 func(in.min_denormal, in.neg_min_denormal),115 FE_UNDERFLOW | FE_INEXACT);116 EXPECT_MATH_ERRNO(ERANGE);117 EXPECT_FP_EQ_WITH_EXCEPTION(neg_min_denormal,118 func(in.neg_min_denormal, in.min_denormal),119 FE_UNDERFLOW | FE_INEXACT);120 EXPECT_MATH_ERRNO(ERANGE);121 }122 123 if (ForceRoundingMode r(RoundingMode::Upward); r.success) {124 EXPECT_FP_EQ_WITH_EXCEPTION(inf, func(in.max_normal, in.neg_max_normal),125 FE_OVERFLOW | FE_INEXACT);126 EXPECT_MATH_ERRNO(ERANGE);127 EXPECT_FP_EQ_WITH_EXCEPTION(neg_max_normal,128 func(in.neg_max_normal, in.max_normal),129 FE_OVERFLOW | FE_INEXACT);130 131 EXPECT_FP_EQ_WITH_EXCEPTION(min_denormal,132 func(in.min_denormal, in.neg_min_denormal),133 FE_UNDERFLOW | FE_INEXACT);134 EXPECT_MATH_ERRNO(ERANGE);135 EXPECT_FP_EQ_WITH_EXCEPTION(neg_zero,136 func(in.neg_min_denormal, in.min_denormal),137 FE_UNDERFLOW | FE_INEXACT);138 EXPECT_MATH_ERRNO(ERANGE);139 }140#endif141 }142 143 void test_inexact_results(SubFunc func) {144 func(InType(1.0), in.min_denormal);145 EXPECT_FP_EXCEPTION(FE_INEXACT);146 }147};148 149#define LIST_SUB_TESTS(OutType, InType, func) \150 using LlvmLibcSubTest = SubTest<OutType, InType>; \151 TEST_F(LlvmLibcSubTest, SpecialNumbers) { test_special_numbers(&func); } \152 TEST_F(LlvmLibcSubTest, InvalidOperations) { \153 test_invalid_operations(&func); \154 } \155 TEST_F(LlvmLibcSubTest, RangeErrors) { test_range_errors(&func); } \156 TEST_F(LlvmLibcSubTest, InexactResults) { test_inexact_results(&func); }157 158#define LIST_SUB_SAME_TYPE_TESTS(suffix, OutType, InType, func) \159 using LlvmLibcSubTest##suffix = SubTest<OutType, InType>; \160 TEST_F(LlvmLibcSubTest##suffix, SpecialNumbers) { \161 test_special_numbers(&func); \162 } \163 TEST_F(LlvmLibcSubTest##suffix, InvalidOperations) { \164 test_invalid_operations(&func); \165 } \166 TEST_F(LlvmLibcSubTest##suffix, RangeErrors) { test_range_errors(&func); } \167 TEST_F(LlvmLibcSubTest##suffix, InexactResults) { \168 test_inexact_results(&func); \169 }170 171#endif // LLVM_LIBC_TEST_SRC_MATH_SMOKE_SUBTEST_H172