Skip to content

Commit 84fc86c

Browse files
overmightyovermighty
committed
[libc][math][c23] Add getpayloadf16 C23 math function
1 parent 1623866 commit 84fc86c

File tree

13 files changed

+167
-1
lines changed

13 files changed

+167
-1
lines changed

‎libc/config/linux/aarch64/entrypoints.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -522,6 +522,7 @@ if(LIBC_TYPES_HAS_FLOAT16)
522522
libc.src.math.frexpf16
523523
libc.src.math.fromfpf16
524524
libc.src.math.fromfpxf16
525+
libc.src.math.getpayloadf16
525526
libc.src.math.ilogbf16
526527
libc.src.math.llogbf16
527528
libc.src.math.llrintf16

‎libc/config/linux/x86_64/entrypoints.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -555,6 +555,7 @@ if(LIBC_TYPES_HAS_FLOAT16)
555555
libc.src.math.frexpf16
556556
libc.src.math.fromfpf16
557557
libc.src.math.fromfpxf16
558+
libc.src.math.getpayloadf16
558559
libc.src.math.ilogbf16
559560
libc.src.math.llogbf16
560561
libc.src.math.llrintf16

‎libc/docs/c23.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Additions:
4444
* compoundn*
4545
* totalorder* |check|
4646
* totalordermag* |check|
47-
* getpayload*
47+
* getpayload* |check|
4848
* setpayload*
4949
* iscannonical
5050
* issignaling

‎libc/docs/math/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ Basic Operations
170170
+------------------+------------------+-----------------+------------------------+----------------------+------------------------+------------------------+----------------------------+
171171
| fsub | N/A | | | N/A | | 7.12.14.2 | F.10.11 |
172172
+------------------+------------------+-----------------+------------------------+----------------------+------------------------+------------------------+----------------------------+
173+
| getpayload | | | | |check| | | F.10.13.1 | N/A |
174+
+------------------+------------------+-----------------+------------------------+----------------------+------------------------+------------------------+----------------------------+
173175
| ilogb | |check| | |check| | |check| | |check| | |check| | 7.12.6.8 | F.10.3.8 |
174176
+------------------+------------------+-----------------+------------------------+----------------------+------------------------+------------------------+----------------------------+
175177
| ldexp | |check| | |check| | |check| | | |check| | 7.12.6.9 | F.10.3.9 |

‎libc/spec/stdc.td

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -716,6 +716,8 @@ def StdC : StandardSpec<"stdc"> {
716716

717717
GuardedFunctionSpec<"totalordermagf16", RetValSpec<IntType>, [ArgSpec<Float16Ptr>, ArgSpec<Float16Ptr>], "LIBC_TYPES_HAS_FLOAT16">,
718718

719+
GuardedFunctionSpec<"getpayloadf16", RetValSpec<Float16Type>, [ArgSpec<Float16Ptr>], "LIBC_TYPES_HAS_FLOAT16">,
720+
719721
GuardedFunctionSpec<"f16sqrtf", RetValSpec<Float16Type>, [ArgSpec<FloatType>], "LIBC_TYPES_HAS_FLOAT16">,
720722
]
721723
>;

‎libc/src/__support/FPUtil/BasicOperations.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,17 @@ totalordermag(T x, T y) {
265265
return FPBits<T>(x).abs().uintval() <= FPBits<T>(y).abs().uintval();
266266
}
267267

268+
template <typename T>
269+
LIBC_INLINE cpp::enable_if_t<cpp::is_floating_point_v<T>, T> getpayload(T x) {
270+
using FPBits = FPBits<T>;
271+
FPBits x_bits(x);
272+
273+
if (!x_bits.is_nan())
274+
return T(-1.0);
275+
276+
return T(x_bits.uintval() & (FPBits::FRACTION_MASK >> 1));
277+
}
278+
268279
} // namespace fputil
269280
} // namespace LIBC_NAMESPACE
270281

‎libc/src/math/CMakeLists.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,8 @@ add_math_entrypoint_object(fromfpxl)
210210
add_math_entrypoint_object(fromfpxf16)
211211
add_math_entrypoint_object(fromfpxf128)
212212

