Skip to content

[libc][math] Refactor expf16 implementation to header-only in src/__support/math folder. #147428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions libc/shared/math.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@
#include "libc_common.h"

#include "math/expf.h"
#include "math/expf16.h"

#endif // LLVM_LIBC_SHARED_MATH_H
23 changes: 23 additions & 0 deletions libc/shared/math/expf16.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
//===-- Shared expf16 function ----------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_LIBC_SHARED_MATH_EXPF16_H
#define LLVM_LIBC_SHARED_MATH_EXPF16_H

#include "shared/libc_common.h"
#include "src/__support/math/expf16.h"

namespace LIBC_NAMESPACE_DECL {
namespace shared {

using math::expf16;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be guarded with LIBC_TYPES_HAS_FLOAT16


} // namespace shared
} // namespace LIBC_NAMESPACE_DECL

#endif // LLVM_LIBC_SHARED_MATH_EXPF16_H
20 changes: 20 additions & 0 deletions libc/src/__support/math/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,23 @@ add_header_library(
libc.src.__support.macros.config
libc.src.__support.macros.optimization
)

add_header_library(
expf16
HDRS
expf16.h
DEPENDS
.expxf16
libc.hdr.errno_macros
libc.hdr.fenv_macros
libc.src.__support.CPP.array
libc.src.__support.FPUtil.cast
libc.src.__support.FPUtil.except_value_utils
libc.src.__support.FPUtil.fenv_impl
libc.src.__support.FPUtil.fp_bits
libc.src.__support.FPUtil.multiply_add
libc.src.__support.FPUtil.nearest_integer
libc.src.__support.FPUtil.polyeval
libc.src.__support.FPUtil.rounding_mode
libc.src.__support.macros.optimization
)
134 changes: 134 additions & 0 deletions libc/src/__support/math/expf16.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
//===-- Implementation header for expf16 ------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_LIBC_SRC___SUPPORT_MATH_EXPF16_H
#define LLVM_LIBC_SRC___SUPPORT_MATH_EXPF16_H

#include "hdr/errno_macros.h"
#include "hdr/fenv_macros.h"
#include "src/__support/FPUtil/FEnvImpl.h"
#include "src/__support/FPUtil/FPBits.h"
#include "src/__support/FPUtil/PolyEval.h"
#include "src/__support/FPUtil/cast.h"
#include "src/__support/FPUtil/except_value_utils.h"
#include "src/__support/FPUtil/rounding_mode.h"
#include "src/__support/common.h"
#include "src/__support/macros/config.h"
#include "src/__support/macros/optimization.h"
#include "src/math/generic/expxf16.h"

namespace LIBC_NAMESPACE_DECL {

namespace math {

static constexpr float16 expf16(float16 x) {
#ifndef LIBC_MATH_HAS_SKIP_ACCURATE_PASS
constexpr fputil::ExceptValues<float16, 2> EXPF16_EXCEPTS_LO = {{
// (input, RZ output, RU offset, RD offset, RN offset)
// x = 0x1.de4p-8, expf16(x) = 0x1.01cp+0 (RZ)
{0x1f79U, 0x3c07U, 1U, 0U, 0U},
// x = 0x1.73cp-6, expf16(x) = 0x1.05cp+0 (RZ)
{0x25cfU, 0x3c17U, 1U, 0U, 0U},
}};

constexpr fputil::ExceptValues<float16, 3> EXPF16_EXCEPTS_HI = {{
// (input, RZ output, RU offset, RD offset, RN offset)
// x = 0x1.c34p+0, expf16(x) = 0x1.74cp+2 (RZ)
{0x3f0dU, 0x45d3U, 1U, 0U, 1U},
// x = -0x1.488p-5, expf16(x) = 0x1.ebcp-1 (RZ)
{0xa922U, 0x3bafU, 1U, 0U, 0U},
// x = -0x1.55p-5, expf16(x) = 0x1.ebp-1 (RZ)
{0xa954U, 0x3bacU, 1U, 0U, 0U},
}};
#endif // !LIBC_MATH_HAS_SKIP_ACCURATE_PASS

using FPBits = fputil::FPBits<float16>;
FPBits x_bits(x);

uint16_t x_u = x_bits.uintval();
uint16_t x_abs = x_u & 0x7fffU;

// When 0 < |x| <= 2^(-5), or |x| >= 12, or x is NaN.
if (LIBC_UNLIKELY(x_abs <= 0x2800U || x_abs >= 0x4a00U)) {
// exp(NaN) = NaN
if (x_bits.is_nan()) {
if (x_bits.is_signaling_nan()) {
fputil::raise_except_if_required(FE_INVALID);
return FPBits::quiet_nan().get_val();
}

return x;
}

// When x >= 12.
if (x_bits.is_pos() && x_abs >= 0x4a00U) {
// exp(+inf) = +inf
if (x_bits.is_inf())
return FPBits::inf().get_val();

switch (fputil::quick_get_round()) {
case FE_TONEAREST:
case FE_UPWARD:
fputil::set_errno_if_required(ERANGE);
fputil::raise_except_if_required(FE_OVERFLOW);
return FPBits::inf().get_val();
default:
return FPBits::max_normal().get_val();
}
}

// When x <= -18.
if (x_u >= 0xcc80U) {
// exp(-inf) = +0
if (x_bits.is_inf())
return FPBits::zero().get_val();

fputil::set_errno_if_required(ERANGE);
fputil::raise_except_if_required(FE_UNDERFLOW | FE_INEXACT);

switch (fputil::quick_get_round()) {
case FE_UPWARD:
return FPBits::min_subnormal().get_val();
default:
return FPBits::zero().get_val();
}
}

// When 0 < |x| <= 2^(-5).
if (x_abs <= 0x2800U && !x_bits.is_zero()) {
#ifndef LIBC_MATH_HAS_SKIP_ACCURATE_PASS
if (auto r = EXPF16_EXCEPTS_LO.lookup(x_u); LIBC_UNLIKELY(r.has_value()))
return r.value();
#endif // !LIBC_MATH_HAS_SKIP_ACCURATE_PASS

float xf = x;
// Degree-3 minimax polynomial generated by Sollya with the following
// commands:
// > display = hexadecimal;
// > P = fpminimax(expm1(x)/x, 2, [|SG...|], [-2^-5, 2^-5]);
// > 1 + x * P;
return fputil::cast<float16>(
fputil::polyeval(xf, 0x1p+0f, 0x1p+0f, 0x1.0004p-1f, 0x1.555778p-3f));
}
}

#ifndef LIBC_MATH_HAS_SKIP_ACCURATE_PASS
if (auto r = EXPF16_EXCEPTS_HI.lookup(x_u); LIBC_UNLIKELY(r.has_value()))
return r.value();
#endif // !LIBC_MATH_HAS_SKIP_ACCURATE_PASS

// exp(x) = exp(hi + mid) * exp(lo)
auto [exp_hi_mid, exp_lo] = exp_range_reduction(x);
return fputil::cast<float16>(exp_hi_mid * exp_lo);
}

} // namespace math

} // namespace LIBC_NAMESPACE_DECL