213+
add_math_entrypoint_object(getpayloadf16)
214+
213215
add_math_entrypoint_object(hypot)
214216
add_math_entrypoint_object(hypotf)
215217

‎libc/src/math/generic/CMakeLists.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3602,6 +3602,19 @@ add_entrypoint_object(
36023602
-O3
36033603
)
36043604

3605+
add_entrypoint_object(
3606+
getpayloadf16
3607+
SRCS
3608+
getpayloadf16.cpp
3609+
HDRS
3610+
../getpayloadf16.h
3611+
DEPENDS
3612+
libc.src.__support.macros.properties.types
3613+
libc.src.__support.FPUtil.basic_operations
3614+
COMPILE_OPTIONS
3615+
-O3
3616+
)
3617+
36053618
add_entrypoint_object(
36063619
f16fmaf
36073620
SRCS

‎libc/src/math/generic/getpayloadf16.cpp

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
//===-- Implementation of getpayloadf16 function --------------------------===//
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+
#include "src/math/getpayloadf16.h"
10+
#include "src/__support/FPUtil/BasicOperations.h"
11+
#include "src/__support/common.h"
12+
13+
namespace LIBC_NAMESPACE {
14+
15+
LLVM_LIBC_FUNCTION(float16, getpayloadf16, (const float16 *x)) {
16+
return fputil::getpayload(*x);
17+
}
18+
19+
} // namespace LIBC_NAMESPACE

‎libc/src/math/getpayloadf16.h

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
//===-- Implementation header for getpayloadf16 -----------------*- 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-exception
6+
//
7+
//===----------------------------------------------------------------------===//
8+
9+
#ifndef LLVM_LIBC_SRC_MATH_GETPAYLOADF16_H
10+
#define LLVM_LIBC_SRC_MATH_GETPAYLOADF16_H
11+
12+
#include "src/__support/macros/properties/types.h"
13+
14+
namespace LIBC_NAMESPACE {
15+
16+
float16 getpayloadf16(const float16 *x);
17+
18+
} // namespace LIBC_NAMESPACE
19+
20+
#endif // LLVM_LIBC_SRC_MATH_GETPAYLOADF16_H

‎libc/test/src/math/smoke/CMakeLists.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3553,6 +3553,18 @@ add_fp_unittest(
35533553
libc.src.math.totalordermagf16
35543554
)
35553555

3556+
add_fp_unittest(
3557+
getpayloadf16_test
3558+
SUITE
3559+
libc-math-smoke-tests
3560+
SRCS
3561+
getpayloadf16_test.cpp
3562+
HDRS
3563+
GetPayloadTest.h
3564+
DEPENDS
3565+
libc.src.math.getpayloadf16
3566+
)
3567+
35563568
add_fp_unittest(
35573569
f16fmaf_test
35583570
SUITE

‎libc/test/src/math/smoke/GetPayloadTest.h

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
//===-- Utility class to test different flavors of getpayload ---*- 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-exception
6+
//
7+
//===----------------------------------------------------------------------===//
8+
9+
#ifndef LIBC_TEST_SRC_MATH_SMOKE_GETPAYLOADTEST_H
10+
#define LIBC_TEST_SRC_MATH_SMOKE_GETPAYLOADTEST_H
11+
12+
#include "test/UnitTest/FEnvSafeTest.h"
13+
#include "test/UnitTest/FPMatcher.h"
14+
#include "test/UnitTest/Test.h"
15+
16+
template <typename T>
17+
class GetPayloadTestTemplate : public LIBC_NAMESPACE::testing::FEnvSafeTest {
18+
19+
DECLARE_SPECIAL_CONSTANTS(T)
20+
21+
public:
22+
typedef T (*GetPayloadFunc)(const T *);
23+
24+
T funcWrapper(GetPayloadFunc func, T x) { return func(&x); }
25+
26+
void testNonNaNs(GetPayloadFunc func) {
27+
EXPECT_FP_EQ(T(-1.0), funcWrapper(func, T(0.0)));
28+
EXPECT_FP_EQ(T(-1.0), funcWrapper(func, T(-0.0)));
29+
EXPECT_FP_EQ(T(-1.0), funcWrapper(func, T(0.1)));
30+
EXPECT_FP_EQ(T(-1.0), funcWrapper(func, T(-0.1)));
31+
EXPECT_FP_EQ(T(-1.0), funcWrapper(func, T(123.38)));
32+
EXPECT_FP_EQ(T(-1.0), funcWrapper(func, T(-123.38)));
33+
EXPECT_FP_EQ(T(-1.0), funcWrapper(func, inf));
34+
EXPECT_FP_EQ(T(-1.0), funcWrapper(func, neg_inf));
35+
}
36+
37+
void testNaNs(GetPayloadFunc func) {
38+
EXPECT_FP_EQ(T(0.0), funcWrapper(func, aNaN));
39+
EXPECT_FP_EQ(T(0.0), funcWrapper(func, neg_aNaN));
40+
41+
T default_snan_payload = StorageType(1) << (FPBits::SIG_LEN - 2);
42+
EXPECT_FP_EQ(default_snan_payload, funcWrapper(func, sNaN));
43+
EXPECT_FP_EQ(default_snan_payload, funcWrapper(func, neg_sNaN));
44+
45+
T qnan_42 = FPBits::quiet_nan(Sign::POS, 0x42).get_val();
46+
T neg_qnan_42 = FPBits::quiet_nan(Sign::NEG, 0x42).get_val();
47+
T snan_42 = FPBits::signaling_nan(Sign::POS, 0x42).get_val();
48+
T neg_snan_42 = FPBits::signaling_nan(Sign::NEG, 0x42).get_val();
49+
EXPECT_FP_EQ(T(0x42.0p+0), funcWrapper(func, qnan_42));
50+
EXPECT_FP_EQ(T(0x42.0p+0), funcWrapper(func, neg_qnan_42));
51+
EXPECT_FP_EQ(T(0x42.0p+0), funcWrapper(func, snan_42));
52+
EXPECT_FP_EQ(T(0x42.0p+0), funcWrapper(func, neg_snan_42));
53+
54+
T qnan_123 = FPBits::quiet_nan(Sign::POS, 0x123).get_val();
55+
T neg_qnan_123 = FPBits::quiet_nan(Sign::NEG, 0x123).get_val();
56+
T snan_123 = FPBits::signaling_nan(Sign::POS, 0x123).get_val();
57+
T neg_snan_123 = FPBits::signaling_nan(Sign::NEG, 0x123).get_val();
58+
EXPECT_FP_EQ(T(0x123.0p+0), funcWrapper(func, qnan_123));
59+
EXPECT_FP_EQ(T(0x123.0p+0), funcWrapper(func, neg_qnan_123));
60+
EXPECT_FP_EQ(T(0x123.0p+0), funcWrapper(func, snan_123));
61+
EXPECT_FP_EQ(T(0x123.0p+0), funcWrapper(func, neg_snan_123));
62+
}
63+
};
64+
65+
#define LIST_GETPAYLOAD_TESTS(T, func) \
66+
using LlvmLibcGetPayloadTest = GetPayloadTestTemplate<T>; \
67+
TEST_F(LlvmLibcGetPayloadTest, NonNaNs) { testNonNaNs(&func); } \
68+
TEST_F(LlvmLibcGetPayloadTest, NaNs) { testNaNs(&func); }
69+
70+
#endif // LIBC_TEST_SRC_MATH_SMOKE_GETPAYLOADTEST_H

‎libc/test/src/math/smoke/getpayloadf16_test.cpp

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
//===-- Unittests for getpayloadf16 ---------------------------------------===//
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+
#include "GetPayloadTest.h"
10+
11+
#include "src/math/getpayloadf16.h"
12+
13+
LIST_GETPAYLOAD_TESTS(float16, LIBC_NAMESPACE::getpayloadf16)

0 commit comments

Comments
 (0)