#endif // LLVM_LIBC_SRC___SUPPORT_MATH_EXPF16_H
14 changes: 1 addition & 13 deletions libc/src/math/generic/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1332,19 +1332,7 @@ add_entrypoint_object(
HDRS
../expf16.h
DEPENDS
.expxf16
libc.hdr.errno_macros
libc.hdr.fenv_macros
libc.src.__support.CPP.array
libc.src.__support.FPUtil.cast
libc.src.__support.FPUtil.except_value_utils
libc.src.__support.FPUtil.fenv_impl
libc.src.__support.FPUtil.fp_bits
libc.src.__support.FPUtil.multiply_add
libc.src.__support.FPUtil.nearest_integer
libc.src.__support.FPUtil.polyeval
libc.src.__support.FPUtil.rounding_mode
libc.src.__support.macros.optimization
libc.src.__support.math.expf16
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

libc.src.errno.errno is still needed here.

)

add_entrypoint_object(
Expand Down
115 changes: 3 additions & 112 deletions libc/src/math/generic/expf16.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,120 +7,11 @@
//===----------------------------------------------------------------------===//

#include "src/math/expf16.h"
#include "expxf16.h"
#include "hdr/errno_macros.h"
#include "hdr/fenv_macros.h"
#include "src/__support/FPUtil/FEnvImpl.h"
#include "src/__support/FPUtil/FPBits.h"
#include "src/__support/FPUtil/PolyEval.h"
#include "src/__support/FPUtil/cast.h"
#include "src/__support/FPUtil/except_value_utils.h"
#include "src/__support/FPUtil/rounding_mode.h"
#include "src/__support/common.h"
#include "src/__support/macros/config.h"
#include "src/__support/macros/optimization.h"

namespace LIBC_NAMESPACE_DECL {

#ifndef LIBC_MATH_HAS_SKIP_ACCURATE_PASS
static constexpr fputil::ExceptValues<float16, 2> EXPF16_EXCEPTS_LO = {{
// (input, RZ output, RU offset, RD offset, RN offset)
// x = 0x1.de4p-8, expf16(x) = 0x1.01cp+0 (RZ)
{0x1f79U, 0x3c07U, 1U, 0U, 0U},
// x = 0x1.73cp-6, expf16(x) = 0x1.05cp+0 (RZ)
{0x25cfU, 0x3c17U, 1U, 0U, 0U},
}};

static constexpr fputil::ExceptValues<float16, 3> EXPF16_EXCEPTS_HI = {{
// (input, RZ output, RU offset, RD offset, RN offset)
// x = 0x1.c34p+0, expf16(x) = 0x1.74cp+2 (RZ)
{0x3f0dU, 0x45d3U, 1U, 0U, 1U},
// x = -0x1.488p-5, expf16(x) = 0x1.ebcp-1 (RZ)
{0xa922U, 0x3bafU, 1U, 0U, 0U},
// x = -0x1.55p-5, expf16(x) = 0x1.ebp-1 (RZ)
{0xa954U, 0x3bacU, 1U, 0U, 0U},
}};
#endif // !LIBC_MATH_HAS_SKIP_ACCURATE_PASS

LLVM_LIBC_FUNCTION(float16, expf16, (float16 x)) {
using FPBits = fputil::FPBits<float16>;
FPBits x_bits(x);

uint16_t x_u = x_bits.uintval();
uint16_t x_abs = x_u & 0x7fffU;

// When 0 < |x| <= 2^(-5), or |x| >= 12, or x is NaN.
if (LIBC_UNLIKELY(x_abs <= 0x2800U || x_abs >= 0x4a00U)) {
// exp(NaN) = NaN
if (x_bits.is_nan()) {
if (x_bits.is_signaling_nan()) {
fputil::raise_except_if_required(FE_INVALID);
return FPBits::quiet_nan().get_val();
}

return x;
}

// When x >= 12.
if (x_bits.is_pos() && x_abs >= 0x4a00U) {
// exp(+inf) = +inf
if (x_bits.is_inf())
return FPBits::inf().get_val();
#include "src/__support/math/expf16.h"

switch (fputil::quick_get_round()) {
case FE_TONEAREST:
case FE_UPWARD:
fputil::set_errno_if_required(ERANGE);
fputil::raise_except_if_required(FE_OVERFLOW);
return FPBits::inf().get_val();
default:
return FPBits::max_normal().get_val();
}
}

// When x <= -18.
if (x_u >= 0xcc80U) {
// exp(-inf) = +0
if (x_bits.is_inf())
return FPBits::zero().get_val();

fputil::set_errno_if_required(ERANGE);
fputil::raise_except_if_required(FE_UNDERFLOW | FE_INEXACT);

switch (fputil::quick_get_round()) {
case FE_UPWARD:
return FPBits::min_subnormal().get_val();
default:
return FPBits::zero().get_val();
}
}

// When 0 < |x| <= 2^(-5).
if (x_abs <= 0x2800U && !x_bits.is_zero()) {
#ifndef LIBC_MATH_HAS_SKIP_ACCURATE_PASS
if (auto r = EXPF16_EXCEPTS_LO.lookup(x_u); LIBC_UNLIKELY(r.has_value()))
return r.value();
#endif // !LIBC_MATH_HAS_SKIP_ACCURATE_PASS

float xf = x;
// Degree-3 minimax polynomial generated by Sollya with the following
// commands:
// > display = hexadecimal;
// > P = fpminimax(expm1(x)/x, 2, [|SG...|], [-2^-5, 2^-5]);
// > 1 + x * P;
return fputil::cast<float16>(
fputil::polyeval(xf, 0x1p+0f, 0x1p+0f, 0x1.0004p-1f, 0x1.555778p-3f));
}
}

#ifndef LIBC_MATH_HAS_SKIP_ACCURATE_PASS
if (auto r = EXPF16_EXCEPTS_HI.lookup(x_u); LIBC_UNLIKELY(r.has_value()))
return r.value();
#endif // !LIBC_MATH_HAS_SKIP_ACCURATE_PASS
namespace LIBC_NAMESPACE_DECL {

// exp(x) = exp(hi + mid) * exp(lo)
auto [exp_hi_mid, exp_lo] = exp_range_reduction(x);
return fputil::cast<float16>(exp_hi_mid * exp_lo);
}
LLVM_LIBC_FUNCTION(float16, expf16, (float16 x)) { return math::expf16(x); }

} // namespace LIBC_NAMESPACE_DECL
21 changes: 21 additions & 0 deletions utils/bazel/llvm-project-overlay/libc/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -2096,6 +2096,26 @@ libc_support_library(
],
)

libc_support_library(
name = "__support_math_expf16",
hdrs = ["src/__support/math/expf16.h"],
deps = [
":__support_common",
":hdr_errno_macros",
":hdr_fenv_macros",
Comment on lines +2104 to +2105
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove these 2 and add ":__support_libc_errno" to the list.

":__support_cpp_array",
":__support_fputil_cast",
":__support_fputil_except_value_utils",
":__support_fputil_fenv_impl",
":__support_fputil_fp_bits",
":__support_fputil_multiply_add",
":__support_fputil_nearest_integer",
":__support_fputil_polyeval",
":__support_fputil_rounding_mode",
":__support_macros_optimization",
],
)

############################### complex targets ################################

libc_function(
Expand Down Expand Up @@ -2701,6 +2721,7 @@ libc_math_function(
libc_math_function(
name = "expf16",
additional_deps = [
":__support_math_expf16",
":expxf16",
],
)
Expand Down
Loading